An entity schema for a page.
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 `reader` domain
and its content matches the `page` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .reader.page)` Swift macro.
To make your app work with Siri,
see <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>.
The following example shows an app entity that conforms to the `page` schema:
```swift
@AppEntity(schema: .reader.page)
struct ReaderPageEntity {
// MARK: Static
static let defaultQuery = ReaderPageEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var label: String
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct ReaderPageEntityQuery: EntityQuery {
func entities(for identifiers: [ReaderPageEntity.ID]) async throws -> [ReaderPageEntity] {
<#code#>
}
}
}
```
The schema supports the following system experiences:
- Shortcuts
For more information about the App Intents framework and the experiences it supports,
see <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.
get · iOS 18.0+
document
Swift declaration
var document: some AppSchemaEntity { get }
An entity schema for a document.
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 `reader` domain
and its content matches the `document` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .reader.document)` Swift macro.
To make your app work with Siri,
see <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>.
The following example shows an app entity that conforms to the `document` schema:
```swift
@AppEntity(schema: .reader.document)
struct ReaderDocumentEntity {
// MARK: Static
static let defaultQuery = ReaderDocumentEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var title: String
var kind: <#ReaderDocumentKind#>
var width: Int?
var height: Int?
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct ReaderDocumentEntityQuery: EntityQuery {
func entities(for identifiers: [ReaderDocumentEntity.ID]) async throws -> [ReaderDocumentEntity] {
<#code#>
}
}
}
```
The schema supports the following system experiences:
- Shortcuts
For more information about the App Intents framework and the experiences it supports,
see <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.
