Class EmbeddingModelResponseContext

java.lang.Object

dev.langchain4j.model.embedding.listener.EmbeddingModelResponseContext

@Experimental
public class EmbeddingModelResponseContext
extends Object

The context passed to EmbeddingModelListener.onResponse(EmbeddingModelResponseContext) after a successful embedding call. It gives access to the EmbeddingRequest that was embedded, the resulting EmbeddingResponse (the embeddings and response metadata), the EmbeddingModel, the ModelProvider, and the attributes map shared with the request callback of the same listener.

Since:

1.11.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddingModelResponseContext.Builder	Builder for EmbeddingModelResponseContext.

Constructor Summary

Constructors

Constructor	Description
EmbeddingModelResponseContext(EmbeddingModelResponseContext.Builder builder)

Method Summary

Modifier and Type	Method	Description
Map<Object,Object>	attributes()
static EmbeddingModelResponseContext.Builder	builder()
EmbeddingModel	embeddingModel()
EmbeddingRequest	embeddingRequest()
EmbeddingResponse	embeddingResponse()
ModelProvider	modelProvider()
Response<List<Embedding>>	response()
List<TextSegment>	textSegments()

Methods inherited from class Object

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

Constructor Details

EmbeddingModelResponseContext

public EmbeddingModelResponseContext(EmbeddingModelResponseContext.Builder builder)

Method Details

embeddingRequest

public EmbeddingRequest embeddingRequest()

Returns:

the EmbeddingRequest that was embedded, including its per-call parameters and multimodal inputs. For a convenience call (EmbeddingModel.embed(String) / EmbeddingModel.embedAll(List)) it is reconstructed from the inputs, and is null only when there are no inputs.

embeddingResponse

public EmbeddingResponse embeddingResponse()

Returns:

the EmbeddingResponse, including the embeddings and the response metadata.

embeddingModel

public EmbeddingModel embeddingModel()

modelProvider

public ModelProvider modelProvider()

Returns:

the ModelProvider of the embedding model (for example ModelProvider.OPEN_AI).

attributes

public Map<Object,Object> attributes()

Returns:

The attributes map. It can be used to pass data between methods of an EmbeddingModelListener or between multiple EmbeddingModelListeners.

response

public Response<List<Embedding>> response()

Returns:

the embeddings and token usage. For the full response, including all response metadata, use embeddingResponse().

textSegments

public List<TextSegment> textSegments()

Returns:

the text of each input that was embedded. For the full request, including per-call parameters and multimodal inputs, use embeddingRequest().

builder

public static EmbeddingModelResponseContext.Builder builder()