UsageMetadata

class UsageMetadata


Usage metadata about response(s).

Summary

Public properties

List<ModalityTokenCount>
Int
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 properties

cacheTokensDetails

val cacheTokensDetails: List<ModalityTokenCount>

cachedContentTokenCount

val cachedContentTokenCount: Int

candidatesTokenCount

val candidatesTokenCount: Int?

Number of tokens in the response(s).

candidatesTokensDetails

val candidatesTokensDetails: List<ModalityTokenCount>

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

promptTokenCount

val promptTokenCount: Int

Number of tokens in the request.

promptTokensDetails

val promptTokensDetails: List<ModalityTokenCount>

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

thoughtsTokenCount

val thoughtsTokenCount: Int

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

toolUsePromptTokenCount

val toolUsePromptTokenCount: Int

The number of tokens used by tools.

toolUsePromptTokensDetails

val toolUsePromptTokensDetails: List<ModalityTokenCount>

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

totalTokenCount

val totalTokenCount: Int

Total number of tokens.