Skip to content

Fix semantic text docs for features coming in 9.1 #131783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 23, 2025
+8 −6
Merged

Fix semantic text docs for features coming in 9.1 #131783

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6054b2d
Fix semantic text docs for features coming in 9.1
kderusso Jul 23, 2025
e985742
Inline applies_to
kderusso Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/reference/elasticsearch/mapping-reference/semantic-text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,20 @@
to create the endpoint. If not specified, the {{infer}} endpoint defined by
`inference_id` will be used at both index and query time.

```{applies_to}

Check failure on line 114 in docs/reference/elasticsearch/mapping-reference/semantic-text.md

View workflow job for this annotation

GitHub Actions / docs-preview / build 

Unable to parse applies_to directive: stack: 9.1.0
(Line: 1, Col: 1, Idx: 0) - (Line: 1, Col: 1, Idx: 0): Exception during deserialization
stack: 9.1.0
```

`index_options`
: (Optional, object) Specifies the index options to override default values
for the field. Currently, `dense_vector` index options are supported.
For text embeddings, `index_options` may match any allowed
[dense_vector index options](/reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-index-options).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for coming back to this! for setting availability, I generally suggest you use an inline tag like this so it's a little easier to read. the availability tags also need a lifecycle state in them (in this case, likely GA)

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


```{applies_to}

Check failure on line 124 in docs/reference/elasticsearch/mapping-reference/semantic-text.md

View workflow job for this annotation

GitHub Actions / docs-preview / build 

Unable to parse applies_to directive: stack: 9.1.0
(Line: 1, Col: 1, Idx: 0) - (Line: 1, Col: 1, Idx: 0): Exception during deserialization
stack: 9.1.0
```

`chunking_settings`
: (Optional, object) Settings for chunking text into smaller passages.
If specified, these will override the chunking settings set in the {{infer-cap}}
Expand All @@ -127,8 +135,8 @@

**Valid values for `chunking_settings`**:

`type`
: Indicates the type of chunking strategy to use. Valid values are `none`, `word` or
`strategy`
: Indicates the strategy of chunking strategy to use. Valid values are `none`, `word` or
`sentence`. Required.

`max_chunk_size`
Expand All @@ -144,7 +152,8 @@
or `1`. Required for `sentence` type chunking settings

::::{warning}
When using the `none` chunking strategy, if the input exceeds the maximum token limit of the underlying model, some
When using the `none` chunking strategy, if the input exceeds the maximum token
limit of the underlying model, some
services (such as OpenAI) may return an
error. In contrast, the `elastic` and `elasticsearch` services will
automatically truncate the input to fit within the
Expand Down Expand Up @@ -295,7 +304,8 @@
details.

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

- Use `index_options` to specify alternate index options such as specific
`dense_vector` quantization methods
Expand Down
Loading