Package co.elastic.clients.elasticsearch.inference

Class VoyageAITaskSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<VoyageAITaskSettings.Builder>

co.elastic.clients.elasticsearch.inference.VoyageAITaskSettings.Builder

All Implemented Interfaces:

WithJson<VoyageAITaskSettings.Builder>, ObjectBuilder<VoyageAITaskSettings>

Enclosing class:

VoyageAITaskSettings

public static class VoyageAITaskSettings.Builder
extends WithJsonObjectBuilderBase<VoyageAITaskSettings.Builder>
implements ObjectBuilder<VoyageAITaskSettings>

Builder for VoyageAITaskSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VoyageAITaskSettings	build()	Builds a VoyageAITaskSettings.
final VoyageAITaskSettings.Builder	inputType(String value)	Type of the input text.
final VoyageAITaskSettings.Builder	returnDocuments(Boolean value)	Whether to return the source documents in the response.
protected VoyageAITaskSettings.Builder	self()
final VoyageAITaskSettings.Builder	topK(Integer value)	The number of most relevant documents to return.
final VoyageAITaskSettings.Builder	truncation(Boolean value)	Whether to truncate the input texts to fit within the context length.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

inputType

public final VoyageAITaskSettings.Builder inputType(@Nullable
 String value)

Type of the input text. Permitted values: ingest (maps to document in the VoyageAI documentation), search (maps to query in the VoyageAI documentation). Only for the text_embedding task type.

API name: input_type

returnDocuments

public final VoyageAITaskSettings.Builder returnDocuments(@Nullable
 Boolean value)

Whether to return the source documents in the response. Only for the rerank task type.

API name: return_documents

topK

public final VoyageAITaskSettings.Builder topK(@Nullable
 Integer value)

The number of most relevant documents to return. If not specified, the reranking results of all documents will be returned. Only for the rerank task type.

API name: top_k

truncation

public final VoyageAITaskSettings.Builder truncation(@Nullable
 Boolean value)

Whether to truncate the input texts to fit within the context length.

API name: truncation

self

protected VoyageAITaskSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<VoyageAITaskSettings.Builder>

build

public VoyageAITaskSettings build()

Builds a VoyageAITaskSettings.

Specified by:

build in interface ObjectBuilder<VoyageAITaskSettings>

Throws:

NullPointerException - if some of the required fields are null.