Skip to content

Commit 3636797

Browse files
[DOCS] Adds path params and available task types to the PUT inference page (#112696)
Co-authored-by: Liam Thompson <[email protected]>
1 parent c2d4543 commit 3636797

File tree

1 file changed

+34
-15
lines changed

1 file changed

+34
-15
lines changed

docs/reference/inference/put-inference.asciidoc

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,46 @@ use the <<ml-df-trained-models-apis>>.
3131
* Requires the `manage_inference` <<privileges-list-cluster,cluster privilege>>
3232
(the built-in `inference_admin` role grants this privilege)
3333

34+
[discrete]
35+
[[put-inference-api-path-params]]
36+
==== {api-path-parms-title}
37+
38+
`<inference_id>`::
39+
(Required, string)
40+
include::inference-shared.asciidoc[tag=inference-id]
41+
42+
`<task_type>`::
43+
(Required, string)
44+
include::inference-shared.asciidoc[tag=task-type]
45+
+
46+
--
47+
Refer to the service list in the <<put-inference-api-desc,API description section>> for the available task types.
48+
--
49+
50+
3451
[discrete]
3552
[[put-inference-api-desc]]
3653
==== {api-description-title}
3754

3855
The create {infer} API enables you to create an {infer} endpoint and configure a {ml} model to perform a specific {infer} task.
3956

40-
The following services are available through the {infer} API, click the links to review the configuration details of the services:
41-
42-
* <<infer-service-alibabacloud-ai-search,AlibabaCloud AI Search>>
43-
* <<infer-service-amazon-bedrock,Amazon Bedrock>>
44-
* <<infer-service-anthropic,Anthropic>>
45-
* <<infer-service-azure-ai-studio,Azure AI Studio>>
46-
* <<infer-service-azure-openai,Azure OpenAI>>
47-
* <<infer-service-cohere,Cohere>>
48-
* <<infer-service-elasticsearch,Elasticsearch>> (for built-in models and models uploaded through Eland)
49-
* <<infer-service-elser,ELSER>>
50-
* <<infer-service-google-ai-studio,Google AI Studio>>
51-
* <<infer-service-google-vertex-ai,Google Vertex AI>>
52-
* <<infer-service-hugging-face,Hugging Face>>
53-
* <<infer-service-mistral,Mistral>>
54-
* <<infer-service-openai,OpenAI>>
57+
The following services are available through the {infer} API.
58+
You can find the available task types next to the service name.
59+
Click the links to review the configuration details of the services:
60+
61+
* <<infer-service-alibabacloud-ai-search,AlibabaCloud AI Search>> (`rerank`, `sparse_embedding`, `text_embedding`)
62+
* <<infer-service-amazon-bedrock,Amazon Bedrock>> (`completion`, `text_embedding`)
63+
* <<infer-service-anthropic,Anthropic>> (`completion`)
64+
* <<infer-service-azure-ai-studio,Azure AI Studio>> (`completion`, `text_embedding`)
65+
* <<infer-service-azure-openai,Azure OpenAI>> (`completion`, `text_embedding`)
66+
* <<infer-service-cohere,Cohere>> (`completion`, `rerank`, `text_embedding`)
67+
* <<infer-service-elasticsearch,Elasticsearch>> (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
68+
* <<infer-service-elser,ELSER>> (`sparse_embedding`)
69+
* <<infer-service-google-ai-studio,Google AI Studio>> (`completion`, `text_embedding`)
70+
* <<infer-service-google-vertex-ai,Google Vertex AI>> (`rerank`, `text_embedding`)
71+
* <<infer-service-hugging-face,Hugging Face>> (`text_embedding`)
72+
* <<infer-service-mistral,Mistral>> (`text_embedding`)
73+
* <<infer-service-openai,OpenAI>> (`completion`, `text_embedding`)
5574

5675
The {es} and ELSER services run on a {ml} node in your {es} cluster. The rest of
5776
the services connect to external providers.

0 commit comments

Comments
 (0)