IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

UsageMetadata

public final class UsageMetadata

Usage metadata about response(s).

Summary

Public fields
`final Integer`	`candidatesTokenCount` Number of tokens in the response(s).
`final @NonNull List<@NonNull ModalityTokenCount>`	`candidatesTokensDetails` The breakdown, by modality, of how many tokens are consumed by the candidates.
`final int`	`promptTokenCount` Number of tokens in the request.
`final @NonNull List<@NonNull ModalityTokenCount>`	`promptTokensDetails` The breakdown, by modality, of how many tokens are consumed by the prompt.
`final int`	`thoughtsTokenCount` The number of tokens used by the model's internal "thinking" process.
`final int`	`toolUsePromptTokenCount` The number of tokens used by tools.
`final @NonNull List<@NonNull ModalityTokenCount>`	`toolUsePromptTokensDetails` The breakdown, by modality, of how many tokens are consumed by tools.
`final int`	`totalTokenCount` Total number of tokens.

Public constructors
`UsageMetadata( int promptTokenCount, Integer candidatesTokenCount, int totalTokenCount, @NonNull List<@NonNull ModalityTokenCount> promptTokensDetails, @NonNull List<@NonNull ModalityTokenCount> candidatesTokensDetails, int thoughtsTokenCount )` This method is deprecated. Not intended for public use

Public fields

candidatesTokenCount

public final Integer candidatesTokenCount

Number of tokens in the response(s).

candidatesTokensDetails

public final @NonNull List<@NonNull ModalityTokenCount> candidatesTokensDetails

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

promptTokenCount

public final int promptTokenCount

Number of tokens in the request.

promptTokensDetails

public final @NonNull List<@NonNull ModalityTokenCount> promptTokensDetails

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

thoughtsTokenCount

public final int thoughtsTokenCount

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

toolUsePromptTokenCount

public final int toolUsePromptTokenCount

The number of tokens used by tools.

toolUsePromptTokensDetails

public final @NonNull List<@NonNull ModalityTokenCount> toolUsePromptTokensDetails

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

totalTokenCount

public final int totalTokenCount

Total number of tokens.

Public constructors

UsageMetadata

public UsageMetadata(
    int promptTokenCount,
    Integer candidatesTokenCount,
    int totalTokenCount,
    @NonNull List<@NonNull ModalityTokenCount> promptTokensDetails,
    @NonNull List<@NonNull ModalityTokenCount> candidatesTokensDetails,
    int thoughtsTokenCount
)