Skip to content

Commit

Permalink
[DOCS] Adds note on default ELSER and E5 endpoints to service pages (e…
Browse files Browse the repository at this point in the history
…lastic#119507)

* [DOCS] Adds note on default ELSER and E5 enpoints to service pages.

* [DOCS] Further edits.
  • Loading branch information
szabosteve committed Jan 3, 2025
1 parent b430170 commit d959d2b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
7 changes: 5 additions & 2 deletions docs/reference/inference/service-elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[

Creates an {infer} endpoint to perform an {infer} task with the `elasticsearch` service.

NOTE: If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.

[NOTE]
====
* Your {es} deployment contains <<default-enpoints,preconfigured ELSER and E5 {infer} endpoints>>, you only need to create the enpoints using the API if you want to customize the settings.
* If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.
====

[discrete]
[[infer-service-elasticsearch-api-request]]
Expand Down
11 changes: 7 additions & 4 deletions docs/reference/inference/service-elser.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@ For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[
Creates an {infer} endpoint to perform an {infer} task with the `elser` service.
You can also deploy ELSER by using the <<infer-service-elasticsearch>>.

NOTE: The API request will automatically download and deploy the ELSER model if
it isn't already downloaded.
[NOTE]
====
* Your {es} deployment contains <<default-enpoints,a preconfigured ELSER {infer} endpoint>>, you only need to create the enpoint using the API if you want to customize the settings.
* The API request will automatically download and deploy the ELSER model if it isn't already downloaded.
====

[WARNING]
.Deprecated in 8.16
====
The elser service is deprecated and will be removed in a future release.
Use the <<infer-service-elasticsearch>> instead, with model_id included in the service_settings.
The `elser` service is deprecated and will be removed in a future release.
Use the <<infer-service-elasticsearch>> instead, with `model_id` included in the `service_settings`.
====

[discrete]
Expand Down

0 comments on commit d959d2b

Please sign in to comment.