Package co.elastic.clients.elasticsearch.inference

Class PutAzureopenaiRequest

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

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

The list of chat completion models that you can choose from in your Azure OpenAI deployment include:

The list of embeddings models that you can choose from in your deployment can be found in the Azure models documentation.

See Also:

  • Field Details

  • Method Details

    • of

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

    • azureopenaiInferenceId

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

      API name: azureopenai_inference_id

    • chunkingSettings

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

      API name: chunking_settings

    • service

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

      API name: service

    • serviceSettings

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

      API name: service_settings

    • taskSettings

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

      API name: task_settings

    • taskType

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

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

    • setupPutAzureopenaiRequestDeserializer

      protected static void setupPutAzureopenaiRequestDeserializer(ObjectDeserializer<PutAzureopenaiRequest.Builder> op)