Record Class OpenAiApi.EmbeddingRequest<T>

java.lang.Object

java.lang.Record

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

Type Parameters:

T - Type of the input.

Record Components:

input - Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for text-embedding-ada-002), cannot be an empty string, and any array must be 2048 dimensions or less.

model - ID of the model to use.

encodingFormat - The format to return the embeddings in. Can be either float or base64.

dimensions - The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

user - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Enclosing class:

OpenAiApi

public static record OpenAiApi.EmbeddingRequest<T>(T input, String model, String encodingFormat, Integer dimensions, String user)
extends Record

Creates an embedding vector representing the input text.

Author:

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

Constructor Summary

Constructors

Constructor	Description
EmbeddingRequest(T input)	Create an embedding request with the given input.
EmbeddingRequest(T input, String model)	Create an embedding request with the given input, model and encoding format set to float.
EmbeddingRequest(T input, String model, String encodingFormat, Integer dimensions, String user)	Creates an instance of a EmbeddingRequest record class.

Method Summary

Modifier and Type	Method	Description
Integer	dimensions()	Returns the value of the dimensions record component.
String	encodingFormat()	Returns the value of the encodingFormat 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.
T	input()	Returns the value of the input record component.
String	model()	Returns the value of the model record component.
final String	toString()	Returns a string representation of this record class.
String	user()	Returns the value of the user record component.

Methods inherited from class Object

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

Constructor Details

EmbeddingRequest

public EmbeddingRequest(T input,
 String model)

Create an embedding request with the given input, model and encoding format set to float.

Parameters:

input - Input text to embed.

model - ID of the model to use.

EmbeddingRequest

public EmbeddingRequest(T input)

Create an embedding request with the given input. Encoding format is set to float and user is null and the model is set to 'text-embedding-ada-002'.

Parameters:

input - Input text to embed.

EmbeddingRequest

public EmbeddingRequest(T input,
 String model,
 String encodingFormat,
 Integer dimensions,
 String user)

Creates an instance of a EmbeddingRequest record class.

Parameters:

input - the value for the input record component

model - the value for the model record component

encodingFormat - the value for the encodingFormat record component

dimensions - the value for the dimensions record component

user - the value for the user 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.

input

public T input()

Returns the value of the input record component.

Returns:

the value of the input record component

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

encodingFormat

public String encodingFormat()

Returns the value of the encodingFormat record component.

Returns:

the value of the encodingFormat record component

dimensions

public Integer dimensions()

Returns the value of the dimensions record component.

Returns:

the value of the dimensions record component

user

public String user()

Returns the value of the user record component.

Returns:

the value of the user record component