Record Class OpenAiApi.EmbeddingList<T>

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.EmbeddingList<T>

Type Parameters:

T - Type of the entities in the data list.

Record Components:

object - Must have value "list".

data - List of entities.

model - ID of the model to use.

usage - Usage statistics for the completion request.

Enclosing class:

OpenAiApi

public static record OpenAiApi.EmbeddingList<T>(String object, List<T> data, String model, OpenAiApi.Usage usage)
extends Record

List of multiple embedding responses.

Author:

Christian Tzolov, Michael Lavelle, Mariusz Bernacki, Thomas Vitale, David Frizelle, Alexandros Pappas, Filip Hrisafov

Constructor Summary

Constructors

Constructor	Description
EmbeddingList(String object, List<T> data, String model, OpenAiApi.Usage usage)	Creates an instance of a EmbeddingList record class.

Method Summary

Modifier and Type	Method	Description
List<T>	data()	Returns the value of the data record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	model()	Returns the value of the model record component.
String	object()	Returns the value of the object record component.
final String	toString()	Returns a string representation of this record class.
OpenAiApi.Usage	usage()	Returns the value of the usage record component.

Methods inherited from class Object

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

Constructor Details

EmbeddingList

public EmbeddingList(String object,
 List<T> data,
 String model,
 OpenAiApi.Usage usage)

Creates an instance of a EmbeddingList record class.

Parameters:

object - the value for the object record component

data - the value for the data record component

model - the value for the model record component

usage - the value for the usage record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

object

public String object()

Returns the value of the object record component.

Returns:

the value of the object record component

data

public List<T> data()

Returns the value of the data record component.

Returns:

the value of the data record component

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

usage

public OpenAiApi.Usage usage()

Returns the value of the usage record component.

Returns:

the value of the usage record component