An entity schema for a note.
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 `notes` domain
and its content matches the `note` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .notes.note)` 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 `note` schema:
```swift
@AppEntity(schema: .notes.note)
struct NoteEntity {
// MARK: Static
static let defaultQuery = NoteEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: AttributedString
var content: AttributedString?
var attachments: [IntentFile]
var isPinned: Bool
var creationDate: Date?
var modificationDate: Date?
var folder: <#FolderEntity#>?
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct NoteEntityQuery: EntityQuery {
func entities(for identifiers: [NoteEntity.ID]) async throws -> [NoteEntity] {
<#code#>
}
}
}
```
The schema supports the following system experiences:
- Siri
- 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 27.0+
folder
Swift declaration
var folder: some AppSchemaEntity { get }
An entity schema for a folder.
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 `notes` domain
and its content matches the `folder` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .notes.folder)` 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 `folder` schema:
```swift
@AppEntity(schema: .notes.folder)
struct FolderEntity {
// MARK: Static
static let defaultQuery = FolderEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: String
var parentFolder: <#FolderEntity#>?
var account: <#AccountEntity#>?
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct FolderEntityQuery: EntityQuery {
func entities(for identifiers: [FolderEntity.ID]) async throws -> [FolderEntity] {
<#code#>
}
}
}
```
The schema supports the following system experiences:
- Siri
- 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 27.0+
account
Swift declaration
var account: some AppSchemaEntity { get }
An entity schema for an account.
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 `notes` domain
and its content matches the `account` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .notes.account)` 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 `account` schema:
```swift
@AppEntity(schema: .notes.account)
struct AccountEntity {
// MARK: Static
static let defaultQuery = AccountEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: String
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct AccountEntityQuery: EntityQuery {
func entities(for identifiers: [AccountEntity.ID]) async throws -> [AccountEntity] {
<#code#>
}
}
}
```
The schema supports the following system experiences:
- Siri
- 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>.
