ratingDescriptor
An enum schema for a rating descriptor parameter.
Declaration
var ratingDescriptor: some AppSchemaEnum { get }Discussion
To make your app’s parameter types available to Apple Intelligence, conform your AppEnum to a schema that describes a parameter’s possible values to the system. If your app’s functionality aligns with the maps domain and a parameter type matches the ratingDescriptor schema, you can generate the protocol conformance the schema requires for your app enum implementation with the @AppEnum( .maps.ratingDescriptor) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.
The following example shows an app enum that conforms to the ratingDescriptor schema:
@AppEnum(schema: .maps.ratingDescriptor)
enum MapsRatingDescriptor: String {
case percentage
static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
.percentage: "Percentage"
]
}The schema supports the following system experiences:
Siri
Shortcuts
For more information about the App Intents framework and the experiences it supports, see Getting started with the App Intents framework.