Package ai.optfor.springopenaiapi.model

Record Class ChatCompletionRequest

java.lang.Object

java.lang.Record

ai.optfor.springopenaiapi.model.ChatCompletionRequest

public record ChatCompletionRequest(String model, List<ChatMessage> messages, double temperature, int max_tokens, ResponseFormat response_format, boolean stream)
extends Record

Constructor Summary

Constructors

Constructor	Description
ChatCompletionRequest(String model, List<ChatMessage> messages, double temperature, int max_tokens, ResponseFormat response_format, boolean stream)	Creates an instance of a ChatCompletionRequest record class.

Method Summary

Modifier and Type	Method	Description
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.
int	max_tokens()	Returns the value of the max_tokens record component.
List<ChatMessage>	messages()	Returns the value of the messages record component.
String	model()	Returns the value of the model record component.
ResponseFormat	response_format()	Returns the value of the response_format record component.
boolean	stream()	Returns the value of the stream record component.
double	temperature()	Returns the value of the temperature record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionRequest

public ChatCompletionRequest(String model,
 List<ChatMessage> messages,
 double temperature,
 int max_tokens,
 ResponseFormat response_format,
 boolean stream)

Creates an instance of a ChatCompletionRequest record class.

Parameters:

model - the value for the model record component

messages - the value for the messages record component

temperature - the value for the temperature record component

max_tokens - the value for the max_tokens record component

response_format - the value for the response_format record component

stream - the value for the stream 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

messages

public List<ChatMessage> messages()

Returns the value of the messages record component.

Returns:

the value of the messages record component

temperature

public double temperature()

Returns the value of the temperature record component.

Returns:

the value of the temperature record component

max_tokens

public int max_tokens()

Returns the value of the max_tokens record component.

Returns:

the value of the max_tokens record component

response_format

public ResponseFormat response_format()

Returns the value of the response_format record component.

Returns:

the value of the response_format record component

stream

public boolean stream()

Returns the value of the stream record component.

Returns:

the value of the stream record component