Package co.elastic.clients.elasticsearch.inference

Class PutAzureopenaiRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.PutAzureopenaiRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutAzureopenaiRequest
extends RequestBase
implements JsonpSerializable

Create an Azure OpenAI inference endpoint.

Create an inference endpoint to perform an inference task with the azureopenai service.

The list of chat completion models that you can choose from in your Azure OpenAI deployment include:

• GPT-4 and GPT-4 Turbo models
• GPT-3.5

The list of embeddings models that you can choose from in your deployment can be found in the Azure models documentation.

When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutAzureopenaiRequest.Builder	Builder for PutAzureopenaiRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PutAzureopenaiRequest>	_DESERIALIZER	Json deserializer for PutAzureopenaiRequest
static final Endpoint<PutAzureopenaiRequest,PutAzureopenaiResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.put_azureopenai".

Method Summary

Modifier and Type	Method	Description
final String	azureopenaiInferenceId()	Required - The unique identifier of the inference endpoint.
final InferenceChunkingSettings	chunkingSettings()	The chunking configuration object.
static PutAzureopenaiRequest	of(Function<PutAzureopenaiRequest.Builder,ObjectBuilder<PutAzureopenaiRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
final AzureOpenAIServiceType	service()	Required - The type of service supported for the specified task type.
final AzureOpenAIServiceSettings	serviceSettings()	Required - Settings used to install the inference model.
protected static void	setupPutAzureopenaiRequestDeserializer(ObjectDeserializer<PutAzureopenaiRequest.Builder> op)
final AzureOpenAITaskSettings	taskSettings()	Settings to configure the inference task.
final AzureOpenAITaskType	taskType()	Required - The type of the inference task that the model will perform.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutAzureopenaiRequest> _DESERIALIZER

Json deserializer for PutAzureopenaiRequest

_ENDPOINT

public static final Endpoint<PutAzureopenaiRequest,PutAzureopenaiResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.put_azureopenai".

Method Details

of

public static PutAzureopenaiRequest of(Function<PutAzureopenaiRequest.Builder,ObjectBuilder<PutAzureopenaiRequest>> fn)

azureopenaiInferenceId

public final String azureopenaiInferenceId()

Required - The unique identifier of the inference endpoint.

API name: azureopenai_inference_id

chunkingSettings

@Nullable
public final InferenceChunkingSettings chunkingSettings()

The chunking configuration object.

API name: chunking_settings

service

public final AzureOpenAIServiceType service()

Required - The type of service supported for the specified task type. In this case, azureopenai.

API name: service

serviceSettings

public final AzureOpenAIServiceSettings serviceSettings()

Required - Settings used to install the inference model. These settings are specific to the azureopenai service.

API name: service_settings

taskSettings

@Nullable
public final AzureOpenAITaskSettings taskSettings()

Settings to configure the inference task. These settings are specific to the task type you specified.

API name: task_settings

taskType

public final AzureOpenAITaskType taskType()

Required - The type of the inference task that the model will perform. NOTE: The chat_completion task type only supports streaming and only through the _stream API.

API name: task_type

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupPutAzureopenaiRequestDeserializer

protected static void setupPutAzureopenaiRequestDeserializer(ObjectDeserializer<PutAzureopenaiRequest.Builder> op)