Skip to content

Commit 8d364b2

Browse files
committed
Update chunking_settings docs for semantic_text
1 parent a73f923 commit 8d364b2

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

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

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,30 @@ to create the endpoint. If not specified, the {{infer}} endpoint defined by
109109
`inference_id` will be used at both index and query time.
110110

111111
`chunking_settings`
112-
: (Optional, object) Sets chunking settings that will override the settings
113-
configured by the `inference_id` endpoint.
114-
See [chunking settings attributes](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put)
115-
in the {{infer}} API documentation for a complete list of available options.
112+
: (Optional, object) Settings for chunking text into smaller passages.
113+
If specified, these will override the chunking settings set in the {infer-cap}
114+
endpoint associated with `inference_id` will be used.
115+
If chunking settings are updated, they will not be applied to existing documents
116+
until they are reindexed.
117+
118+
::::{dropdown} Valid values for `chunking_settings`
119+
`type`
120+
: Indicates the type of chunking strategy to use. Valid values are `word` or
121+
`sentence`. Required.
122+
123+
`max_chunk_size`
124+
: The maximum number of works in a chunk. Required.
125+
126+
`overlap`
127+
: The number of overlapping words allowed in chunks. This cannot be defined as
128+
more than half of the `max_chunk_size`. Required for `word` type chunking
129+
settings.
130+
131+
`sentence_overlap`
132+
: The number of overlapping sentences allowed in chunks. Valid values are `0`
133+
or `1`. Required for `sentence` type chunking settings
134+
135+
::::
116136

117137
## {{infer-cap}} endpoint validation [infer-endpoint-validation]
118138

0 commit comments

Comments
 (0)