SearchSpec

public static final int EMBEDDING_SEARCH_METRIC_TYPE_COSINE = 1

Cosine similarity as metric for embedding search and ranking.

public static final int EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT = 0

Use the default metric set in getDefaultEmbeddingSearchMetricType for embedding search and ranking.

public static final int EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT = 2

Dot product similarity as metric for embedding search and ranking.

public static final int EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN = 3

Euclidean distance as metric for embedding search and ranking.

public static final int GROUPING_TYPE_PER_NAMESPACE = 2

Results should be grouped together by namespace for the purpose of enforcing a limit on the number of results returned per namespace.

public static final int GROUPING_TYPE_PER_PACKAGE = 1

Results should be grouped together by package for the purpose of enforcing a limit on the number of results returned per package.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_SPEC_GROUPING_TYPE_PER_SCHEMA)
public static final int GROUPING_TYPE_PER_SCHEMA = 4

Results should be grouped together by schema type for the purpose of enforcing a limit on the number of results returned per schema type.

public static final int ORDER_ASCENDING = 1

Search results will be returned in an ascending order.

public static final int ORDER_DESCENDING = 0

Search results will be returned in a descending order.

public static final int RANKING_STRATEGY_ADVANCED_RANKING_EXPRESSION = 9

Ranked by the advanced ranking expression provided.

public static final int RANKING_STRATEGY_CREATION_TIMESTAMP = 2

Ranked by document creation timestamps.

public static final int RANKING_STRATEGY_DOCUMENT_SCORE = 1

Ranked by app-provided document scores.

public static final int RANKING_STRATEGY_JOIN_AGGREGATE_SCORE = 8

Ranked by the aggregated ranking signal of the joined documents.

Which aggregation strategy is used to determine a ranking signal is specified in the JoinSpec set by setJoinSpec. This ranking strategy may not be used if no JoinSpec is provided.

public static final int RANKING_STRATEGY_NONE = 0

No Ranking, results are returned in arbitrary order.

public static final int RANKING_STRATEGY_RELEVANCE_SCORE = 3

Ranked by document relevance score.

public static final int RANKING_STRATEGY_SYSTEM_USAGE_COUNT = 6

Ranked by number of usages from a system UI surface.

public static final int RANKING_STRATEGY_SYSTEM_USAGE_LAST_USED_TIMESTAMP = 7

Ranked by timestamp of last usage from a system UI surface.

public static final int RANKING_STRATEGY_USAGE_COUNT = 4

Ranked by number of usages, as reported by the app.

public static final int RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP = 5

Ranked by timestamp of last usage, as reported by the app.

public static final String SCHEMA_TYPE_WILDCARD = "*"

Schema type to be used in addFilterProperties and addProjection to apply property paths to all results, excepting any types that have had their own, specific property paths set.

public static final int TERM_MATCH_EXACT_ONLY = 1

Query terms will only match exact tokens in the index.

For example, a query term "foo" will only match indexed token "foo", and not "foot" or "football".

public static final int TERM_MATCH_PREFIX = 2

Query terms will match indexed tokens when the query term is a prefix of the token.

For example, a query term "foo" will match indexed tokens like "foo", "foot", and "football".

public @NonNull String getAdvancedRankingExpression()

Get the advanced ranking expression, or "" if setRankingStrategy was not called.

public int getDefaultEmbeddingSearchMetricType()

Returns the default embedding metric type used for embedding search (see search) and ranking (see setRankingStrategy).

public @NonNull List<EmbeddingVector> getEmbeddingParameters()

Returns the list of EmbeddingVector that can be referenced in the query through the "getEmbeddingParameter({index})" function.

@ExperimentalAppSearchApi
public @NonNull List<String> getFilterDocumentIds()

Returns the list of document ids to search over.

If empty, the query will search over all documents.

public @NonNull List<String> getFilterNamespaces()

Returns the list of namespaces to search over.

If empty, the query will search over all namespaces.

public @NonNull List<String> getFilterPackageNames()

Returns the list of package name filters to search over.

If empty, the query will search over all packages that the caller has access to. If package names are specified which caller doesn't have access to, then those package names will be ignored.

public @NonNull Map<String, List<String>> getFilterProperties()

Returns the map of schema and target properties to search over.

If empty, will search over all schema and properties.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

public @NonNull List<String> getFilterSchemas()

Returns the list of schema types to search for.

If empty, the query will search over all schema types.

public @NonNull List<String> getInformationalRankingExpressions()

Returns the informational ranking expressions.

public @Nullable JoinSpec getJoinSpec()

Returns specification on which documents need to be joined.

public int getMaxSnippetSize()

Returns the maximum size of a snippet in characters.

public int getOrder()

Returns the order of returned search results (descending or ascending).

public @NonNull Map<String, List<PropertyPath>> getProjectionPaths()

Returns a map from schema type to property paths to be used for projection.

If the map is empty, then all properties will be retrieved for all results.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

public @NonNull Map<String, List<String>> getProjections()

Returns a map from schema type to property paths to be used for projection.

If the map is empty, then all properties will be retrieved for all results.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

public @NonNull Map<String, Map<PropertyPath, Double>> getPropertyWeightPaths()

Returns properties weights to be used for scoring.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

public @NonNull Map<String, Map<String, Double>> getPropertyWeights()

Returns properties weights to be used for scoring.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

public int getRankingStrategy()

Returns the ranking strategy.

public int getResultCountPerPage()

Returns the number of results per page in the result set.

public int getResultGroupingLimit()

Get the maximum number of results to return for each group.

public int getResultGroupingTypeFlags()

Get the type of grouping limit to apply, or 0 if setResultGrouping was not called.

public @Nullable String getSearchSourceLogTag()

Gets a tag to indicate the source of this search, or null if setSearchSourceLogTag was not called.

Some AppSearch implementations may log a hash of this tag using statsd. This tag may be used for tracing performance issues and crashes to a component of an app.

Call setSearchSourceLogTag and give a unique value if you want to distinguish this search scenario with other search scenarios during performance analysis.

Under no circumstances will AppSearch log the raw String value using statsd, but it will be provided as-is to custom AppSearchLogger implementations you have registered in your app.

public @NonNull List<String> getSearchStringParameters()

Returns the list of String parameters that can be referenced in the query through the "getSearchStringParameter({index})" function.

public int getSnippetCount()

Returns how many documents to generate snippets for.

public int getSnippetCountPerProperty()

Returns how many matches for each property of a matching document to generate snippets for.

public int getTermMatch()

Returns how the query terms should match terms in the index.

public boolean isListFilterHasPropertyFunctionEnabled()

Returns whether the LIST_FILTER_HAS_PROPERTY_FUNCTION feature is enabled.

@ExperimentalAppSearchApi
public boolean isListFilterMatchScoreExpressionFunctionEnabled()

Returns whether the LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION feature is enabled.

public boolean isListFilterQueryLanguageEnabled()

Returns whether the LIST_FILTER_QUERY_LANGUAGE feature is enabled.

public boolean isNumericSearchEnabled()

Returns whether the NUMERIC_SEARCH feature is enabled.

@ExperimentalAppSearchApi
public boolean isScorablePropertyRankingEnabled()

Returns whether the ScorablePropertyRanking feature is enabled.

public boolean isVerbatimSearchEnabled()

Returns whether the VERBATIM_SEARCH feature is enabled.

@ExperimentalAppSearchApi
public boolean shouldRetrieveEmbeddingMatchInfos()

Returns whether to retrieve embedding match infos as a part of getMatchInfos