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

Record Class ChatMessageResponse

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

Mergeable<ChatMessageResponse>

public record ChatMessageResponse(String id, String object, long created, String model, ChatUsageResponse usage, List<ChatChoiceResponse> choices)
extends Record
implements Mergeable<ChatMessageResponse>

Represents a invalid input: '<'a href="https://platform.openai.com/docs/api-reference/chat/object>Chat completion object

Constructor Summary

Constructors

Constructor	Description
ChatMessageResponse(String id, String object, long created, String model, ChatUsageResponse usage, List<ChatChoiceResponse> choices)	Creates an instance of a ChatMessageResponse record class.

Method Summary

Modifier and Type	Method	Description
List<ChatChoiceResponse>	choices()	Returns the value of the choices record component.
long	created()	Returns the value of the created 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	id()	Returns the value of the id record component.
ChatMessageResponse	merge(ChatMessageResponse other)
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.
ChatUsageResponse	usage()	Returns the value of the usage record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatMessageResponse

public ChatMessageResponse(String id,
 String object,
 long created,
 String model,
 ChatUsageResponse usage,
 List<ChatChoiceResponse> choices)

Creates an instance of a ChatMessageResponse record class.

Parameters:

id - the value for the id record component

object - the value for the object record component

created - the value for the created record component

model - the value for the model record component

usage - the value for the usage record component

choices - the value for the choices record component

Method Details

merge

public ChatMessageResponse merge(ChatMessageResponse other)

Specified by:

merge in interface Mergeable<ChatMessageResponse>

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.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

object

public String object()

Returns the value of the object record component.

Returns:

the value of the object record component

created

public long created()

Returns the value of the created record component.

Returns:

the value of the created record component

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

usage

public ChatUsageResponse usage()

Returns the value of the usage record component.

Returns:

the value of the usage record component

choices

public List<ChatChoiceResponse> choices()

Returns the value of the choices record component.

Returns:

the value of the choices record component