Package org.springframework.ai.openai.api

Record Class OpenAiApi.Usage

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.Usage

Record Components:

completionTokens - Number of tokens in the generated completion. Only applicable for completion requests.

promptTokens - Number of tokens in the prompt.

totalTokens - Total number of tokens used in the request (prompt + completion).

promptTokensDetails - Breakdown of tokens used in the prompt.

completionTokenDetails - Breakdown of tokens used in a completion.

Enclosing class:

OpenAiApi

public static record OpenAiApi.Usage(Integer completionTokens, Integer promptTokens, Integer totalTokens, OpenAiApi.Usage.PromptTokensDetails promptTokensDetails, OpenAiApi.Usage.CompletionTokenDetails completionTokenDetails)
extends Record

Usage statistics for the completion request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiApi.Usage.CompletionTokenDetails	Breakdown of tokens used in a completion.
static final record	OpenAiApi.Usage.PromptTokensDetails	Breakdown of tokens used in the prompt

Constructor Summary

Constructors

Constructor	Description
Usage(Integer completionTokens, Integer promptTokens, Integer totalTokens)
Usage(Integer completionTokens, Integer promptTokens, Integer totalTokens, OpenAiApi.Usage.PromptTokensDetails promptTokensDetails, OpenAiApi.Usage.CompletionTokenDetails completionTokenDetails)	Creates an instance of a Usage record class.

Method Summary

Modifier and Type	Method	Description
OpenAiApi.Usage.CompletionTokenDetails	completionTokenDetails()	Returns the value of the completionTokenDetails record component.
Integer	completionTokens()	Returns the value of the completionTokens 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.
Integer	promptTokens()	Returns the value of the promptTokens record component.
OpenAiApi.Usage.PromptTokensDetails	promptTokensDetails()	Returns the value of the promptTokensDetails record component.
final String	toString()	Returns a string representation of this record class.
Integer	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

Usage

public Usage(Integer completionTokens,
 Integer promptTokens,
 Integer totalTokens)

Usage

public Usage(Integer completionTokens,
 Integer promptTokens,
 Integer totalTokens,
 OpenAiApi.Usage.PromptTokensDetails promptTokensDetails,
 OpenAiApi.Usage.CompletionTokenDetails completionTokenDetails)

Creates an instance of a Usage record class.

Parameters:

completionTokens - the value for the completionTokens record component

promptTokens - the value for the promptTokens record component

totalTokens - the value for the totalTokens record component

promptTokensDetails - the value for the promptTokensDetails record component

completionTokenDetails - the value for the completionTokenDetails 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. 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.

completionTokens

public Integer completionTokens()

Returns the value of the completionTokens record component.

Returns:

the value of the completionTokens record component

promptTokens

public Integer promptTokens()

Returns the value of the promptTokens record component.

Returns:

the value of the promptTokens record component

totalTokens

public Integer totalTokens()

Returns the value of the totalTokens record component.

Returns:

the value of the totalTokens record component

promptTokensDetails

public OpenAiApi.Usage.PromptTokensDetails promptTokensDetails()

Returns the value of the promptTokensDetails record component.

Returns:

the value of the promptTokensDetails record component

completionTokenDetails

public OpenAiApi.Usage.CompletionTokenDetails completionTokenDetails()

Returns the value of the completionTokenDetails record component.

Returns:

the value of the completionTokenDetails record component