Package co.elastic.clients.elasticsearch.inference

Class PutWatsonxRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.PutWatsonxRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutWatsonxRequest
extends RequestBase
implements JsonpSerializable

Create a Watsonx inference endpoint.

Create an inference endpoint to perform an inference task with the watsonxai service. You need an IBM Cloud Databases for Elasticsearch deployment to use the watsonxai inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutWatsonxRequest>	_DESERIALIZER	Json deserializer for PutWatsonxRequest
static final Endpoint<PutWatsonxRequest,PutWatsonxResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.put_watsonx".

Method Summary

Modifier and Type	Method	Description
static PutWatsonxRequest	of(Function<PutWatsonxRequest.Builder,ObjectBuilder<PutWatsonxRequest>> 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 WatsonxServiceType	service()	Required - The type of service supported for the specified task type.
final WatsonxServiceSettings	serviceSettings()	Required - Settings used to install the inference model.
protected static void	setupPutWatsonxRequestDeserializer(ObjectDeserializer<PutWatsonxRequest.Builder> op)
final WatsonxTaskType	taskType()	Required - The task type.
final Time	timeout()	Specifies the amount of time to wait for the inference endpoint to be created.
final String	watsonxInferenceId()	Required - The unique identifier of the inference endpoint.

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

Json deserializer for PutWatsonxRequest

_ENDPOINT

public static final Endpoint<PutWatsonxRequest,PutWatsonxResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.put_watsonx".

Method Details

of

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

service

public final WatsonxServiceType service()

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

API name: service

serviceSettings

public final WatsonxServiceSettings serviceSettings()

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

API name: service_settings

taskType

public final WatsonxTaskType taskType()

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

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

watsonxInferenceId

public final String watsonxInferenceId()

Required - The unique identifier of the inference endpoint.

API name: watsonx_inference_id

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)

setupPutWatsonxRequestDeserializer

protected static void setupPutWatsonxRequestDeserializer(ObjectDeserializer<PutWatsonxRequest.Builder> op)