DeepSeek Kotlin SDK/org.oremif.deepseek.models/Usage

Usage

@Serializable

class Usage(val completionTokens: Int, val promptTokens: Int, val promptCacheHitTokens: Int? = null, val promptCacheMissTokens: Int? = null, val promptTokensDetails: PromptTokensDetails? = null, val totalTokens: Int, val completionTokensDetails: CompletionTokenDetails? = null)

Token usage statistics for a single chat or FIM request.

For streamed responses the ChatCompletionChunk.usage or FIMCompletion.usage field is populated only on the final usage-only chunk, which the API emits when streamOptions.includeUsage is set.

Constructors

Usage

constructor(completionTokens: Int, promptTokens: Int, promptCacheHitTokens: Int? = null, promptCacheMissTokens: Int? = null, promptTokensDetails: PromptTokensDetails? = null, totalTokens: Int, completionTokensDetails: CompletionTokenDetails? = null)

Properties

completionTokens

val completionTokens: Int

Number of tokens in the generated completion.

completionTokensDetails

val completionTokensDetails: CompletionTokenDetails?

Breakdown of how completionTokens was spent (e.g. reasoning tokens for deepseek-reasoner).

promptCacheHitTokens

val promptCacheHitTokens: Int?

Number of prompt tokens served from the context cache, or null when caching does not apply. Legacy field; newer responses may report the same information under promptTokensDetails instead.

promptCacheMissTokens

val promptCacheMissTokens: Int?

Number of prompt tokens not served from the context cache, or null when caching does not apply. Legacy field; see promptTokensDetails.

promptTokens

val promptTokens: Int

Number of tokens in the prompt. When context caching applies, this equals promptCacheHitTokens + promptCacheMissTokens.

promptTokensDetails

val promptTokensDetails: PromptTokensDetails?

Structured breakdown of promptTokens under the prompt_tokens_details key, matching the OpenAI-compatible shape. May be null for older API versions.

totalTokens

val totalTokens: Int

Total tokens billed for the request (prompt + completion).

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String