Package co.elastic.clients.elasticsearch.inference

Class PutOpenaiRequest

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

Create an inference endpoint to perform an inference task with the openai 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:

  • Field Details

  • Method Details

    • of

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

    • chunkingSettings

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

      API name: chunking_settings

    • openaiInferenceId

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

      API name: openai_inference_id

    • service

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

      API name: service

    • serviceSettings

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

      API name: service_settings

    • taskSettings

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

      API name: task_settings

    • taskType

      public final OpenAITaskType taskType()
      Required - The type of the inference task that the model will perform. NOTE: The chat_completion task type only supports streaming and only through the _stream API.

      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)

    • setupPutOpenaiRequestDeserializer

      protected static void setupPutOpenaiRequestDeserializer(ObjectDeserializer<PutOpenaiRequest.Builder> op)