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

Record Class ChatUsageResponse

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

Mergeable<ChatUsageResponse>

public record ChatUsageResponse(int promptTokens, int completionTokens, int totalTokens)
extends Record
implements Mergeable<ChatUsageResponse>

Constructor Summary

Constructors

Constructor	Description
ChatUsageResponse(int promptTokens, int completionTokens, int totalTokens)	Creates an instance of a ChatUsageResponse record class.

Method Summary

Modifier and Type	Method	Description
int	completionTokens()	Returns the value of the completionTokens record component.
static ChatUsageResponse	empty()
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.
ChatUsageResponse	merge(ChatUsageResponse other)
int	promptTokens()	Returns the value of the promptTokens record component.
final String	toString()	Returns a string representation of this record class.
int	totalTokens()	Returns the value of the totalTokens record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatUsageResponse

public ChatUsageResponse(int promptTokens,
 int completionTokens,
 int totalTokens)

Creates an instance of a ChatUsageResponse record class.

Parameters:

promptTokens - the value for the promptTokens record component

completionTokens - the value for the completionTokens record component

totalTokens - the value for the totalTokens record component

Method Details

empty

public static ChatUsageResponse empty()

merge

public ChatUsageResponse merge(ChatUsageResponse other)

Specified by:

merge in interface Mergeable<ChatUsageResponse>

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 '=='.

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.

promptTokens

public int promptTokens()

Returns the value of the promptTokens record component.

Returns:

the value of the promptTokens record component

completionTokens

public int completionTokens()

Returns the value of the completionTokens record component.

Returns:

the value of the completionTokens record component

totalTokens

public int totalTokens()

Returns the value of the totalTokens record component.

Returns:

the value of the totalTokens record component