Class OpenAiEmbeddingRequestParameters

java.lang.Object

dev.langchain4j.model.embedding.request.DefaultEmbeddingRequestParameters

dev.langchain4j.model.openai.OpenAiEmbeddingRequestParameters

All Implemented Interfaces:

EmbeddingRequestParameters

@Experimental
public class OpenAiEmbeddingRequestParameters
extends DefaultEmbeddingRequestParameters

OpenAI-specific EmbeddingRequestParameters, adding the parameters supported by the OpenAI embeddings API on top of the common modelName/dimensions.

The CUSTOM_PARAMETERS map is the passthrough for provider extensions that ride on the OpenAI wire format but are not first-class OpenAI parameters — most notably NVIDIA's input_type, which enables asymmetric query-vs-passage encoding on a per-call basis.

Since:

1.18.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiEmbeddingRequestParameters.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final EmbeddingParameter<Map>	CUSTOM_PARAMETERS
static final EmbeddingParameter<String>	ENCODING_FORMAT
static final EmbeddingParameter<String>	USER

Fields inherited from interface EmbeddingRequestParameters

DIMENSIONS, EMPTY, INPUT_TYPE, MODEL_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenAiEmbeddingRequestParameters(OpenAiEmbeddingRequestParameters.Builder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiEmbeddingRequestParameters.Builder	builder()
Map<String,Object>	customParameters()
String	encodingFormat()
OpenAiEmbeddingRequestParameters	overrideWith(EmbeddingRequestParameters that)	Creates a new EmbeddingRequestParameters by combining the current parameters with the specified ones.
String	user()

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

USER

public static final EmbeddingParameter<String> USER

ENCODING_FORMAT

public static final EmbeddingParameter<String> ENCODING_FORMAT

CUSTOM_PARAMETERS

public static final EmbeddingParameter<Map> CUSTOM_PARAMETERS

Constructor Details

OpenAiEmbeddingRequestParameters

protected OpenAiEmbeddingRequestParameters(OpenAiEmbeddingRequestParameters.Builder builder)

Method Details

user

public String user()

encodingFormat

public String encodingFormat()

customParameters

public Map<String,Object> customParameters()

overrideWith

public OpenAiEmbeddingRequestParameters 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 OpenAiEmbeddingRequestParameters.Builder builder()