Package co.elastic.clients.elasticsearch.inference

Class InferenceRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.inference.InferenceRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class InferenceRequest extends RequestBase implements JsonpSerializable
Perform inference on the service.

This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. It returns a response with the results of the tasks. The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.

For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.

info The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

See Also:

  • Field Details

  • Method Details

    • of

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

    • inferenceId

      public final String inferenceId()
      Required - The unique identifier for the inference endpoint.

      API name: inference_id

    • input

      public final List<String> input()
      Required - The text on which you want to perform the inference task. It can be a single string or an array.

      info Inference endpoints for the completion task type currently only support a single string as input.

      API name: input

    • query

      @Nullable public final String query()
      The query input, which is required only for the rerank task. It is not required for other tasks.

      API name: query

    • taskSettings

      @Nullable public final JsonData taskSettings()
      Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service.

      API name: task_settings

    • taskType

      @Nullable public final TaskType taskType()
      The type of inference task that the model performs.

      API name: task_type

    • timeout

      @Nullable public final Time timeout()
      The amount of time to wait for the inference request to complete.

      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)

    • setupInferenceRequestDeserializer

      protected static void setupInferenceRequestDeserializer(ObjectDeserializer<InferenceRequest.Builder> op)