Skip to content

Commit b7c9904

Browse files
committed
fix up docs
1 parent d812821 commit b7c9904

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ PUT my-index
2424
}
2525
```
2626

27+
{applies_to}`stack: preview 9.1`
2728
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:
2829

2930
```console
@@ -58,8 +59,8 @@ The following parameters are accepted by `sparse_vector` fields:
5859
* Exclude the field from [_source](/reference/elasticsearch/rest-apis/retrieve-selected-fields.md#source-filtering).
5960
* Use [synthetic `_source`](/reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source).
6061

61-
index_options
62-
: (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_query` vector, Elasticsearch will use the default options configured for the field, if any. The available options for the index options are:
62+
index_options {applies_to}`stack: preview 9.1`
63+
: (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.
6364

6465
Parameters for `index_options` are:
6566

@@ -87,7 +88,9 @@ Non-significant tokens can be defined as tokens that meet both of the following
8788
* The weight/score is so low that the token is likely not very relevant to the original term
8889

8990
Both the token frequency threshold and weight threshold must show the token is non-significant in order for the token to be pruned.
90-
This ensures the tokens that are kept are frequent enough and have very high scoring or very infrequent tokens that may not have as high of a score.
91+
This ensures that:
92+
* The tokens that are kept are frequent enough and have significant scoring.
93+
* Very infrequent tokens that may not have as high of a score are removed.
9194

9295

9396
## Multi-value sparse vectors [index-multi-value-sparse-vectors]

0 commit comments

Comments
 (0)