Package co.elastic.clients.elasticsearch.inference

Class PutJinaaiRequest

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

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

To review the available rerank models, refer to https://jina.ai/reranker. To review the available text_embedding models, refer to the https://jina.ai/embeddings/.

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 PutJinaaiRequest of(Function<PutJinaaiRequest.Builder,ObjectBuilder<PutJinaaiRequest>> fn)

    • chunkingSettings

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

      API name: chunking_settings

    • jinaaiInferenceId

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

      API name: jinaai_inference_id

    • service

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

      API name: service

    • serviceSettings

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

      API name: service_settings

    • taskSettings

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

      API name: task_settings

    • taskType

      public final JinaAITaskType taskType()
      Required - The type of the inference task that the model will perform.

      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)

    • setupPutJinaaiRequestDeserializer

      protected static void setupPutJinaaiRequestDeserializer(ObjectDeserializer<PutJinaaiRequest.Builder> op)