androidx.appsearch.app


Interfaces

AppSearchSession

Provides a connection to a single AppSearch database.

DocumentClassFactory

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

EnterpriseGlobalSearchSession

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

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

GlobalSearchSession

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

LongSerializer

Serializes some T to and from a long.

SearchResults

Encapsulates results of a search operation.

StringSerializer

Serializes some T to and from a String.

Classes

AppSearchBatchResult

Provides results for AppSearch batch operations which encompass multiple documents.

AppSearchBatchResult.Builder

Builder for AppSearchBatchResult objects.

AppSearchDocumentClassMap

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

AppSearchResult

Information about the success or failure of an AppSearch call.

AppSearchSchema

The AppSearch Schema for a particular type of document.

AppSearchSchema.BooleanPropertyConfig

Configuration for a property containing a boolean.

AppSearchSchema.BooleanPropertyConfig.Builder

Builder for BooleanPropertyConfig.

AppSearchSchema.Builder

Builder for objects.

AppSearchSchema.BytesPropertyConfig

Configuration for a property containing a byte array.

AppSearchSchema.BytesPropertyConfig.Builder

Builder for BytesPropertyConfig.

AppSearchSchema.DocumentPropertyConfig

Configuration for a property containing another Document.

AppSearchSchema.DocumentPropertyConfig.Builder

Builder for DocumentPropertyConfig.

AppSearchSchema.DoublePropertyConfig

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

AppSearchSchema.DoublePropertyConfig.Builder

Builder for DoublePropertyConfig.

AppSearchSchema.EmbeddingPropertyConfig

Configuration for a property of type EmbeddingVector in a Document.

AppSearchSchema.EmbeddingPropertyConfig.Builder

Builder for EmbeddingPropertyConfig.

AppSearchSchema.LongPropertyConfig

Configuration for a property containing a 64-bit integer.

AppSearchSchema.LongPropertyConfig.Builder

Builder for LongPropertyConfig.

AppSearchSchema.PropertyConfig

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

AppSearchSchema.StringPropertyConfig

Configuration for a property of type String in a Document.

AppSearchSchema.StringPropertyConfig.Builder

Builder for StringPropertyConfig.

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.

GenericDocument

Represents a document unit.

GenericDocument.Builder

The builder class for GenericDocument.

GetByDocumentIdRequest

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

GetByDocumentIdRequest.Builder

Builder for GetByDocumentIdRequest objects.

GetSchemaResponse

The response class of getSchemaAsync

GetSchemaResponse.Builder

Builder for GetSchemaResponse objects.

JoinSpec

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

JoinSpec.Builder

Builder for objects.

Migrator

A migrator class to translate GenericDocument from different version of AppSearchSchema

PackageIdentifier

This class represents a uniquely identifiable package.

PropertyPath

Represents a property path returned from searching the AppSearch Database.

PropertyPath.PathSegment

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

PutDocumentsRequest

Encapsulates a request to index documents into an AppSearchSession database.

PutDocumentsRequest.Builder

Builder for PutDocumentsRequest objects.

RemoveByDocumentIdRequest

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

RemoveByDocumentIdRequest.Builder

Builder for RemoveByDocumentIdRequest objects.

ReportSystemUsageRequest

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

ReportSystemUsageRequest.Builder

Builder for ReportSystemUsageRequest objects.

ReportUsageRequest

A request to report usage of a document.

ReportUsageRequest.Builder

Builder for ReportUsageRequest objects.

SchemaVisibilityConfig

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

SchemaVisibilityConfig.Builder

The builder class of SchemaVisibilityConfig.

SearchResult

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

SearchResult.Builder

Builder for SearchResult objects.

SearchResult.MatchInfo

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

SearchResult.MatchInfo.Builder

Builder for MatchInfo objects.

SearchResult.MatchRange

Class providing the position range of matching information.

SearchSpec

This class represents the specification logic for AppSearch.

SearchSpec.Builder

Builder for objects.

SearchSuggestionResult

The result class of the searchSuggestionAsync.

SearchSuggestionResult.Builder

The Builder class of SearchSuggestionResult.

SearchSuggestionSpec

This class represents the specification logic for AppSearch.

SearchSuggestionSpec.Builder

Builder for objects.

SetSchemaRequest

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

SetSchemaRequest.Builder

Builder for SetSchemaRequest objects.

SetSchemaResponse

The response class of setSchemaAsync

SetSchemaResponse.Builder

Builder for SetSchemaResponse objects.

SetSchemaResponse.MigrationFailure

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

ShortcutAdapter

Util methods for Document <-> shortcut conversion.

StorageInfo

The response class of AppSearchSession#getStorageInfo.

StorageInfo.Builder

Builder for StorageInfo objects.

Annotations

ExperimentalAppSearchApi

Indicates that an AppSearch api is unstable.