image
An entity schema for an image.
Declaration
var image: some AppSchemaEntity { get }Discussion
To make your app’s content available to Apple Intelligence, conform your AppEntity to a schema that describes your content to the system. If your app’s functionality aligns with the video domain and its content matches the image schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .video.image) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.
The following example shows an app entity that conforms to the image schema:
@AppEntity(schema: .video.image)
struct VideoImage {
// MARK: Static
static let defaultQuery = VideoImageQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var url: URL
var type: <#VideoImageType#>
var width: Int?
var height: Int?
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct VideoImageQuery: EntityQuery {
func entities(for identifiers: [VideoImage.ID]) async throws -> [VideoImage] {
<#code#>
}
}
}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.