Skip to content

[Docs] Improve semantic_text updates documentation organization #137340

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
mridula-s109 merged 5 commits into from
Oct 29, 2025
Merged

[Docs] Improve semantic_text updates documentation organization #137340

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d2285c3
Move script update restrictions section for consistency
mridula-s109 Oct 29, 2025
92d11f2
Merge branch 'main' into docs/semantic-text-update-restriction-11580
mridula-s109 Oct 29, 2025
aa44fdc
Update docs/reference/elasticsearch/mapping-reference/semantic-text.md
mridula-s109 Oct 29, 2025
85dc830
Update docs/reference/elasticsearch/mapping-reference/semantic-text.md
mridula-s109 Oct 29, 2025
0e28062
Update docs/reference/elasticsearch/mapping-reference/semantic-text.md
mridula-s109 Oct 29, 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
24 changes: 12 additions & 12 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 @@ -440,6 +440,18 @@ If you want to avoid unnecessary inference and keep existing embeddings:
* Use **partial updates through the Bulk API**.
* Omit any `semantic_text` fields that did not change from the `doc` object in your request.

## Updates to `semantic_text` fields [update-script]

For indices containing `semantic_text` fields, updates that use scripts have the
following behavior:

* Are supported through
the [Update API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update).
* Are not supported through
the [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk-1)
and will fail. Even if the script targets non-`semantic_text` fields, the
update will fail when the index contains a `semantic_text` field.

## Returning semantic field embeddings in `_source`

```{applies_to}
Expand Down Expand Up @@ -578,18 +590,6 @@ PUT my-index-000004
```
% TEST[skip:Requires inference endpoint]

## Updates to `semantic_text` fields [update-script]

For indices containing `semantic_text` fields, updates that use scripts have the
following behavior:

* Are supported through
the [Update API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update).
* Are not supported through
the [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk-1)
and will fail. Even if the script targets non-`semantic_text` fields, the
update will fail when the index contains a `semantic_text` field.

## `copy_to` and multi-fields support [copy-to-support]

The semantic_text field type can serve as the target
Expand Down