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:

  • Field Details

  • Method Details

    • of

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

    • chunkingSettings

      @Nullable public final InferenceChunkingSettings chunkingSettings()
      The chunking configuration object. Applies only to the text_embedding task type. Not applicable to the completion or chat_completion task types.

      API name: chunking_settings

    • 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 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

    • 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)