# android.app.appsearch

# android.app.appsearch

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/app/appsearch/package-summary "View this page in Java")

## Interfaces

|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| [BatchResultCallback](https://developer.android.com/reference/kotlin/android/app/appsearch/BatchResultCallback) | The callback interface to return[AppSearchBatchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchBatchResult). |

## Classes

|-------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [AppSearchBatchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchBatchResult)                   | Provides results for AppSearch batch operations which encompass multiple documents.                                                                                                                                                                                                              |
| [AppSearchBlobHandle](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchBlobHandle)                     | An identifier to represent a blob in AppSearch.                                                                                                                                                                                                                                                  |
| [AppSearchManager](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchManager)                           | Provides access to the centralized AppSearch index maintained by the system.                                                                                                                                                                                                                     |
| [AppSearchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult)                             | Information about the success or failure of an AppSearch call.                                                                                                                                                                                                                                   |
| [AppSearchSchema](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema)                             | The AppSearch Schema for a particular type of document.                                                                                                                                                                                                                                          |
| [AppSearchSession](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession)                           | Provides a connection to a single AppSearch database.                                                                                                                                                                                                                                            |
| [CommitBlobResponse](https://developer.android.com/reference/kotlin/android/app/appsearch/CommitBlobResponse)                       | The response to provide batch operation results of[AppSearchSession.commitBlob](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession#commitBlob(kotlin.collections.MutableSet,%20java.util.concurrent.Executor,%20java.util.function.Consumer)).                |
| [EmbeddingVector](https://developer.android.com/reference/kotlin/android/app/appsearch/EmbeddingVector)                             | Embeddings are vector representations of data, such as text, images, and audio, which can be generated by machine learning models and used for semantic search.                                                                                                                                  |
| [EnterpriseGlobalSearchSession](https://developer.android.com/reference/kotlin/android/app/appsearch/EnterpriseGlobalSearchSession) | Provides a connection to all enterprise (work profile) AppSearch databases the querying application has been granted access to.                                                                                                                                                                  |
| [GenericDocument](https://developer.android.com/reference/kotlin/android/app/appsearch/GenericDocument)                             | Represents a document unit.                                                                                                                                                                                                                                                                      |
| [GetByDocumentIdRequest](https://developer.android.com/reference/kotlin/android/app/appsearch/GetByDocumentIdRequest)               | Encapsulates a request to retrieve documents by namespace and IDs from the[AppSearchSession](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession)database.                                                                                                     |
| [GetSchemaResponse](https://developer.android.com/reference/kotlin/android/app/appsearch/GetSchemaResponse)                         | The response class of[AppSearchSession.getSchema](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession#getSchema(java.util.concurrent.Executor,%20java.util.function.Consumer))                                                                                 |
| [GlobalSearchSession](https://developer.android.com/reference/kotlin/android/app/appsearch/GlobalSearchSession)                     | Provides a connection to all AppSearch databases the querying application has been granted access to.                                                                                                                                                                                            |
| [JoinSpec](https://developer.android.com/reference/kotlin/android/app/appsearch/JoinSpec)                                           | This class represents the specifications for the joining operation in search.                                                                                                                                                                                                                    |
| [Migrator](https://developer.android.com/reference/kotlin/android/app/appsearch/Migrator)                                           | A migrator class to translate[GenericDocument](https://developer.android.com/reference/kotlin/android/app/appsearch/GenericDocument)from different version of[AppSearchSchema](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema)                             |
| [OpenBlobForReadResponse](https://developer.android.com/reference/kotlin/android/app/appsearch/OpenBlobForReadResponse)             | The response to provide batch operation results of[AppSearchSession.openBlobForRead](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession#openBlobForRead(kotlin.collections.MutableSet,%20java.util.concurrent.Executor,%20java.util.function.Consumer)).      |
| [OpenBlobForWriteResponse](https://developer.android.com/reference/kotlin/android/app/appsearch/OpenBlobForWriteResponse)           | The response to provide batch operation results of[AppSearchSession.openBlobForWrite](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession#openBlobForWrite(kotlin.collections.MutableSet,%20java.util.concurrent.Executor,%20java.util.function.Consumer)).    |
| [PackageIdentifier](https://developer.android.com/reference/kotlin/android/app/appsearch/PackageIdentifier)                         | This class represents a uniquely identifiable package.                                                                                                                                                                                                                                           |
| [PropertyPath](https://developer.android.com/reference/kotlin/android/app/appsearch/PropertyPath)                                   | Represents a property path returned from searching the AppSearch Database.                                                                                                                                                                                                                       |
| [PutDocumentsRequest](https://developer.android.com/reference/kotlin/android/app/appsearch/PutDocumentsRequest)                     | Encapsulates a request to index documents into an[AppSearchSession](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession)database.                                                                                                                              |
| [RemoveBlobResponse](https://developer.android.com/reference/kotlin/android/app/appsearch/RemoveBlobResponse)                       | Results of[AppSearchSession.removeBlob](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession#removeBlob(kotlin.collections.MutableSet,%20java.util.concurrent.Executor,%20java.util.function.Consumer)), containing the outcome of the removal of each handles. |
| [RemoveByDocumentIdRequest](https://developer.android.com/reference/kotlin/android/app/appsearch/RemoveByDocumentIdRequest)         | Encapsulates a request to remove documents by namespace and IDs from the[AppSearchSession](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession)database.                                                                                                       |
| [ReportSystemUsageRequest](https://developer.android.com/reference/kotlin/android/app/appsearch/ReportSystemUsageRequest)           | A request to report usage of a document owned by another app from a system UI surface.                                                                                                                                                                                                           |
| [ReportUsageRequest](https://developer.android.com/reference/kotlin/android/app/appsearch/ReportUsageRequest)                       | A request to report usage of a document.                                                                                                                                                                                                                                                         |
| [SchemaVisibilityConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/SchemaVisibilityConfig)               | A class to hold a all necessary Visibility information corresponding to the same schema.                                                                                                                                                                                                         |
| [SearchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/SearchResult)                                   | This class represents one of the results obtained from an AppSearch query.                                                                                                                                                                                                                       |
| [SearchResults](https://developer.android.com/reference/kotlin/android/app/appsearch/SearchResults)                                 | Encapsulates results of a search operation.                                                                                                                                                                                                                                                      |
| [SearchSpec](https://developer.android.com/reference/kotlin/android/app/appsearch/SearchSpec)                                       | This class represents the specification logic for AppSearch.                                                                                                                                                                                                                                     |
| [SearchSuggestionResult](https://developer.android.com/reference/kotlin/android/app/appsearch/SearchSuggestionResult)               | The result class of the[AppSearchSession.searchSuggestion](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession#searchSuggestion(kotlin.String,%20android.app.appsearch.SearchSuggestionSpec,%20java.util.concurrent.Executor,%20java.util.function.Consumer)). |
| [SearchSuggestionSpec](https://developer.android.com/reference/kotlin/android/app/appsearch/SearchSuggestionSpec)                   | This class represents the specification logic for AppSearch.                                                                                                                                                                                                                                     |
| [SetBlobVisibilityRequest](https://developer.android.com/reference/kotlin/android/app/appsearch/SetBlobVisibilityRequest)           | Request to configure the visibility settings of blobs in AppSearch.                                                                                                                                                                                                                              |
| [SetSchemaRequest](https://developer.android.com/reference/kotlin/android/app/appsearch/SetSchemaRequest)                           | Encapsulates a request to update the schema of an[AppSearchSession](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession)database.                                                                                                                              |
| [SetSchemaResponse](https://developer.android.com/reference/kotlin/android/app/appsearch/SetSchemaResponse)                         | The response class of[AppSearchSession.setSchema](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession#setSchema(android.app.appsearch.SetSchemaRequest,%20java.util.concurrent.Executor,%20java.util.concurrent.Executor,%20java.util.function.Consumer))      |
| [StorageInfo](https://developer.android.com/reference/kotlin/android/app/appsearch/StorageInfo)                                     | The response class of`AppSearchSession#getStorageInfo`.                                                                                                                                                                                                                                          |