root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/inference/get-inference.asciidoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

90 lines
2.4 KiB
Plaintext
Raw Normal View History

[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
[role="xpack"]
[[get-inference-api]]
=== Get {infer} API
[DOCS] Makes Inference APIs main page more informative. (#107100)
2024-04-04 21:42:03 +08:00
Retrieves {infer} endpoint information.
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
[DOCS] Documents watsonx service of the Inference API (#115088) Co-authored-by: Saikat Sarkar <132922331+saikatsarkar056@users.noreply.github.com>
2024-10-21 15:41:55 +08:00
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in {ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.
For built-in models and models uploaded through Eland, the {infer} APIs offer an alternative way to use and manage trained models.
However, if you do not plan to use the {infer} APIs to use these models or if you want to use non-NLP models, use the <<ml-df-trained-models-apis>>.
[DOCS] Expands inference API docs (#104047) Co-authored-by: David Kyle <david.kyle@elastic.co>
2024-01-09 22:46:46 +08:00
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
[discrete]
[[get-inference-api-request]]
==== {api-request-title}
[ML] Add GET _inference for all inference endpoints (#107517)
2024-04-17 00:15:59 +08:00
`GET /_inference`
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
`GET /_inference/_all`
[DOCS] Changes model_id path param to inference_id (#106719)
2024-03-26 15:20:34 +08:00
`GET /_inference/<inference_id>`
[ML] Make task_type optional (#104483) Makes the task_type element of the _inference API optional so that it is possible to GET, DELETE or POST to an inference entity without providing the task type
2024-02-07 00:15:24 +08:00
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
`GET /_inference/<task_type>/_all`
[DOCS] Changes model_id path param to inference_id (#106719)
2024-03-26 15:20:34 +08:00
`GET /_inference/<task_type>/<inference_id>`
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
[discrete]
[[get-inference-api-prereqs]]
==== {api-prereq-title}
[ML] Create inference_user and inference_admin roles (#106371) Defines new inference_user and inference_admin roles with the related cluster privileges manage_inference and monitor_inference. inference_user can list the models and preform inference, inference_admin can do the same plus create and delete models
2024-03-20 19:15:21 +08:00
* Requires the `monitor_inference` <<privileges-list-cluster,cluster privilege>>
(the built-in `inference_admin` and `inference_user` roles grant this privilege)
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
[discrete]
[[get-inference-api-desc]]
==== {api-description-title}
[ML] Rename the ELSER service (#100944)
2023-10-17 16:58:38 +08:00
You can get information in a single API request for:
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
[DOCS] Makes Inference APIs main page more informative. (#107100)
2024-04-04 21:42:03 +08:00
* a single {infer} endpoint by providing the task type and the {infer} ID,
* all of the {infer} endpoints for a certain task type by providing the task
type and a wildcard expression,
* all of the {infer} endpoints by using a wildcard expression.
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
[discrete]
[[get-inference-api-path-params]]
==== {api-path-parms-title}
[DOCS] Changes model_id path param to inference_id (#106719)
2024-03-26 15:20:34 +08:00
`<inference_id>`::
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
(Optional, string)
[DOCS] Changes model_id path param to inference_id (#106719)
2024-03-26 15:20:34 +08:00
The unique identifier of the {infer} endpoint.
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
`<task_type>`::
(Optional, string)
The type of {infer} task that the model performs.
[discrete]
[[get-inference-api-example]]
==== {api-examples-title}
Fix typo in get-inference docs (retrives -> retrieves) (#110320)
2024-07-01 16:13:48 +08:00
The following API call retrieves information about the `my-elser-model` {infer}
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
model that can perform `sparse_embedding` tasks.
[source,console]
------------------------------------------------------------
GET _inference/sparse_embedding/my-elser-model
------------------------------------------------------------
// TEST[skip:TBD]
The API returns the following response:
[source,console-result]
------------------------------------------------------------
{
[DOCS] Changes model_id path param to inference_id (#106719)
2024-03-26 15:20:34 +08:00
"inference_id": "my-elser-model",
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
"task_type": "sparse_embedding",
[ML] Rename the ELSER service (#100944)
2023-10-17 16:58:38 +08:00
"service": "elser",
[DOCS] Adds reference documentation for inference API (#99658) * [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
2023-09-29 16:12:07 +08:00
"service_settings": {
"num_allocations": 1,
"num_threads": 1
},
"task_settings": {}
}
------------------------------------------------------------
[ML] Rename the ELSER service (#100944)
2023-10-17 16:58:38 +08:00
// NOTCONSOLE