Skip to content

Commit 253889e

Browse files
authored
[DOCS] Update applies_to tags in Docs for Sparse Vector Mapping / Index Options (#130548) (#130570)
* remove preview labels docs / sparse vector type * re-add applies to, set to ga
1 parent 602d7ef commit 253889e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/reference/elasticsearch/mapping-reference/sparse-vector.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ PUT my-index
2626

2727
## Token pruning
2828
```{applies_to}
29-
stack: preview 9.1
29+
stack: ga 9.1
3030
```
3131

3232
With any new indices created, token pruning will be turned on by default with appropriate defaults. You can control this behaviour using the optional `index_options` parameters for the field:
@@ -63,23 +63,23 @@ The following parameters are accepted by `sparse_vector` fields:
6363
* Exclude the field from [_source](/reference/elasticsearch/rest-apis/retrieve-selected-fields.md#source-filtering).
6464
* Use [synthetic `_source`](/reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source).
6565

66-
index_options {applies_to}`stack: preview 9.1`
66+
index_options {applies_to}`stack: ga 9.1`
6767
: (Optional, object) You can set index options for your `sparse_vector` field to determine if you should prune tokens, and the parameter configurations for the token pruning. If pruning options are not set in your [`sparse_vector` query](/reference/query-languages/query-dsl/query-dsl-sparse-vector-query.md), Elasticsearch will use the default options configured for the field, if any.
6868

6969
Parameters for `index_options` are:
7070

71-
`prune` {applies_to}`stack: preview 9.1`
71+
`prune` {applies_to}`stack: ga 9.1`
7272
: (Optional, boolean) Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If `prune` is true but the `pruning_config` is not specified, pruning will occur but default values will be used. Default: true.
7373

74-
`pruning_config` {applies_to}`stack: preview 9.1`
74+
`pruning_config` {applies_to}`stack: ga 9.1`
7575
: (Optional, object) Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if `prune` is set to `true`. If `prune` is set to `true` but `pruning_config` is not specified, default values will be used. If `prune` is set to false but `pruning_config` is specified, an exception will occur.
7676

7777
Parameters for `pruning_config` include:
7878

79-
`tokens_freq_ratio_threshold` {applies_to}`stack: preview 9.1`
79+
`tokens_freq_ratio_threshold` {applies_to}`stack: ga 9.1`
8080
: (Optional, integer) Tokens whose frequency is more than `tokens_freq_ratio_threshold` times the average frequency of all tokens in the specified field are considered outliers and pruned. This value must between 1 and 100. Default: `5`.
8181

82-
`tokens_weight_threshold` {applies_to}`stack: preview 9.1`
82+
`tokens_weight_threshold` {applies_to}`stack: ga 9.1`
8383
: (Optional, float) Tokens whose weight is less than `tokens_weight_threshold` are considered insignificant and pruned. This value must be between 0 and 1. Default: `0.4`.
8484

8585
::::{note}

0 commit comments

Comments
 (0)