<!--
{
  "availability" : [
    "iOS: 18.0.0 -",
    "iPadOS: 18.0.0 -",
    "macCatalyst: -",
    "macOS: 15.0.0 -",
    "visionOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "AppIntents",
  "identifier" : "/documentation/AppIntents/IndexedEntity",
  "metadataVersion" : "0.1.0",
  "role" : "Protocol",
  "symbol" : {
    "kind" : "Protocol",
    "modules" : [
      "App Intents"
    ],
    "preciseIdentifier" : "s:10AppIntents13IndexedEntityP"
  },
  "title" : "IndexedEntity"
}
-->

# IndexedEntity

An interface that allows you to include an entity in your app’s Spotlight index.

```
protocol IndexedEntity : AppEntity
```

## Overview

Adopt this protocol in app entities you want to include in your app’s Spotlight index.
Adding entities to Spotlight makes them discoverable by Apple Intelligence, and also
serves as the first step in letting Spotlight launch your app and display items that
appear in search results. Use the properties of this protocol to configure additional
Spotlight metadata to accompany your app entity in the index.

For more information about adding entities to your app’s Spotlight index, see [Making app entities available in Spotlight](/documentation/AppIntents/making-app-entities-available-in-spotlight).

## Topics

### Specifying entity-related attributes

[`attributeSet`](/documentation/AppIntents/IndexedEntity/attributeSet)

A custom attribute set that you include with your entity to improve search accuracy.

[`defaultAttributeSet`](/documentation/AppIntents/IndexedEntity/defaultAttributeSet)

The default set of attributes to include with your app entity in the Spotlight index.

### Hiding an entity from search results

[`hideInSpotlight`](/documentation/AppIntents/IndexedEntity/hideInSpotlight)

A Boolean value that indicates whether Spotlight prevents the inclusion of the entity
in the index.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)