# androidx.appsearch.app

*** ** * ** ***

## Interfaces

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession` | Provides a connection to a single AppSearch database. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/DocumentClassFactory` | An interface for factories which can convert between instances of classes annotated with \\@`https://developer.android.com/reference/kotlin/androidx/appsearch/annotation/Document` and instances of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GenericDocument`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/EnterpriseGlobalSearchSession` | Provides a connection to all enterprise (work profile) AppSearch databases the querying application has been granted access to. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/Features` | A class that encapsulates all features that are only supported in certain cases (e.g. only on certain implementations or only at a certain Android API Level). |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GlobalSearchSession` | Provides a connection to all AppSearch databases the querying application has been granted access to. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/LongSerializer` | Serializes some `https://developer.android.com/reference/kotlin/androidx/appsearch/app/LongSerializer` to and from a long. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ReadOnlyGlobalSearchSession` | Provides a connection to query over all AppSearch databases that the calling application has been granted access to. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResults` | Encapsulates results of a search operation. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/StringSerializer` | Serializes some `https://developer.android.com/reference/kotlin/androidx/appsearch/app/StringSerializer` to and from a String. |

## Classes

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchBatchResult` | Provides results for AppSearch batch operations which encompass multiple documents. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchBatchResult.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchBatchResult` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchBlobHandle` | An identifier to represent a blob in AppSearch. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchDocumentClassMap` | A class that maintains the map from schema type names to the fully qualified names of the corresponding document classes. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchResult` | Information about the success or failure of an AppSearch call. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema` | The AppSearch Schema for a particular type of document. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BlobHandlePropertyConfig` | Configuration for a property of type `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchBlobHandle` in a Document. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BlobHandlePropertyConfig.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BlobHandlePropertyConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig` | Configuration for a property containing a boolean. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BytesPropertyConfig` | Configuration for a property containing a byte array. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BytesPropertyConfig.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BytesPropertyConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig` | Configuration for a property containing another Document. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DoublePropertyConfig` | Configuration for a property containing a double-precision decimal number. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DoublePropertyConfig.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DoublePropertyConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.EmbeddingPropertyConfig` | Configuration for a property of type `https://developer.android.com/reference/kotlin/androidx/appsearch/app/EmbeddingVector` in a Document. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.EmbeddingPropertyConfig.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.EmbeddingPropertyConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.LongPropertyConfig` | Configuration for a property containing a 64-bit integer. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.LongPropertyConfig.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.LongPropertyConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig` | Common configuration for a single property (field) in a Document. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.StringPropertyConfig` | Configuration for a property of type String in a Document. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.StringPropertyConfig.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.StringPropertyConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/CommitBlobResponse` | The response to provide batch operation results of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#commitBlobAsync(java.util.Set<androidx.appsearch.app.AppSearchBlobHandle>)`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/DocumentClassMappingContext` | A context object that holds mapping information for document classes and their parent types. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/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. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/EmbeddingVector.QuantizedData` | Holds the pre-quantized embedding values along with the quantization parameters. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GenericDocument` | Represents a document unit. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GenericDocument.Builder` | The builder class for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GenericDocument`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GetByDocumentIdRequest` | Encapsulates a request to retrieve documents by namespace and IDs from the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession` database. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GetByDocumentIdRequest.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GetByDocumentIdRequest` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GetSchemaResponse` | The response class of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#getSchemaAsync()` |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GetSchemaResponse.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GetSchemaResponse` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/JoinSpec` | This class represents the specifications for the joining operation in search. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/JoinSpec.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/JoinSpec`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/Migrator` | A migrator class to translate `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GenericDocument` from different version of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema` |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/OpenBlobForReadResponse` | The response to provide batch operation results of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#openBlobForReadAsync(java.util.Set<androidx.appsearch.app.AppSearchBlobHandle>)`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/OpenBlobForWriteResponse` | The response to provide batch operation results of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#openBlobForWriteAsync(java.util.Set<androidx.appsearch.app.AppSearchBlobHandle>)`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PackageIdentifier` | This class represents a uniquely identifiable package. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath` | Represents a property path returned from searching the AppSearch Database. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath.PathSegment` | A segment of a PropertyPath, which includes the name of the property and a 0-based index into this property. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PutDocumentsRequest` | Encapsulates a request to index documents into an `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession` database. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PutDocumentsRequest.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PutDocumentsRequest` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/RemoveBlobResponse` | Results of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#removeBlobAsync(java.util.Set<androidx.appsearch.app.AppSearchBlobHandle>)`, containing the outcome of the removal of each handles. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/RemoveByDocumentIdRequest` | Encapsulates a request to remove documents by namespace and IDs from the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession` database. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/RemoveByDocumentIdRequest.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/RemoveByDocumentIdRequest` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ReportSystemUsageRequest` | A request to report usage of a document owned by another app from a system UI surface. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ReportSystemUsageRequest.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ReportSystemUsageRequest` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ReportUsageRequest` | A request to report usage of a document. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ReportUsageRequest.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ReportUsageRequest` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SchemaVisibilityConfig` | A class to hold a all necessary Visibility information corresponding to the same schema. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SchemaVisibilityConfig.Builder` | The builder class of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SchemaVisibilityConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` | This class represents one of the results obtained from an AppSearch query. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult.EmbeddingMatchInfo` | This class represents match objects for any snippets that might be present in `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResults` from an embedding query. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult.MatchInfo` | This class represents match objects for any snippets that might be present in `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResults` from a query. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult.MatchInfo.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult.MatchInfo` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult.MatchRange` | Class providing the position range of a text match information. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult.TextMatchInfo` | This class represents match objects for any text match snippets that might be present in `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResults` from a string query. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSpec` | This class represents the specification logic for AppSearch. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSpec.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSpec`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSuggestionResult` | The result class of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#searchSuggestionAsync(java.lang.String,androidx.appsearch.app.SearchSuggestionSpec)`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSuggestionResult.Builder` | The Builder class of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSuggestionResult`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSuggestionSpec` | This class represents the specification logic for AppSearch. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSuggestionSpec.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSuggestionSpec`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetBlobVisibilityRequest` | Request to configure the visibility settings of blobs in AppSearch. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetBlobVisibilityRequest.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetBlobVisibilityRequest` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetSchemaRequest` | Encapsulates a request to update the schema of an `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession` database. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetSchemaRequest.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetSchemaRequest` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetSchemaResponse` | The response class of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#setSchemaAsync(androidx.appsearch.app.SetSchemaRequest)` |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetSchemaResponse.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetSchemaResponse` objects. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetSchemaResponse.MigrationFailure` | The class represents a post-migrated `https://developer.android.com/reference/kotlin/androidx/appsearch/app/GenericDocument` that failed to be saved by `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#setSchemaAsync(androidx.appsearch.app.SetSchemaRequest)`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ShortcutAdapter` | Util methods for Document \<-\> shortcut conversion. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/StorageInfo` | The response class of `AppSearchSession#getStorageInfo`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/StorageInfo.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/StorageInfo` objects. |

## Annotations

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi` | Indicates that an AppSearch api is unstable. |