Skip to content

Adds integration and task type list to PUT inference endpoint docs #4452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adds integration and task type list to PUT inference endpoint docs #4452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion specification/inference/put/PutRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,24 @@ import { Id } from '@_types/common'
* 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.
* For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.
* 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.
*
* The following integrations are available through the inference API. You can find the available task types next to the integration name:
* * AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)
* * Amazon Bedrock (`completion`, `text_embedding`)
* * Anthropic (`completion`)
* * Azure AI Studio (`completion`, `text_embedding`)
* * Azure OpenAI (`completion`, `text_embedding`)
* * Cohere (`completion`, `rerank`, `text_embedding`)
* * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
* * ELSER (`sparse_embedding`)
* * Google AI Studio (`completion`, `text_embedding`)
* * Google Vertex AI (`rerank`, `text_embedding`)
* * Hugging Face (`text_embedding`)
* * Mistral (`text_embedding`)
* * OpenAI (`chat_completion`, `completion`, `text_embedding`)
* * VoyageAI (`text_embedding`, `rerank`)
* * Watsonx inference integration (`text_embedding`)
* * JinaAI (`text_embedding`, `rerank`)
* @rest_spec_name inference.put
* @availability stack since=8.11.0 stability=stable visibility=public
* @availability serverless stability=stable visibility=public
Expand All @@ -47,7 +65,7 @@ export interface Request extends RequestBase {
]
path_parts: {
/**
* The task type
* The task type. Refer to the integration list in the API description for the available task types.
*/
task_type?: TaskType
/**
Expand Down
Loading