Package io.github.stefanbratanov.jvm.openai

Record Class EmbeddingsRequest

java.lang.Object

java.lang.Record

io.github.stefanbratanov.jvm.openai.EmbeddingsRequest

public record EmbeddingsRequest(List<Object> input, String model, Optional<String> encodingFormat, Optional<String> user)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddingsRequest.Builder

Constructor Summary

Constructors

Constructor	Description
EmbeddingsRequest(List<Object> input, String model, Optional<String> encodingFormat, Optional<String> user)	Creates an instance of a EmbeddingsRequest record class.

Method Summary

Modifier and Type	Method	Description
Optional<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.
List<Object>	input()	Returns the value of the input record component.
String	model()	Returns the value of the model record component.
static EmbeddingsRequest.Builder	newBuilder()
final String	toString()	Returns a string representation of this record class.
Optional<String>	user()	Returns the value of the user record component.

Methods inherited from class java.lang.Object

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

Constructor Details

EmbeddingsRequest

public EmbeddingsRequest(List<Object> input,
 String model,
 Optional<String> encodingFormat,
 Optional<String> user)

Creates an instance of a EmbeddingsRequest 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

user - the value for the user record component

Method Details

newBuilder

public static EmbeddingsRequest.Builder newBuilder()

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 List<Object> 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 Optional<String> encodingFormat()

Returns the value of the encodingFormat record component.

Returns:

the value of the encodingFormat record component

user

public Optional<String> user()

Returns the value of the user record component.

Returns:

the value of the user record component