Class VoyageAiEmbeddingRequestParameters

java.lang.Object

dev.langchain4j.model.embedding.request.DefaultEmbeddingRequestParameters

dev.langchain4j.model.voyageai.VoyageAiEmbeddingRequestParameters

All Implemented Interfaces:

EmbeddingRequestParameters

@Experimental
public class VoyageAiEmbeddingRequestParameters
extends DefaultEmbeddingRequestParameters

Voyage AI-specific EmbeddingRequestParameters, adding the parameters accepted by the Voyage AI embeddings API on top of the common inputType.

TRUNCATION controls what happens to an input that is longer than the model's context: it is truncated (true, the default on Voyage's side) or the call fails (false).

ENCODING_FORMAT ("base64") only asks Voyage to compress the embeddings in the response; the embeddings handed back to the caller are the same either way. It is carried only by the text embeddings request - Voyage's multimodal endpoint has an equivalent output_encoding field, which this integration does not send - so a multimodal model does not declare it in EmbeddingModel.supportedParameters() and rejects it rather than accepting a value that would be dropped.

Since:

1.21.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VoyageAiEmbeddingRequestParameters.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final EmbeddingParameter<String>	ENCODING_FORMAT
static final EmbeddingParameter<Boolean>	TRUNCATION

Fields inherited from interface EmbeddingRequestParameters

DIMENSIONS, EMPTY, INPUT_TYPE, MODEL_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VoyageAiEmbeddingRequestParameters(VoyageAiEmbeddingRequestParameters.Builder builder)

Method Summary

Modifier and Type	Method	Description
static VoyageAiEmbeddingRequestParameters.Builder	builder()
String	encodingFormat()
VoyageAiEmbeddingRequestParameters	overrideWith(EmbeddingRequestParameters that)	Creates a new EmbeddingRequestParameters by combining the current parameters with the specified ones.
Boolean	truncation()

Methods inherited from class DefaultEmbeddingRequestParameters

dimensions, equals, hashCode, inputType, modelName, parameter, presentParameters, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TRUNCATION

public static final EmbeddingParameter<Boolean> TRUNCATION

ENCODING_FORMAT

public static final EmbeddingParameter<String> ENCODING_FORMAT

Constructor Details

VoyageAiEmbeddingRequestParameters

protected VoyageAiEmbeddingRequestParameters(VoyageAiEmbeddingRequestParameters.Builder builder)

Method Details

truncation

public Boolean truncation()

encodingFormat

public String encodingFormat()

overrideWith

public VoyageAiEmbeddingRequestParameters overrideWith(EmbeddingRequestParameters that)

Description copied from interface: EmbeddingRequestParameters

Creates a new EmbeddingRequestParameters by combining the current parameters with the specified ones. Values from the specified parameters override values from the current parameters when there is overlap. Neither instance is modified.

Specified by:

overrideWith in interface EmbeddingRequestParameters

Overrides:

overrideWith in class DefaultEmbeddingRequestParameters

Parameters:

that - the parameters whose values will override the current ones.

Returns:

a new combined EmbeddingRequestParameters instance.

builder

public static VoyageAiEmbeddingRequestParameters.Builder builder()