Package dev.langchain4j.model.voyageai

Class VoyageAiEmbeddingModel.Builder

java.lang.Object

dev.langchain4j.model.voyageai.VoyageAiEmbeddingModel.Builder

Enclosing class:

VoyageAiEmbeddingModel

public static class VoyageAiEmbeddingModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VoyageAiEmbeddingModel.Builder	apiKey(String apiKey)
VoyageAiEmbeddingModel.Builder	baseUrl(String baseUrl)
VoyageAiEmbeddingModel	build()
VoyageAiEmbeddingModel.Builder	encodingFormat(String encodingFormat)	Format in which the embeddings are encoded.
VoyageAiEmbeddingModel.Builder	inputType(String inputType)	Type of the input text.
VoyageAiEmbeddingModel.Builder	logRequests(Boolean logRequests)
VoyageAiEmbeddingModel.Builder	logResponses(Boolean logResponses)
VoyageAiEmbeddingModel.Builder	maxRetries(Integer maxRetries)
VoyageAiEmbeddingModel.Builder	maxSegmentsPerBatch(Integer maxSegmentsPerBatch)
VoyageAiEmbeddingModel.Builder	modelName(VoyageAiEmbeddingModelName modelName)	Name of the model.
VoyageAiEmbeddingModel.Builder	modelName(String modelName)	Name of the model.
VoyageAiEmbeddingModel.Builder	timeout(Duration timeout)
VoyageAiEmbeddingModel.Builder	truncation(Boolean truncation)	Whether to truncate the input texts to fit within the context length.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

baseUrl

public VoyageAiEmbeddingModel.Builder baseUrl(String baseUrl)

timeout

public VoyageAiEmbeddingModel.Builder timeout(Duration timeout)

maxRetries

public VoyageAiEmbeddingModel.Builder maxRetries(Integer maxRetries)

apiKey

public VoyageAiEmbeddingModel.Builder apiKey(String apiKey)

modelName

public VoyageAiEmbeddingModel.Builder modelName(VoyageAiEmbeddingModelName modelName)

Name of the model.

Parameters:

modelName - Name of the model.

See Also:

• VoyageAiEmbeddingModelName

modelName

public VoyageAiEmbeddingModel.Builder modelName(String modelName)

Name of the model.

Parameters:

modelName - Name of the model.

See Also:

• VoyageAiEmbeddingModelName

inputType

public VoyageAiEmbeddingModel.Builder inputType(String inputType)

Type of the input text. Defaults to null. Other options: query, document.

• query: Use this for search or retrieval queries. Voyage AI will prepend a prompt to optimize the embeddings for query use cases.
• document: Use this for documents or content that you want to be retrievable. Voyage AI will prepend a prompt to optimize the embeddings for document use cases.
• null (default): The input text will be directly encoded without any additional prompt.

Parameters:

inputType - Type of input text

truncation

public VoyageAiEmbeddingModel.Builder truncation(Boolean truncation)

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

• If true, over-length input texts will be truncated to fit within the context length, before vectorized by the embedding model.
• If false, an error will be raised if any given text exceeds the context length.

Parameters:

truncation - Whether to truncate the input texts.

encodingFormat

public VoyageAiEmbeddingModel.Builder encodingFormat(String encodingFormat)

Format in which the embeddings are encoded. We support two options:

• If not specified (defaults to null): the embeddings are represented as lists of floating-point numbers;
• base64: the embeddings are compressed to base64 encodings.

Parameters:

encodingFormat - Format in which the embeddings are encoded. Support format is "null" and "base64".

logRequests

public VoyageAiEmbeddingModel.Builder logRequests(Boolean logRequests)

logResponses

public VoyageAiEmbeddingModel.Builder logResponses(Boolean logResponses)

maxSegmentsPerBatch

public VoyageAiEmbeddingModel.Builder maxSegmentsPerBatch(Integer maxSegmentsPerBatch)

build

public VoyageAiEmbeddingModel build()