Package co.elastic.clients.elasticsearch.inference

Class PutAzureaistudioRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.PutAzureaistudioRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutAzureaistudioRequest
extends RequestBase
implements JsonpSerializable

Create an Azure AI studio inference endpoint.

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

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	PutAzureaistudioRequest.Builder	Builder for PutAzureaistudioRequest.

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<PutAzureaistudioRequest>	_DESERIALIZER	Json deserializer for PutAzureaistudioRequest
static final Endpoint<PutAzureaistudioRequest,PutAzureaistudioResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.put_azureaistudio".

Method Summary

Modifier and Type	Method	Description
final String	azureaistudioInferenceId()	Required - The unique identifier of the inference endpoint.
final InferenceChunkingSettings	chunkingSettings()	The chunking configuration object.
static PutAzureaistudioRequest	of(Function<PutAzureaistudioRequest.Builder,ObjectBuilder<PutAzureaistudioRequest>> 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 AzureAiStudioServiceType	service()	Required - The type of service supported for the specified task type.
final AzureAiStudioServiceSettings	serviceSettings()	Required - Settings used to install the inference model.
protected static void	setupPutAzureaistudioRequestDeserializer(ObjectDeserializer<PutAzureaistudioRequest.Builder> op)
final AzureAiStudioTaskSettings	taskSettings()	Settings to configure the inference task.
final AzureAiStudioTaskType	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<PutAzureaistudioRequest> _DESERIALIZER

Json deserializer for PutAzureaistudioRequest

_ENDPOINT

public static final Endpoint<PutAzureaistudioRequest,PutAzureaistudioResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.put_azureaistudio".

Method Details

of

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

azureaistudioInferenceId

public final String azureaistudioInferenceId()

Required - The unique identifier of the inference endpoint.

API name: azureaistudio_inference_id

chunkingSettings

@Nullable
public final InferenceChunkingSettings chunkingSettings()

The chunking configuration object.

API name: chunking_settings

service

public final AzureAiStudioServiceType service()

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

API name: service

serviceSettings

public final AzureAiStudioServiceSettings serviceSettings()

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

API name: service_settings

taskSettings

@Nullable
public final AzureAiStudioTaskSettings taskSettings()

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

API name: task_settings

taskType

public final AzureAiStudioTaskType taskType()

Required - The type of the inference task that the model will perform.

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)

setupPutAzureaistudioRequestDeserializer

protected static void setupPutAzureaistudioRequestDeserializer(ObjectDeserializer<PutAzureaistudioRequest.Builder> op)