Skip to content

Clarify some semantic_text docs #111329

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 4 commits into from
Jul 26, 2024
Merged

Clarify some semantic_text docs #111329

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63183d7
Clarify some semantic_text docs
carlosdelest Jul 26, 2024
cddcc87
Add inference reference
carlosdelest Jul 26, 2024
932f30c
PR feedback
carlosdelest Jul 26, 2024
5529c68
replace infer-cap for infer
carlosdelest Jul 26, 2024
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
7 changes: 4 additions & 3 deletions docs/reference/mapping/types/semantic-text.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ Use the <<put-inference-api>> to create the endpoint.
The `inference_id` will not be validated when the mapping is created, but when documents are ingested into the index.
When the first document is indexed, the `inference_id` will be used to generate underlying indexing structures for the field.

WARNING: Removing an inference endpoint will cause ingestion of documents and semantic queries to fail on indices that define `semantic_text` fields with that inference endpoint as their `inference_id`.
Please check that inference endpoints are not used in `semantic_text` fields before removal.
WARNING: Removing an {infer} endpoint will cause ingestion of documents and semantic queries to fail on indices that define `semantic_text` fields with that {infer} endpoint as their `inference_id`.
Trying to <<delete-inference-api,delete an {infer} endpoint>> that is used on a `semantic_text` field will result in an error.

[discrete]
[[auto-text-chunking]]
Expand Down Expand Up @@ -124,7 +124,8 @@ types and create an ingest pipeline with an
[[update-script]]
==== Updates to `semantic_text` fields

Updates that use scripts are not supported when the index contains a `semantic_text` field.
Updates that use scripts are not supported for an index contains a `semantic_text` field.
Even if the script targets non-`semantic_text` fields, the update will fail when the index contains a `semantic_text` field.


[discrete]
Expand Down