Class PutRequest
- All Implemented Interfaces:
JsonpSerializable
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
)
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutRequest>
static final Endpoint<PutRequest,
PutResponse, ErrorResponse> Endpoint "inference.put
". -
Method Summary
Modifier and TypeMethodDescriptionprotected static JsonpDeserializer<PutRequest>
final InferenceEndpoint
Required - Request body.final String
Required - The inference Idstatic PutRequest
void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this value to JSON.final TaskType
taskType()
The task type.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
-
_ENDPOINT
Endpoint "inference.put
".
-
-
Method Details
-
of
-
inferenceId
Required - The inference IdAPI name:
inference_id
-
taskType
The task type. Refer to the integration list in the API description for the available task types.API name:
task_type
-
inferenceConfig
Required - Request body. -
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createPutRequestDeserializer
-