Package org.springframework.ai.openai.metadata

Class OpenAiUsage

java.lang.Object

org.springframework.ai.openai.metadata.OpenAiUsage

All Implemented Interfaces:

Usage

public class OpenAiUsage
extends Object
implements Usage

Usage implementation for OpenAI.

Since:

0.7.0

Author:

John Blum, Thomas Vitale, David Frizelle, Christian Tzolov

See Also:

• Completion Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiUsage.CompletionTokenDetails
static final record	OpenAiUsage.PromptTokensDetails

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenAiUsage(OpenAiApi.Usage usage)

Method Summary

Modifier and Type	Method	Description
static OpenAiUsage	from(OpenAiApi.Usage usage)
Long	getAcceptedPredictionTokens()	Deprecated. Use getCompletionTokenDetails() instead.
Long	getAudioTokens()	Deprecated. Use getCompletionTokenDetails() instead.
OpenAiUsage.CompletionTokenDetails	getCompletionTokenDetails()
Long	getGenerationTokens()	Returns the number of tokens returned in the generation (aka completion) of the AI's response.
Long	getPromptTokens()	Returns the number of tokens used in the prompt of the AI request.
OpenAiUsage.PromptTokensDetails	getPromptTokensDetails()
Long	getPromptTokensDetailsCachedTokens()	Deprecated. Use getPromptTokensDetails() instead.
Long	getReasoningTokens()	Deprecated. Use getCompletionTokenDetails() instead.
Long	getRejectedPredictionTokens()	Deprecated. Use getCompletionTokenDetails() instead.
Long	getTotalTokens()	Return the total number of tokens from both the prompt of an AI request and generation of the AI's response.
protected OpenAiApi.Usage	getUsage()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OpenAiUsage

protected OpenAiUsage(OpenAiApi.Usage usage)

Method Details

from

public static OpenAiUsage from(OpenAiApi.Usage usage)

getUsage

protected OpenAiApi.Usage getUsage()

getPromptTokens

public Long getPromptTokens()

Description copied from interface: Usage

Returns the number of tokens used in the prompt of the AI request.

Specified by:

getPromptTokens in interface Usage

Returns:

an Long with the number of tokens used in the prompt of the AI request.

See Also:

• Usage.getGenerationTokens()

getGenerationTokens

public Long getGenerationTokens()

Description copied from interface: Usage

Returns the number of tokens returned in the generation (aka completion) of the AI's response.

Specified by:

getGenerationTokens in interface Usage

Returns:

an Long with the number of tokens returned in the generation (aka completion) of the AI's response.

See Also:

• Usage.getPromptTokens()

getTotalTokens

public Long getTotalTokens()

Description copied from interface: Usage

Return the total number of tokens from both the prompt of an AI request and generation of the AI's response.

Specified by:

getTotalTokens in interface Usage

Returns:

the total number of tokens from both the prompt of an AI request and generation of the AI's response.

See Also:

• Usage.getPromptTokens()
• Usage.getGenerationTokens()

getPromptTokensDetailsCachedTokens

@Deprecated
public Long getPromptTokensDetailsCachedTokens()

Deprecated.

Use getPromptTokensDetails() instead.

getPromptTokensDetails

public OpenAiUsage.PromptTokensDetails getPromptTokensDetails()

getReasoningTokens

@Deprecated
public Long getReasoningTokens()

Deprecated.

Use getCompletionTokenDetails() instead.

getAcceptedPredictionTokens

@Deprecated
public Long getAcceptedPredictionTokens()

Deprecated.

Use getCompletionTokenDetails() instead.

getAudioTokens

@Deprecated
public Long getAudioTokens()

Deprecated.

Use getCompletionTokenDetails() instead.

getRejectedPredictionTokens

@Deprecated
public Long getRejectedPredictionTokens()

Deprecated.

Use getCompletionTokenDetails() instead.

getCompletionTokenDetails

public OpenAiUsage.CompletionTokenDetails getCompletionTokenDetails()

toString

public String toString()

Overrides:

toString in class Object