Package co.elastic.clients.elasticsearch.inference

Class PutVoyageaiRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.inference.PutVoyageaiRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class PutVoyageaiRequest extends RequestBase implements JsonpSerializable
Create a VoyageAI inference endpoint.

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

Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

See Also:

  • Field Details

  • Method Details

    • of

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

    • chunkingSettings

      @Nullable public final InferenceChunkingSettings chunkingSettings()
      The chunking configuration object.

      API name: chunking_settings

    • service

      public final VoyageAIServiceType service()
      Required - The type of service supported for the specified task type. In this case, voyageai.

      API name: service

    • serviceSettings

      public final VoyageAIServiceSettings serviceSettings()
      Required - Settings used to install the inference model. These settings are specific to the voyageai service.

      API name: service_settings

    • taskSettings

      @Nullable public final VoyageAITaskSettings taskSettings()
      Settings to configure the inference task. These settings are specific to the task type you specified.

      API name: task_settings

    • taskType

      public final VoyageAITaskType 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

    • voyageaiInferenceId

      public final String voyageaiInferenceId()
      Required - The unique identifier of the inference endpoint.

      API name: voyageai_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)

    • setupPutVoyageaiRequestDeserializer

      protected static void setupPutVoyageaiRequestDeserializer(ObjectDeserializer<PutVoyageaiRequest.Builder> op)