Package co.elastic.clients.elasticsearch.inference

Class PutContextualaiRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.PutContextualaiRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutContextualaiRequest
extends RequestBase
implements JsonpSerializable

Create an Contextual AI inference endpoint.

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

To review the available rerank models, refer to https://docs.contextual.ai/api-reference/rerank/rerank#body-model.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutContextualaiRequest>	_DESERIALIZER	Json deserializer for PutContextualaiRequest
static final Endpoint<PutContextualaiRequest,PutContextualaiResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.put_contextualai".

Method Summary

Modifier and Type	Method	Description
final InferenceChunkingSettings	chunkingSettings()	The chunking configuration object.
final String	contextualaiInferenceId()	Required - The unique identifier of the inference endpoint.
static PutContextualaiRequest	of(Function<PutContextualaiRequest.Builder,ObjectBuilder<PutContextualaiRequest>> 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 ContextualAIServiceType	service()	Required - The type of service supported for the specified task type.
final ContextualAIServiceSettings	serviceSettings()	Required - Settings used to install the inference model.
protected static void	setupPutContextualaiRequestDeserializer(ObjectDeserializer<PutContextualaiRequest.Builder> op)
final ContextualAITaskSettings	taskSettings()	Settings to configure the inference task.
final TaskTypeContextualAI	taskType()	Required - The type of the inference task that the model will perform.
final Time	timeout()	Specifies the amount of time to wait for the inference endpoint to be created.

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

Json deserializer for PutContextualaiRequest

_ENDPOINT

public static final Endpoint<PutContextualaiRequest,PutContextualaiResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.put_contextualai".

Method Details

of

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

chunkingSettings

@Nullable
public final InferenceChunkingSettings chunkingSettings()

The chunking configuration object.

API name: chunking_settings

contextualaiInferenceId

public final String contextualaiInferenceId()

Required - The unique identifier of the inference endpoint.

API name: contextualai_inference_id

service

public final ContextualAIServiceType service()

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

API name: service

serviceSettings

public final ContextualAIServiceSettings serviceSettings()

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

API name: service_settings

taskSettings

@Nullable
public final ContextualAITaskSettings taskSettings()

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

API name: task_settings

taskType

public final TaskTypeContextualAI taskType()

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

API name: task_type

timeout

@Nullable
public final Time timeout()

Specifies the amount of time to wait for the inference endpoint to be created.

API name: timeout

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)

setupPutContextualaiRequestDeserializer

protected static void setupPutContextualaiRequestDeserializer(ObjectDeserializer<PutContextualaiRequest.Builder> op)