Package bg.codexio.ai.openai.api.payload.chat.response

Record Class ChatChoiceResponse

java.lang.Object

java.lang.Record

bg.codexio.ai.openai.api.payload.chat.response.ChatChoiceResponse

All Implemented Interfaces:

Mergeable<ChatChoiceResponse>

public record ChatChoiceResponse(ChatMessage message, ChatMessage delta, String finishReason, int index)
extends Record
implements Mergeable<ChatChoiceResponse>

Constructor Summary

Constructors

Constructor	Description
ChatChoiceResponse(ChatMessage message, ChatMessage delta, String finishReason, int index)	Creates an instance of a ChatChoiceResponse record class.

Method Summary

Modifier and Type	Method	Description
ChatMessage	delta()	Returns the value of the delta record component.
static ChatChoiceResponse	empty()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	finishReason()	Returns the value of the finishReason record component.
final int	hashCode()	Returns a hash code value for this object.
int	index()	Returns the value of the index record component.
ChatChoiceResponse	merge(ChatChoiceResponse other)
ChatMessage	message()	Returns the value of the message 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

ChatChoiceResponse

public ChatChoiceResponse(ChatMessage message,
 ChatMessage delta,
 String finishReason,
 int index)

Creates an instance of a ChatChoiceResponse record class.

Parameters:

message - the value for the message record component

delta - the value for the delta record component

finishReason - the value for the finishReason record component

index - the value for the index record component

Method Details

empty

public static ChatChoiceResponse empty()

merge

public ChatChoiceResponse merge(ChatChoiceResponse other)

Specified by:

merge in interface Mergeable<ChatChoiceResponse>

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.

message

public ChatMessage message()

Returns the value of the message record component.

Returns:

the value of the message record component

delta

public ChatMessage delta()

Returns the value of the delta record component.

Returns:

the value of the delta record component

finishReason

public String finishReason()

Returns the value of the finishReason record component.

Returns:

the value of the finishReason record component

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index record component