Making document reader actions available to Siri and Apple Intelligence

Overview

To integrate your app’s document viewing and editing capabilities with Siri and Apple Intelligence, you use Swift macros that generate additional properties and add protocol conformance for your app intent, app entity, and app enumeration implementation that Apple Intelligence needs.

For example, if your app allows people to view and rotate a document, use the AppIntent(schema:) macro and provide the assistant schema that consists of the .reader domain and the rotatePages schema:

@AppIntent(schema: .reader.rotatePages)
struct ReaderRotatePagesIntent {
    var pages: [ReaderPageEntity]
    var isClockwise: Bool

    func perform() async throws -> some IntentResult & ReturnsValue<[ReaderPageEntity]> {
        return .result(value: [ReaderPageEntity]())
    }
}

To learn more about assistant schemas, see Integrating actions with Siri and Apple Intelligence. For a list of available app intents in the .reader domain, see AssistantSchemas.ReaderIntent.

Make sure your entity meets requirements

If you use app entities to describe custom data types, annotate the app entity implementation with the AppEntity(schema:) macro. This makes sure Siri and Apple Intelligence can understand your data. For example, the intent in the previous section uses ReaderPageEntity. The following code snippet shows how the ReaderPageEntity implementation uses the AppEntity(schema:) macro:

@AppEntity(schema: .reader.document)
struct ReaderDocumentEntity {
    struct Query: EntityStringQuery {
        func entities(for identifiers: [ReaderDocumentEntity.ID]) async throws -> [ReaderDocumentEntity] { [] }
        func entities(matching string: String) async throws -> [ReaderDocumentEntity] { [] }
    }
    static var defaultQuery = Query()
    var displayRepresentation: DisplayRepresentation { "A display representation." }

    let id = UUID()

    var title: String
    var kind: ReaderDocumentKind
    var width: Int?
    var height: Int?
}

The assistant schema for the ReaderPageEntity consists of the .reader domain and the document schema.

For a list of available app entity schemas in the .reader domain, see AssistantSchemas.ReaderEntity.

Make sure your enumeration meets requirements

To make sure Siri and Apple Intelligence understand custom static types for your intent parameters, annotate app enumerations with the AppEnum(schema:) macro. Then, pass the .reader domain and a schema to it. The following example uses the documentKind schema:

import Foundation
import AppIntents

@AppEnum(schema: .reader.documentKind)
enum ReaderDocumentKind: String, AppEnum, Codable {
    case image
    case pdf

    static var caseDisplayRepresentations: [ReaderDocumentKind: DisplayRepresentation] = [:]
}

For a list of available app enumeration schemas in the .reader domain, see AssistantSchemas.ReaderEnum.