Package nl.dannyj.mistral.models.embedding

Class EmbeddingResponse

java.lang.Object

nl.dannyj.mistral.models.embedding.EmbeddingResponse

All Implemented Interfaces:

Response

public class EmbeddingResponse
extends Object
implements Response

The EmbeddingResponse class represents a response from the Mistral API when creating embeddings. Most of these fields are undocumented.

Constructor Summary

Constructors

Constructor	Description
EmbeddingResponse()
EmbeddingResponse(String id, String object, List<FloatEmbedding> data, String model, Usage usage)

Method Summary

Modifier and Type	Method	Description
List<FloatEmbedding>	getData()	The embeddings that were created for the list of input strings.
String	getId()	Unique identifier for this response.
String	getModel()	The model used to create the embeddings.
String	getObject()	Undocumented, seems to be the type of the response.
Usage	getUsage()	The token usage of the request.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

EmbeddingResponse

public EmbeddingResponse(String id,
 String object,
 List<FloatEmbedding> data,
 String model,
 Usage usage)

EmbeddingResponse

public EmbeddingResponse()

Method Details

getId

public String getId()

Unique identifier for this response.

Returns:

the id of the response

getObject

public String getObject()

Undocumented, seems to be the type of the response.

Returns:

the object type

getData

public List<FloatEmbedding> getData()

The embeddings that were created for the list of input strings.

Returns:

a list of float embeddings

getModel

public String getModel()

The model used to create the embeddings.

Returns:

the ID of the model used to generate the embeddings

getUsage

public Usage getUsage()

The token usage of the request.

Returns:

the usage of the request

toString

public String toString()

Overrides:

toString in class Object