Package org.springframework.ai.embedding

Class EmbeddingResponse

java.lang.Object

org.springframework.ai.embedding.EmbeddingResponse

All Implemented Interfaces:

ModelResponse<Embedding>

public class EmbeddingResponse
extends Object
implements ModelResponse<Embedding>

Embedding response object.

Constructor Summary

Constructors

Constructor	Description
EmbeddingResponse(List<Embedding> embeddings)	Creates a new EmbeddingResponse instance with empty metadata.
EmbeddingResponse(List<Embedding> embeddings, EmbeddingResponseMetadata metadata)	Creates a new EmbeddingResponse instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
EmbeddingResponseMetadata	getMetadata()	Retrieves the response metadata associated with the AI model's response.
Embedding	getResult()	Retrieves the result of the AI model.
List<Embedding>	getResults()	Retrieves the list of generated outputs by the AI model.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

EmbeddingResponse

public EmbeddingResponse(List<Embedding> embeddings)

Creates a new EmbeddingResponse instance with empty metadata.

Parameters:

embeddings - the embedding data.

EmbeddingResponse

public EmbeddingResponse(List<Embedding> embeddings,
 EmbeddingResponseMetadata metadata)

Creates a new EmbeddingResponse instance.

Parameters:

embeddings - the embedding data.

metadata - the embedding metadata.

Method Details

getMetadata

public EmbeddingResponseMetadata getMetadata()

Description copied from interface: ModelResponse

Retrieves the response metadata associated with the AI model's response.

Specified by:

getMetadata in interface ModelResponse<Embedding>

Returns:

Get the embedding metadata.

getResult

public Embedding getResult()

Description copied from interface: ModelResponse

Retrieves the result of the AI model.

Specified by:

getResult in interface ModelResponse<Embedding>

Returns:

the result generated by the AI model

getResults

public List<Embedding> getResults()

Description copied from interface: ModelResponse

Retrieves the list of generated outputs by the AI model.

Specified by:

getResults in interface ModelResponse<Embedding>

Returns:

Get the embedding data.

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