# SearchSpec

Artifact: [androidx.appsearch:appsearch](https://developer.android.com/jetpack/androidx/releases/appsearch) [View Source](https://cs.android.com/search?q=file:androidx/appsearch/app/SearchSpec.java+class:androidx.appsearch.app.SearchSpec) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

*** ** * ** ***


```
public final class SearchSpec
```

<br />

*** ** * ** ***

This class represents the specification logic for AppSearch. It can be used to set the type of search, like prefix or exact only or apply filters to search for a specific schema type only etc.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder` Builder for `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec`. |

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_COSINE() = 1` Cosine similarity as metric for embedding search and ranking. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT() = 0` Use the default metric set in `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getDefaultEmbeddingSearchMetricType()` for embedding search and ranking. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT() = 2` Dot product similarity as metric for embedding search and ranking. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN() = 3` Euclidean distance as metric for embedding search and ranking. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#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. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#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. |
| `static final int` | `@https://developer.android.com/reference/androidx/annotation/RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = https://developer.android.com/reference/androidx/appsearch/app/Features.SEARCH_SPEC_GROUPING_TYPE_PER_SCHEMA) https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#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. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#ORDER_ASCENDING() = 1` Search results will be returned in an ascending order. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#ORDER_DESCENDING() = 0` Search results will be returned in a descending order. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_ADVANCED_RANKING_EXPRESSION() = 9` Ranked by the advanced ranking expression provided. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_CREATION_TIMESTAMP() = 2` Ranked by document creation timestamps. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_DOCUMENT_SCORE() = 1` Ranked by app-provided document scores. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_JOIN_AGGREGATE_SCORE() = 8` Ranked by the aggregated ranking signal of the joined documents. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_NONE() = 0` No Ranking, results are returned in arbitrary order. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_RELEVANCE_SCORE() = 3` Ranked by document relevance score. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_SYSTEM_USAGE_COUNT() = 6` Ranked by number of usages from a system UI surface. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_SYSTEM_USAGE_LAST_USED_TIMESTAMP() = 7` Ranked by timestamp of last usage from a system UI surface. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_USAGE_COUNT() = 4` Ranked by number of usages, as reported by the app. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP() = 5` Ranked by timestamp of last usage, as reported by the app. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#SCHEMA_TYPE_WILDCARD() = "*"` Schema type to be used in `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#addFilterProperties(java.lang.String,java.util.Collection<java.lang.String>)` and `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#addProjection(java.lang.String,java.util.Collection<java.lang.String>)` to apply property paths to all results, excepting any types that have had their own, specific property paths set. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#TERM_MATCH_EXACT_ONLY() = 1` Query terms will only match exact tokens in the index. |
| `static final int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#TERM_MATCH_PREFIX() = 2` Query terms will match indexed tokens when the query term is a prefix of the token. |

| ### Public methods |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getAdvancedRankingExpression()()` Get the advanced ranking expression, or "" if `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setRankingStrategy(java.lang.String)` was not called. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getDefaultEmbeddingSearchMetricType()()` Returns the default embedding metric type used for embedding search (see `https://developer.android.com/reference/androidx/appsearch/app/AppSearchSession#search(java.lang.String,androidx.appsearch.app.SearchSpec)`) and ranking (see `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setRankingStrategy(java.lang.String)`). |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/appsearch/app/EmbeddingVector>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getEmbeddingParameters()()` Returns the list of `https://developer.android.com/reference/androidx/appsearch/app/EmbeddingVector` that can be referenced in the query through the "getEmbeddingParameter({index})" function. |
| `int` | `@https://developer.android.com/reference/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getEmbeddingQueryProbeCount()()` Returns the number of clusters to search for Approximate Nearest Neighbor (ANN) search. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getFilterDocumentIds()()` Returns the list of document ids to search over. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getFilterNamespaces()()` Returns the list of namespaces to search over. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getFilterPackageNames()()` Returns the list of package name filters to search over. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getFilterProperties()()` Returns the map of schema and target properties to search over. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getFilterSchemas()()` Returns the list of schema types to search for. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getInformationalRankingExpressions()()` Returns the informational ranking expressions. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/appsearch/app/JoinSpec` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getJoinSpec()()` Returns specification on which documents need to be joined. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getMaxSnippetSize()()` Returns the maximum size of a snippet in characters. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getOrder()()` Returns the order of returned search results (descending or ascending). |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/appsearch/app/PropertyPath>>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getProjectionPaths()()` Returns a map from schema type to property paths to be used for projection. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getProjections()()` Returns a map from schema type to property paths to be used for projection. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/androidx/appsearch/app/PropertyPath, https://developer.android.com/reference/java/lang/Double.html>>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getPropertyWeightPaths()()` Returns properties weights to be used for scoring. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/lang/Double.html>>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getPropertyWeights()()` Returns properties weights to be used for scoring. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getRankingStrategy()()` Returns the ranking strategy. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getResultCountPerPage()()` Returns the number of results per page in the result set. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getResultGroupingLimit()()` Get the maximum number of results to return for each group. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getResultGroupingTypeFlags()()` Get the type of grouping limit to apply, or 0 if `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setResultGrouping(int,int)` was not called. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getSearchSourceLogTag()()` Gets a tag to indicate the source of this search, or `null` if `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setSearchSourceLogTag(java.lang.String)` was not called. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getSearchStringParameters()()` Returns the list of String parameters that can be referenced in the query through the "getSearchStringParameter({index})" function. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getSnippetCount()()` Returns how many documents to generate snippets for. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getSnippetCountPerProperty()()` Returns how many matches for each property of a matching document to generate snippets for. |
| `int` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getTermMatch()()` Returns how the query terms should match terms in the index. |
| `boolean` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#isListFilterHasPropertyFunctionEnabled()()` Returns whether the LIST_FILTER_HAS_PROPERTY_FUNCTION feature is enabled. |
| `boolean` | `@https://developer.android.com/reference/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#isListFilterMatchScoreExpressionFunctionEnabled()()` Returns whether the LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION feature is enabled. |
| `boolean` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#isListFilterQueryLanguageEnabled()()` Returns whether the LIST_FILTER_QUERY_LANGUAGE feature is enabled. |
| `boolean` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#isNumericSearchEnabled()()` Returns whether the NUMERIC_SEARCH feature is enabled. |
| `boolean` | `@https://developer.android.com/reference/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#isScorablePropertyRankingEnabled()()` Returns whether the ScorablePropertyRanking feature is enabled. |
| `boolean` | `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#isVerbatimSearchEnabled()()` Returns whether the VERBATIM_SEARCH feature is enabled. |
| `boolean` | `@https://developer.android.com/reference/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#shouldRetrieveEmbeddingMatchInfos()()` Returns whether to retrieve embedding match infos as a part of `https://developer.android.com/reference/androidx/appsearch/app/SearchResult#getMatchInfos()` |

## Constants

### EMBEDDING_SEARCH_METRIC_TYPE_COSINE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int EMBEDDING_SEARCH_METRIC_TYPE_COSINE = 1
```

Cosine similarity as metric for embedding search and ranking.

### EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT = 0
```

Use the default metric set in `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec#getDefaultEmbeddingSearchMetricType()` for embedding search and ranking.

### EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT = 2
```

Dot product similarity as metric for embedding search and ranking.

### EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN = 3
```

Euclidean distance as metric for embedding search and ranking.

### GROUPING_TYPE_PER_NAMESPACE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

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

### GROUPING_TYPE_PER_PACKAGE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

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

### GROUPING_TYPE_PER_SCHEMA

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
@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.

### ORDER_ASCENDING

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int ORDER_ASCENDING = 1
```

Search results will be returned in an ascending order.

### ORDER_DESCENDING

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int ORDER_DESCENDING = 0
```

Search results will be returned in a descending order.

### RANKING_STRATEGY_ADVANCED_RANKING_EXPRESSION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_ADVANCED_RANKING_EXPRESSION = 9
```

Ranked by the advanced ranking expression provided.

### RANKING_STRATEGY_CREATION_TIMESTAMP

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_CREATION_TIMESTAMP = 2
```

Ranked by document creation timestamps.

### RANKING_STRATEGY_DOCUMENT_SCORE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_DOCUMENT_SCORE = 1
```

Ranked by app-provided document scores.

### RANKING_STRATEGY_JOIN_AGGREGATE_SCORE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
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 `https://developer.android.com/reference/androidx/appsearch/app/JoinSpec` set by `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setJoinSpec(androidx.appsearch.app.JoinSpec)`. This ranking strategy may not be used if no `https://developer.android.com/reference/androidx/appsearch/app/JoinSpec` is provided.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#build()` |   |

### RANKING_STRATEGY_NONE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_NONE = 0
```

No Ranking, results are returned in arbitrary order.

### RANKING_STRATEGY_RELEVANCE_SCORE

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_RELEVANCE_SCORE = 3
```

Ranked by document relevance score.

### RANKING_STRATEGY_SYSTEM_USAGE_COUNT

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_SYSTEM_USAGE_COUNT = 6
```

Ranked by number of usages from a system UI surface.

### RANKING_STRATEGY_SYSTEM_USAGE_LAST_USED_TIMESTAMP

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_SYSTEM_USAGE_LAST_USED_TIMESTAMP = 7
```

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

### RANKING_STRATEGY_USAGE_COUNT

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_USAGE_COUNT = 4
```

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

### RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final int RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP = 5
```

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

### SCHEMA_TYPE_WILDCARD

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public static final String SCHEMA_TYPE_WILDCARD = "*"
```

Schema type to be used in `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#addFilterProperties(java.lang.String,java.util.Collection<java.lang.String>)` and `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#addProjection(java.lang.String,java.util.Collection<java.lang.String>)` to apply property paths to all results, excepting any types that have had their own, specific property paths set.

### TERM_MATCH_EXACT_ONLY

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
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".

### TERM_MATCH_PREFIX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
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 methods

### getAdvancedRankingExpression

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public @NonNull String getAdvancedRankingExpression()
```

Get the advanced ranking expression, or "" if `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setRankingStrategy(java.lang.String)` was not called.

### getDefaultEmbeddingSearchMetricType

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getDefaultEmbeddingSearchMetricType()
```

Returns the default embedding metric type used for embedding search (see `https://developer.android.com/reference/androidx/appsearch/app/AppSearchSession#search(java.lang.String,androidx.appsearch.app.SearchSpec)`) and ranking (see `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setRankingStrategy(java.lang.String)`).

### getEmbeddingParameters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public @NonNull List<EmbeddingVector> getEmbeddingParameters()
```

Returns the list of `https://developer.android.com/reference/androidx/appsearch/app/EmbeddingVector` that can be referenced in the query through the "getEmbeddingParameter({index})" function.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appsearch/app/AppSearchSession#search(java.lang.String,androidx.appsearch.app.SearchSpec)` |   |

### getEmbeddingQueryProbeCount

Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

```
@ExperimentalAppSearchApi
public int getEmbeddingQueryProbeCount()
```

Returns the number of clusters to search for Approximate Nearest Neighbor (ANN) search.

This is used globally across all semanticSearch calls in the query expression. If this value is \<= 0, embeddings in properties marked with `https://developer.android.com/reference/androidx/appsearch/app/AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_APPROXIMATE_NEAREST_NEIGHBOR()` will be skipped. Embeddings in properties marked with `https://developer.android.com/reference/androidx/appsearch/app/AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_SIMILARITY()` will still be searched regardless of this value.

A larger value increases recall at the expense of higher search latency. A smaller value reduces latency but may negatively impact recall. A value of 10 is generally a good default choice.

### getFilterDocumentIds

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

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

Returns the list of document ids to search over.

If empty, the query will search over all documents.

### getFilterNamespaces

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public @NonNull List<String> getFilterNamespaces()
```

Returns the list of namespaces to search over.

If empty, the query will search over all namespaces.

### getFilterPackageNames

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

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

### getFilterProperties

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

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

### getFilterSchemas

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public @NonNull List<String> getFilterSchemas()
```

Returns the list of schema types to search for.

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

### getInformationalRankingExpressions

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public @NonNull List<String> getInformationalRankingExpressions()
```

Returns the informational ranking expressions.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#addInformationalRankingExpressions(java.lang.String...)` |   |

### getJoinSpec

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public @Nullable JoinSpec getJoinSpec()
```

Returns specification on which documents need to be joined.

### getMaxSnippetSize

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getMaxSnippetSize()
```

Returns the maximum size of a snippet in characters.

### getOrder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getOrder()
```

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

### getProjectionPaths

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

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

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/appsearch/app/PropertyPath>>` | A mapping of schema types to lists of projection `https://developer.android.com/reference/androidx/appsearch/app/PropertyPath` objects. |

### getProjections

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

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

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>>` | A mapping of schema types to lists of projection strings. |

### getPropertyWeightPaths

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
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 `https://developer.android.com/reference/java/util/Map.html` returned by this function, rather than calling it multiple times.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/androidx/appsearch/app/PropertyPath, https://developer.android.com/reference/java/lang/Double.html>>` | a `https://developer.android.com/reference/java/util/Map.html` of schema type to an inner-map of property paths of the schema type to the weight to set for that property. |

### getPropertyWeights

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
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 `https://developer.android.com/reference/java/util/Map.html` returned by this function, rather than calling it multiple times.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/lang/Double.html>>` | a `https://developer.android.com/reference/java/util/Map.html` of schema type to an inner-map of property paths of the schema type to the weight to set for that property. |

### getRankingStrategy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getRankingStrategy()
```

Returns the ranking strategy.

### getResultCountPerPage

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getResultCountPerPage()
```

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

### getResultGroupingLimit

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getResultGroupingLimit()
```

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

| Returns |
|---|---|
| `int` | the maximum number of results to return for each group or 0 if `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setResultGrouping(int,int)` was not called. |

### getResultGroupingTypeFlags

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getResultGroupingTypeFlags()
```

Get the type of grouping limit to apply, or 0 if `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setResultGrouping(int,int)` was not called.

### getSearchSourceLogTag

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public @Nullable String getSearchSourceLogTag()
```

Gets a tag to indicate the source of this search, or `null` if `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setSearchSourceLogTag(java.lang.String)` 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 `https://developer.android.com/reference/androidx/appsearch/app/SearchSpec.Builder#setSearchSourceLogTag(java.lang.String)` 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.

### getSearchStringParameters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public @NonNull List<String> getSearchStringParameters()
```

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

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appsearch/app/AppSearchSession#search(java.lang.String,androidx.appsearch.app.SearchSpec)` |   |

### getSnippetCount

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getSnippetCount()
```

Returns how many documents to generate snippets for.

### getSnippetCountPerProperty

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getSnippetCountPerProperty()
```

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

### getTermMatch

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public int getTermMatch()
```

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

### isListFilterHasPropertyFunctionEnabled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public boolean isListFilterHasPropertyFunctionEnabled()
```

Returns whether the LIST_FILTER_HAS_PROPERTY_FUNCTION feature is enabled.

### isListFilterMatchScoreExpressionFunctionEnabled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
@ExperimentalAppSearchApi
public boolean isListFilterMatchScoreExpressionFunctionEnabled()
```

Returns whether the LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION feature is enabled.

### isListFilterQueryLanguageEnabled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public boolean isListFilterQueryLanguageEnabled()
```

Returns whether the LIST_FILTER_QUERY_LANGUAGE feature is enabled.

### isNumericSearchEnabled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public boolean isNumericSearchEnabled()
```

Returns whether the NUMERIC_SEARCH feature is enabled.

### isScorablePropertyRankingEnabled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
@ExperimentalAppSearchApi
public boolean isScorablePropertyRankingEnabled()
```

Returns whether the ScorablePropertyRanking feature is enabled.

### isVerbatimSearchEnabled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
public boolean isVerbatimSearchEnabled()
```

Returns whether the VERBATIM_SEARCH feature is enabled.

### shouldRetrieveEmbeddingMatchInfos

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
@ExperimentalAppSearchApi
public boolean shouldRetrieveEmbeddingMatchInfos()
```

Returns whether to retrieve embedding match infos as a part of `https://developer.android.com/reference/androidx/appsearch/app/SearchResult#getMatchInfos()`