Skip to content

Commit f8b9fee

Browse files
Adds integration and task type list to PUT inference endpoint docs. (#4452) (#4506)
(cherry picked from commit 35daa83) Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
1 parent 8f6baca commit f8b9fee

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

specification/inference/put/PutRequest.ts

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,24 @@ import { TaskType } from '@inference/_types/TaskType'
2828
* IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.
2929
* For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.
3030
* However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
31+
*
32+
* The following integrations are available through the inference API. You can find the available task types next to the integration name:
33+
* * AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)
34+
* * Amazon Bedrock (`completion`, `text_embedding`)
35+
* * Anthropic (`completion`)
36+
* * Azure AI Studio (`completion`, `text_embedding`)
37+
* * Azure OpenAI (`completion`, `text_embedding`)
38+
* * Cohere (`completion`, `rerank`, `text_embedding`)
39+
* * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
40+
* * ELSER (`sparse_embedding`)
41+
* * Google AI Studio (`completion`, `text_embedding`)
42+
* * Google Vertex AI (`rerank`, `text_embedding`)
43+
* * Hugging Face (`text_embedding`)
44+
* * Mistral (`text_embedding`)
45+
* * OpenAI (`chat_completion`, `completion`, `text_embedding`)
46+
* * VoyageAI (`text_embedding`, `rerank`)
47+
* * Watsonx inference integration (`text_embedding`)
48+
* * JinaAI (`text_embedding`, `rerank`)
3149
* @rest_spec_name inference.put
3250
* @availability stack since=8.11.0 stability=stable visibility=public
3351
* @availability serverless stability=stable visibility=public
@@ -47,7 +65,7 @@ export interface Request extends RequestBase {
4765
]
4866
path_parts: {
4967
/**
50-
* The task type
68+
* The task type. Refer to the integration list in the API description for the available task types.
5169
*/
5270
task_type?: TaskType
5371
/**

0 commit comments

Comments
 (0)