OpenAIUsage

@Serializable
data class OpenAIUsage(val promptTokens: Int, val completionTokens: Int, val totalTokens: Int, val promptTokensDetails: OpenAIPromptTokensDetails? = null, val completionTokensDetails: OpenAICompletionTokensDetails? = null) : Mapper<TokensUsage>

Token usage statistics from an OpenAI chat completion response.

Example:

{
"prompt_tokens": 10,
"completion_tokens": 20,
"total_tokens": 30,
"prompt_tokens_details": { "cached_tokens": 4 },
"completion_tokens_details": { "reasoning_tokens": 5 }
}

Constructors

Link copied to clipboard
constructor(promptTokens: Int, completionTokens: Int, totalTokens: Int, promptTokensDetails: OpenAIPromptTokensDetails? = null, completionTokensDetails: OpenAICompletionTokensDetails? = null)

Properties

Link copied to clipboard
@SerialName(value = "completion_tokens")
val completionTokens: Int

Number of tokens in the completion.

Link copied to clipboard
@SerialName(value = "completion_tokens_details")
val completionTokensDetails: OpenAICompletionTokensDetails?

Breakdown of completion tokens (e.g. reasoning tokens). null when details are not included.

Link copied to clipboard
@SerialName(value = "prompt_tokens")
val promptTokens: Int

Number of tokens in the prompt.

Link copied to clipboard
@SerialName(value = "prompt_tokens_details")
val promptTokensDetails: OpenAIPromptTokensDetails?

Breakdown of prompt tokens (e.g. cached tokens). null when details are not included.

Link copied to clipboard
@SerialName(value = "total_tokens")
val totalTokens: Int

Total number of tokens (prompt + completion).

Functions

Link copied to clipboard
open override fun map(): TokensUsage
Link copied to clipboard