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/put-inference.asciidoc

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

46 lines
1.8 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"]
[[put-inference-api]]
=== Create {infer} API
[DOCS] Adds technical preview note to inference APIs. (#101703)
2023-11-02 20:02:29 +08:00
experimental[]
[DOCS] Makes Inference APIs main page more informative. (#107100)
2024-04-04 21:42:03 +08:00
Creates an {infer} endpoint to perform an {infer} task.
[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
[Inference API] Add Google Vertex AI text embeddings docs (#110317)
2024-07-02 20:47:14 +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, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI or Hugging Face.
[DOCS] Fix typo: though -> through (#110636)
2024-07-09 22:30:42 +08:00
For built-in models and models uploaded through Eland, the {infer} APIs offer an alternative way to use and manage trained models.
[DOCS] Refactors PUT inference API docs (#109812)
2024-07-01 16:12:16 +08:00
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] 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]
[[put-inference-api-request]]
==== {api-request-title}
[ML] Update last usages of model_id to inference_id (#107133)
2024-04-05 19:10:03 +08:00
`PUT /_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]
[[put-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 `manage_inference` <<privileges-list-cluster,cluster privilege>>
(the built-in `inference_admin` role grants 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]
[[put-inference-api-desc]]
==== {api-description-title}
[DOCS] Refactors PUT inference API docs (#109812)
2024-07-01 16:12:16 +08:00
The create {infer} API enables you to create an {infer} endpoint and configure a {ml} model to perform a specific {infer} task.
[Inference API] Add completion task type docs (#106876)
2024-04-02 19:34:46 +08:00
[DOCS] Refactors PUT inference API docs (#109812)
2024-07-01 16:12:16 +08:00
The following services are available through the {infer} API, click the links to review the configuration details of the services:
[Inference API] Add completion task type docs (#106876)
2024-04-02 19:34:46 +08:00
[Inference API] Add Docs for Amazon Bedrock Support for the Inference API (#110594) * Add Amazon Bedrock Inference API to docs * fix example errors * update semantic search tutorial; add changelog * fix typo * fix error; accept suggestions
2024-07-12 22:14:54 +08:00
* <<infer-service-amazon-bedrock,Amazon Bedrock>>
[DOCS] Refactors PUT inference API docs (#109812)
2024-07-01 16:12:16 +08:00
* <<infer-service-azure-ai-studio,Azure AI Studio>>
* <<infer-service-azure-openai,Azure OpenAI>>
* <<infer-service-cohere,Cohere>>
* <<infer-service-elasticsearch,Elasticsearch>> (for built-in models and models uploaded through Eland)
* <<infer-service-elser,ELSER>>
* <<infer-service-google-ai-studio,Google AI Studio>>
[Inference API] Add Google Vertex AI text embeddings docs (#110317)
2024-07-02 20:47:14 +08:00
* <<infer-service-google-vertex-ai,Google Vertex AI>>
[DOCS] Refactors PUT inference API docs (#109812)
2024-07-01 16:12:16 +08:00
* <<infer-service-hugging-face,Hugging Face>>
* <<infer-service-mistral,Mistral>>
* <<infer-service-openai,OpenAI>>