UsageMetadata

classUsageMetadata


Usage metadata about response(s).

Summary

Public constructors

UsageMetadata(
    promptTokenCount: Int,
    candidatesTokenCount: Int?,
    totalTokenCount: Int,
    promptTokensDetails: List<ModalityTokenCount>,
    candidatesTokensDetails: List<ModalityTokenCount>,
    thoughtsTokenCount: Int
)

This function is deprecated. Not intended for public use

Public properties

Int?

Number of tokens in the response(s).

List<ModalityTokenCount>

The breakdown, by modality, of how many tokens are consumed by the candidates.

Int

Number of tokens in the request.

List<ModalityTokenCount>

The breakdown, by modality, of how many tokens are consumed by the prompt.

Int

The number of tokens used by the model's internal "thinking" process.

Int

The number of tokens used by tools.

List<ModalityTokenCount>

The breakdown, by modality, of how many tokens are consumed by tools.

Int

Total number of tokens.

Public constructors

UsageMetadata

UsageMetadata(
    promptTokenCount: Int,
    candidatesTokenCount: Int?,
    totalTokenCount: Int,
    promptTokensDetails: List<ModalityTokenCount>,
    candidatesTokensDetails: List<ModalityTokenCount>,
    thoughtsTokenCount: Int
)
This function is deprecated.
Not intended for public use

Public properties

candidatesTokenCount

val candidatesTokenCountInt?

Number of tokens in the response(s).

candidatesTokensDetails

val candidatesTokensDetailsList<ModalityTokenCount>

The breakdown, by modality, of how many tokens are consumed by the candidates.

promptTokenCount

val promptTokenCountInt

Number of tokens in the request.

promptTokensDetails

val promptTokensDetailsList<ModalityTokenCount>

The breakdown, by modality, of how many tokens are consumed by the prompt.

thoughtsTokenCount

val thoughtsTokenCountInt

The number of tokens used by the model's internal "thinking" process.

toolUsePromptTokenCount

val toolUsePromptTokenCountInt

The number of tokens used by tools.

toolUsePromptTokensDetails

val toolUsePromptTokensDetailsList<ModalityTokenCount>

The breakdown, by modality, of how many tokens are consumed by tools.

totalTokenCount

val totalTokenCountInt

Total number of tokens.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-09 UTC.