Package co.elastic.clients.elasticsearch.inference

Class PutMistralRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.PutMistralRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutMistralRequest
extends RequestBase
implements JsonpSerializable

Create a Mistral inference endpoint.

Creates an inference endpoint to perform an inference task with the mistral 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	PutMistralRequest.Builder	Builder for PutMistralRequest.

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<PutMistralRequest>	_DESERIALIZER	Json deserializer for PutMistralRequest
static final Endpoint<PutMistralRequest,PutMistralResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.put_mistral".

Method Summary

Modifier and Type	Method	Description
final InferenceChunkingSettings	chunkingSettings()	The chunking configuration object.
final String	mistralInferenceId()	Required - The unique identifier of the inference endpoint.
static PutMistralRequest	of(Function<PutMistralRequest.Builder,ObjectBuilder<PutMistralRequest>> 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 MistralServiceType	service()	Required - The type of service supported for the specified task type.
final MistralServiceSettings	serviceSettings()	Required - Settings used to install the inference model.
protected static void	setupPutMistralRequestDeserializer(ObjectDeserializer<PutMistralRequest.Builder> op)
final MistralTaskType	taskType()	Required - The task type.

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<PutMistralRequest> _DESERIALIZER

Json deserializer for PutMistralRequest

_ENDPOINT

public static final Endpoint<PutMistralRequest,PutMistralResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.put_mistral".

Method Details

of

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

chunkingSettings

@Nullable
public final InferenceChunkingSettings chunkingSettings()

The chunking configuration object.

API name: chunking_settings

mistralInferenceId

public final String mistralInferenceId()

Required - The unique identifier of the inference endpoint.

API name: mistral_inference_id

service

public final MistralServiceType service()

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

API name: service

serviceSettings

public final MistralServiceSettings serviceSettings()

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

API name: service_settings

taskType

public final MistralTaskType taskType()

Required - The task type. The only valid task type for the model to perform is text_embedding.

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)

setupPutMistralRequestDeserializer

protected static void setupPutMistralRequestDeserializer(ObjectDeserializer<PutMistralRequest.Builder> op)