Skip to content

Commit 37f2dbf

Browse files
committed
re-add applies to, set to ga
1 parent 1a0fab9 commit 37f2dbf

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ PUT my-index
2525
```
2626

2727
## Token pruning
28+
```{applies_to}
29+
stack: ga 9.1
30+
```
2831

2932
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:
3033

@@ -60,23 +63,23 @@ The following parameters are accepted by `sparse_vector` fields:
6063
* Exclude the field from [_source](/reference/elasticsearch/rest-apis/retrieve-selected-fields.md#source-filtering).
6164
* Use [synthetic `_source`](/reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source).
6265

63-
index_options
66+
index_options {applies_to}`stack: ga 9.1`
6467
: (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.
6568

6669
Parameters for `index_options` are:
6770

68-
`prune`
71+
`prune` {applies_to}`stack: ga 9.1`
6972
: (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.
7073

71-
`pruning_config`
74+
`pruning_config` {applies_to}`stack: ga 9.1`
7275
: (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.
7376

7477
Parameters for `pruning_config` include:
7578

76-
`tokens_freq_ratio_threshold`
79+
`tokens_freq_ratio_threshold` {applies_to}`stack: ga 9.1`
7780
: (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`.
7881

79-
`tokens_weight_threshold`
82+
`tokens_weight_threshold` {applies_to}`stack: ga 9.1`
8083
: (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`.
8184

8285
::::{note}

0 commit comments

Comments
 (0)