Package co.elastic.clients.elasticsearch.inference

Class CohereTaskSettings

java.lang.Object
co.elastic.clients.elasticsearch.inference.CohereTaskSettings
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class CohereTaskSettings extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • inputType

      public final CohereInputType inputType()
      Required - For a text_embedding task, the type of input passed to the model. Valid values are:
      • classification: Use it for embeddings passed through a text classifier.
      • clustering: Use it for the embeddings run through a clustering algorithm.
      • ingest: Use it for storing document embeddings in a vector database.
      • search: Use it for storing embeddings of search queries run against a vector database to find relevant documents.

      IMPORTANT: The input_type field is required when using embedding models v3 and higher.

      API name: input_type

    • returnDocuments

      @Nullable public final Boolean returnDocuments()
      For a rerank task, return doc text within the results.

      API name: return_documents

    • topN

      @Nullable public final Integer topN()
      For a rerank task, the number of most relevant documents to return. It defaults to the number of the documents. If this inference endpoint is used in a text_similarity_reranker retriever query and top_n is set, it must be greater than or equal to rank_window_size in the query.

      API name: top_n

    • truncate

      @Nullable public final CohereTruncateType truncate()
      For a text_embedding task, the method to handle inputs longer than the maximum token length. Valid values are:
      • END: When the input exceeds the maximum input token length, the end of the input is discarded.
      • NONE: When the input exceeds the maximum input token length, an error is returned.
      • START: When the input exceeds the maximum input token length, the start of the input is discarded.

      API name: truncate

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupCohereTaskSettingsDeserializer

      protected static void setupCohereTaskSettingsDeserializer(ObjectDeserializer<CohereTaskSettings.Builder> op)