Class EmbeddingRequest

java.lang.Object

dev.langchain4j.model.embedding.request.EmbeddingRequest

@Experimental
public class EmbeddingRequest
extends Object

A request to an EmbeddingModel, containing a batch of EmbeddingInputs to embed and the per-call parameters.

The request has two dimensions:

• the batch dimension — the list of EmbeddingInputs, each producing one embedding;
• the interleaving dimension — the list of Content parts inside each EmbeddingInput, fused into a single embedding (for multimodal models).

For the common text case the builder accepts plain Strings and TextSegments directly, each becoming a single-text EmbeddingInput; the Content-based methods unlock multimodal input.

Since:

1.18.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddingRequest.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EmbeddingRequest(EmbeddingRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static EmbeddingRequest.Builder	builder()
Integer	dimensions()
boolean	equals(Object o)
int	hashCode()
List<EmbeddingInput>	inputs()	The batch of inputs to embed; each EmbeddingInput yields one embedding.
EmbeddingInputType	inputType()
String	modelName()
EmbeddingRequestParameters	parameters()	The per-call parameters; never null (EmbeddingRequestParameters.EMPTY when none were set).
String	toString()

Methods inherited from class Object

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

Constructor Details

EmbeddingRequest

protected EmbeddingRequest(EmbeddingRequest.Builder builder)

Method Details

inputs

public List<EmbeddingInput> inputs()

The batch of inputs to embed; each EmbeddingInput yields one embedding.

parameters

public EmbeddingRequestParameters parameters()

The per-call parameters; never null (EmbeddingRequestParameters.EMPTY when none were set).

modelName

public String modelName()

dimensions

public Integer dimensions()

inputType

public EmbeddingInputType inputType()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static EmbeddingRequest.Builder builder()