package

androidx.appsearch.app

Interfaces

AppSearchEnvironmentAn interface which exposes environment specific methods for AppSearch.
AppSearchSessionProvides a connection to a single AppSearch database.
CapabilitiesA class that encapsulates all features that are only supported with certain combinations of backend and Android API Level.
DocumentClassFactory<T>An interface for factories which can convert between instances of classes annotated with \@Document and instances of GenericDocument.
EnterpriseGlobalSearchSessionProvides a connection to all enterprise (work profile) AppSearch databases the querying application has been granted access to.
FeaturesA class that encapsulates all features that are only supported in certain cases (e.g.
GlobalSearchSessionProvides a connection to all AppSearch databases the querying application has been granted access to.
LongSerializer<T>Serializes some to and from a long.
SearchResultsEncapsulates results of a search operation.
StringSerializer<T>Serializes some to and from a String.

Classes

AppSearchBatchResult<KeyType, ValueType>Provides results for AppSearch batch operations which encompass multiple documents.
AppSearchBatchResult.Builder<KeyType, ValueType>Builder for AppSearchBatchResult objects.
AppSearchBlobHandleAn identifier to represent a Blob in AppSearch.
AppSearchDocumentClassMapA class that maintains the map from schema type names to the fully qualified names of the corresponding document classes.
AppSearchEnvironmentFactoryThis is a factory class for implementations needed based on the environment.
AppSearchResult<ValueType>Information about the success or failure of an AppSearch call.
AppSearchSchemaThe AppSearch Schema for a particular type of document.
AppSearchSchema.BooleanPropertyConfigConfiguration for a property containing a boolean.
AppSearchSchema.BooleanPropertyConfig.BuilderBuilder for AppSearchSchema.BooleanPropertyConfig.
AppSearchSchema.BuilderBuilder for objects.
AppSearchSchema.BytesPropertyConfigConfiguration for a property containing a byte array.
AppSearchSchema.BytesPropertyConfig.BuilderBuilder for AppSearchSchema.BytesPropertyConfig.
AppSearchSchema.DocumentPropertyConfigConfiguration for a property containing another Document.
AppSearchSchema.DocumentPropertyConfig.BuilderBuilder for AppSearchSchema.DocumentPropertyConfig.
AppSearchSchema.DoublePropertyConfigConfiguration for a property containing a double-precision decimal number.
AppSearchSchema.DoublePropertyConfig.BuilderBuilder for AppSearchSchema.DoublePropertyConfig.
AppSearchSchema.EmbeddingPropertyConfigConfiguration for a property of type EmbeddingVector in a Document.
AppSearchSchema.EmbeddingPropertyConfig.BuilderBuilder for AppSearchSchema.EmbeddingPropertyConfig.
AppSearchSchema.LongPropertyConfigConfiguration for a property containing a 64-bit integer.
AppSearchSchema.LongPropertyConfig.BuilderBuilder for AppSearchSchema.LongPropertyConfig.
AppSearchSchema.PropertyConfigCommon configuration for a single property (field) in a Document.
AppSearchSchema.StringPropertyConfigConfiguration for a property of type String in a Document.
AppSearchSchema.StringPropertyConfig.BuilderBuilder for AppSearchSchema.StringPropertyConfig.
DocumentClassFactoryRegistryA registry which maintains instances of DocumentClassFactory.
EmbeddingVectorEmbeddings are vector representations of data, such as text, images, and audio, which can be generated by machine learning models and used for semantic search.
FeatureConstantsA class that encapsulates all feature constants that are accessible in AppSearch framework.
GenericDocumentRepresents a document unit.
GenericDocument.Builder<BuilderType>The builder class for GenericDocument.
GetByDocumentIdRequestEncapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession database.
GetByDocumentIdRequest.BuilderBuilder for GetByDocumentIdRequest objects.
GetSchemaResponseThe response class of AppSearchSession.getSchemaAsync()
GetSchemaResponse.BuilderBuilder for GetSchemaResponse objects.
InternalSetSchemaResponseAn internal wrapper class of SetSchemaResponse.
InternalVisibilityConfigAn expanded version of SchemaVisibilityConfig which includes fields for internal use by AppSearch.
InternalVisibilityConfig.BuilderThe builder class of InternalVisibilityConfig.
JetpackAppSearchEnvironmentContains utility methods for Framework implementation of AppSearch.
JoinSpecThis class represents the specifications for the joining operation in search.
JoinSpec.BuilderBuilder for objects.
MigratorA migrator class to translate GenericDocument from different version of AppSearchSchema
PackageIdentifierThis class represents a uniquely identifiable package.
PropertyPathRepresents a property path returned from searching the AppSearch Database.
PropertyPath.PathSegmentA segment of a PropertyPath, which includes the name of the property and a 0-based index into this property.
PutDocumentsRequestEncapsulates a request to index documents into an AppSearchSession database.
PutDocumentsRequest.BuilderBuilder for PutDocumentsRequest objects.
RemoveByDocumentIdRequestEncapsulates a request to remove documents by namespace and IDs from the AppSearchSession database.
RemoveByDocumentIdRequest.BuilderBuilder for RemoveByDocumentIdRequest objects.
ReportSystemUsageRequestA request to report usage of a document owned by another app from a system UI surface.
ReportSystemUsageRequest.BuilderBuilder for ReportSystemUsageRequest objects.
ReportUsageRequestA request to report usage of a document.
ReportUsageRequest.BuilderBuilder for ReportUsageRequest objects.
SchemaVisibilityConfigA class to hold a all necessary Visibility information corresponding to the same schema.
SchemaVisibilityConfig.BuilderThe builder class of SchemaVisibilityConfig.
SearchResultThis class represents one of the results obtained from an AppSearch query.
SearchResult.BuilderBuilder for SearchResult objects.
SearchResult.MatchInfoThis class represents match objects for any snippets that might be present in SearchResults from a query.
SearchResult.MatchInfo.BuilderBuilder for SearchResult.MatchInfo objects.
SearchResult.MatchRangeClass providing the position range of matching information.
SearchResultPageThis class represents a page of SearchResults
SearchSpecThis class represents the specification logic for AppSearch.
SearchSpec.BuilderBuilder for objects.
SearchSuggestionResultThe result class of the AppSearchSession.searchSuggestionAsync(String, SearchSuggestionSpec).
SearchSuggestionResult.BuilderThe Builder class of SearchSuggestionResult.
SearchSuggestionSpecThis class represents the specification logic for AppSearch.
SearchSuggestionSpec.BuilderBuilder for objects.
SetSchemaRequestEncapsulates a request to update the schema of an AppSearchSession database.
SetSchemaRequest.BuilderBuilder for SetSchemaRequest objects.
SetSchemaResponseThe response class of AppSearchSession.setSchemaAsync(SetSchemaRequest)
SetSchemaResponse.BuilderBuilder for SetSchemaResponse objects.
SetSchemaResponse.MigrationFailureThe class represents a post-migrated GenericDocument that failed to be saved by AppSearchSession.setSchemaAsync(SetSchemaRequest).
ShortcutAdapterUtil methods for Document <-> shortcut conversion.
StorageInfoThe response class of AppSearchSession#getStorageInfo.
StorageInfo.BuilderBuilder for StorageInfo objects.
VisibilityPermissionConfigThe config class that holds all required permissions for a caller need to hold to access the schema which the outer SchemaVisibilityConfig represents.

Annotation Types

AppSearchResult.ResultCodeResult codes from AppSearchSession methods.
AppSearchSchema.EmbeddingPropertyConfig.IndexingTypeEncapsulates the configurations on how AppSearch should query/index these embedding vectors.
AppSearchSchema.LongPropertyConfig.IndexingTypeEncapsulates the configurations on how AppSearch should query/index these 64-bit integers.
AppSearchSchema.PropertyConfig.CardinalityThe cardinality of the property (whether it is required, optional or repeated).
AppSearchSchema.PropertyConfig.DataTypePhysical data-types of the contents of the property.
AppSearchSchema.StringPropertyConfig.IndexingTypeEncapsulates the configurations on how AppSearch should query/index these terms.
AppSearchSchema.StringPropertyConfig.JoinableValueTypeThe joinable value type of the property.
AppSearchSchema.StringPropertyConfig.TokenizerTypeConfigures how tokens should be extracted from this property.
JoinSpec.AggregationScoringStrategyAggregation scoring strategy for join spec.
SearchSpec.EmbeddingSearchMetricTypeType of scoring used to calculate similarity for embedding vectors.
SearchSpec.GroupingTypeGrouping type for result limits.
SearchSpec.OrderOrder for query result.
SearchSpec.RankingStrategyRanking Strategy for query result.
SearchSpec.TermMatchTerm Match Type for the query.
SearchSuggestionSpec.SuggestionRankingStrategyRanking Strategy for SearchSuggestionResult.
SetSchemaRequest.AppSearchSupportedPermissionList of Android Permission are supported in SetSchemaRequest.Builder.addRequiredPermissionsForSchemaTypeVisibility(String, Set)