searchDocuments
An intent schema that searches for text in the documents.
Declaration
var searchDocuments: some AppSchemaIntent { get }Discussion
To make your app’s actions available to Apple Intelligence, conform your AppIntent to a schema that describes your action to the system. If your app’s functionality aligns with the reader domain and one of your app’s actions matches the searchDocuments schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the @AppIntent( .reader.searchDocuments) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.
The following example shows an intent that conforms to the searchDocuments schema:
@AppIntent(schema: .reader.searchDocuments)
struct SearchReaderDocumentsIntent {
var criteria: String
var documents: [<#ReaderDocumentEntity#>]
func perform() async throws -> some IntentResult {
<#code#>
}
}The schema supports the following system experiences:
Shortcuts
For more information about the App Intents framework and the experiences it supports, see Getting started with the App Intents framework.