androidx.appsearch.app

Provides a connection to a single AppSearch database.

An interface for factories which can convert between instances of classes annotated with \@androidx.appsearch.annotation.Document and instances of GenericDocument.

Provides a connection to all enterprise (work profile) AppSearch databases the querying application has been granted access to.

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).

Provides a connection to all AppSearch databases the querying application has been granted access to.

Serializes some T to and from a long.

Encapsulates results of a search operation.

Serializes some T to and from a String.

Provides results for AppSearch batch operations which encompass multiple documents.

Builder for AppSearchBatchResult objects.

An identifier to represent a blob in AppSearch.

A class that maintains the map from schema type names to the fully qualified names of the corresponding document classes.

Information about the success or failure of an AppSearch call.

The AppSearch Schema for a particular type of document.

Configuration for a property of type AppSearchBlobHandle in a Document.

Builder for BlobHandlePropertyConfig.

Configuration for a property containing a boolean.

Builder for BooleanPropertyConfig.

Builder for objects.

Configuration for a property containing a byte array.

Builder for BytesPropertyConfig.

Configuration for a property containing another Document.

Builder for DocumentPropertyConfig.

Configuration for a property containing a double-precision decimal number.

Builder for DoublePropertyConfig.

Configuration for a property of type EmbeddingVector in a Document.

Builder for EmbeddingPropertyConfig.

Configuration for a property containing a 64-bit integer.

Builder for LongPropertyConfig.

Common configuration for a single property (field) in a Document.

Configuration for a property of type String in a Document.

Builder for StringPropertyConfig.

The response to provide batch operation results of commitBlobAsync.

A context object that holds mapping information for document classes and their parent types.

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.

Represents a document unit.

The builder class for GenericDocument.

Encapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession database.

Builder for GetByDocumentIdRequest objects.

The response class of getSchemaAsync

Builder for GetSchemaResponse objects.

This class represents the specifications for the joining operation in search.

Builder for objects.

A migrator class to translate GenericDocument from different version of AppSearchSchema

The response to provide batch operation results of openBlobForReadAsync.

The response to provide batch operation results of openBlobForWriteAsync.

This class represents a uniquely identifiable package.

Represents a property path returned from searching the AppSearch Database.

A segment of a PropertyPath, which includes the name of the property and a 0-based index into this property.

Encapsulates a request to index documents into an AppSearchSession database.

Builder for PutDocumentsRequest objects.

Results of removeBlobAsync, containing the outcome of the removal of each handles.

Encapsulates a request to remove documents by namespace and IDs from the AppSearchSession database.

Builder for RemoveByDocumentIdRequest objects.

A request to report usage of a document owned by another app from a system UI surface.

Builder for ReportSystemUsageRequest objects.

A request to report usage of a document.

Builder for ReportUsageRequest objects.

A class to hold a all necessary Visibility information corresponding to the same schema.

The builder class of SchemaVisibilityConfig.

This class represents one of the results obtained from an AppSearch query.

Builder for SearchResult objects.

This class represents match objects for any snippets that might be present in SearchResults from an embedding query.

This class represents match objects for any snippets that might be present in SearchResults from a query.

Builder for MatchInfo objects.

Class providing the position range of a text match information.

This class represents match objects for any text match snippets that might be present in SearchResults from a string query.

This class represents the specification logic for AppSearch.

Builder for objects.

The result class of the searchSuggestionAsync.

The Builder class of SearchSuggestionResult.

This class represents the specification logic for AppSearch.

Builder for objects.

Request to configure the visibility settings of blobs in AppSearch.

Builder for SetBlobVisibilityRequest objects.

Encapsulates a request to update the schema of an AppSearchSession database.

Builder for SetSchemaRequest objects.

The response class of setSchemaAsync

Builder for SetSchemaResponse objects.

The class represents a post-migrated GenericDocument that failed to be saved by setSchemaAsync.

Util methods for Document <-> shortcut conversion.

The response class of AppSearchSession#getStorageInfo.

Builder for StorageInfo objects.

Indicates that an AppSearch api is unstable.