co.elastic.clients.elasticsearch.inference.CohereTaskSettings Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.inference;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Integer;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: inference._types.CohereTaskSettings
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class CohereTaskSettings implements JsonpSerializable {
@Nullable
private final CohereInputType inputType;
@Nullable
private final Boolean returnDocuments;
@Nullable
private final Integer topN;
@Nullable
private final CohereTruncateType truncate;
// ---------------------------------------------------------------------------------------------
private CohereTaskSettings(Builder builder) {
this.inputType = builder.inputType;
this.returnDocuments = builder.returnDocuments;
this.topN = builder.topN;
this.truncate = builder.truncate;
}
public static CohereTaskSettings of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* 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: {@code input_type}
*/
@Nullable
public final CohereInputType inputType() {
return this.inputType;
}
/**
* For a rerank task, return doc text within the results.
*
* API name: {@code return_documents}
*/
@Nullable
public final Boolean returnDocuments() {
return this.returnDocuments;
}
/**
* 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: {@code top_n}
*/
@Nullable
public final Integer topN() {
return this.topN;
}
/**
* 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: {@code truncate}
*/
@Nullable
public final CohereTruncateType truncate() {
return this.truncate;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.inputType != null) {
generator.writeKey("input_type");
this.inputType.serialize(generator, mapper);
}
if (this.returnDocuments != null) {
generator.writeKey("return_documents");
generator.write(this.returnDocuments);
}
if (this.topN != null) {
generator.writeKey("top_n");
generator.write(this.topN);
}
if (this.truncate != null) {
generator.writeKey("truncate");
this.truncate.serialize(generator, mapper);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link CohereTaskSettings}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private CohereInputType inputType;
@Nullable
private Boolean returnDocuments;
@Nullable
private Integer topN;
@Nullable
private CohereTruncateType truncate;
/**
* 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: {@code input_type}
*/
public final Builder inputType(@Nullable CohereInputType value) {
this.inputType = value;
return this;
}
/**
* For a rerank task, return doc text within the results.
*
* API name: {@code return_documents}
*/
public final Builder returnDocuments(@Nullable Boolean value) {
this.returnDocuments = value;
return this;
}
/**
* 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: {@code top_n}
*/
public final Builder topN(@Nullable Integer value) {
this.topN = value;
return this;
}
/**
* 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: {@code truncate}
*/
public final Builder truncate(@Nullable CohereTruncateType value) {
this.truncate = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link CohereTaskSettings}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public CohereTaskSettings build() {
_checkSingleUse();
return new CohereTaskSettings(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link CohereTaskSettings}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, CohereTaskSettings::setupCohereTaskSettingsDeserializer);
protected static void setupCohereTaskSettingsDeserializer(ObjectDeserializer op) {
op.add(Builder::inputType, CohereInputType._DESERIALIZER, "input_type");
op.add(Builder::returnDocuments, JsonpDeserializer.booleanDeserializer(), "return_documents");
op.add(Builder::topN, JsonpDeserializer.integerDeserializer(), "top_n");
op.add(Builder::truncate, CohereTruncateType._DESERIALIZER, "truncate");
}
}