Skip to content

Commit 00e7d33

Browse files
authored
Fix semantic text docs for features coming in 9.1 (#131783) (#131785)
* Fix semantic text docs for features coming in 9.1 * Inline applies_to
1 parent 50aa714 commit 00e7d33

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/reference/elasticsearch/mapping-reference/semantic-text.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ the [Create {{infer}} API](https://www.elastic.co/docs/api/doc/elasticsearch/ope
111111
to create the endpoint. If not specified, the {{infer}} endpoint defined by
112112
`inference_id` will be used at both index and query time.
113113

114-
`index_options`
114+
`index_options` {applies_to}`stack: ga 9.1`
115115
: (Optional, object) Specifies the index options to override default values
116116
for the field. Currently, `dense_vector` index options are supported.
117117
For text embeddings, `index_options` may match any allowed
118118
[dense_vector index options](/reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-index-options).
119119

120-
`chunking_settings`
120+
`chunking_settings` {applies_to}`stack: ga 9.1`
121121
: (Optional, object) Settings for chunking text into smaller passages.
122122
If specified, these will override the chunking settings set in the {{infer-cap}}
123123
endpoint associated with `inference_id`.
@@ -127,8 +127,8 @@ To completely disable chunking, use the `none` chunking strategy.
127127

128128
**Valid values for `chunking_settings`**:
129129

130-
`type`
131-
: Indicates the type of chunking strategy to use. Valid values are `none`, `word` or
130+
`strategy`
131+
: Indicates the strategy of chunking strategy to use. Valid values are `none`, `word` or
132132
`sentence`. Required.
133133

134134
`max_chunk_size`
@@ -144,7 +144,8 @@ To completely disable chunking, use the `none` chunking strategy.
144144
or `1`. Required for `sentence` type chunking settings
145145

146146
::::{warning}
147-
When using the `none` chunking strategy, if the input exceeds the maximum token limit of the underlying model, some
147+
When using the `none` chunking strategy, if the input exceeds the maximum token
148+
limit of the underlying model, some
148149
services (such as OpenAI) may return an
149150
error. In contrast, the `elastic` and `elasticsearch` services will
150151
automatically truncate the input to fit within the
@@ -295,7 +296,8 @@ automatic {{infer}} and a dedicated query so you don’t need to provide further
295296
details.
296297

297298
If you want to override those defaults and customize the embeddings that
298-
`semantic_text` indexes, you can do so by modifying [parameters](#semantic-text-params):
299+
`semantic_text` indexes, you can do so by
300+
modifying [parameters](#semantic-text-params):
299301

300302
- Use `index_options` to specify alternate index options such as specific
301303
`dense_vector` quantization methods

0 commit comments

Comments
 (0)