google-genai-kotlin/com.google.genai.kotlin.types/UsageMetadata

UsageMetadata

@Serializable

data class UsageMetadata(val promptTokenCount: Int? = null, val cachedContentTokenCount: Int? = null, val responseTokenCount: Int? = null, val toolUsePromptTokenCount: Int? = null, val thoughtsTokenCount: Int? = null, val totalTokenCount: Int? = null, val promptTokensDetails: List<ModalityTokenCount>? = null, val cacheTokensDetails: List<ModalityTokenCount>? = null, val responseTokensDetails: List<ModalityTokenCount>? = null, val toolUsePromptTokensDetails: List<ModalityTokenCount>? = null, val trafficType: TrafficType? = null, val serviceTier: ServiceTier? = null)

Usage metadata about response(s).

Constructors

UsageMetadata

constructor(promptTokenCount: Int? = null, cachedContentTokenCount: Int? = null, responseTokenCount: Int? = null, toolUsePromptTokenCount: Int? = null, thoughtsTokenCount: Int? = null, totalTokenCount: Int? = null, promptTokensDetails: List<ModalityTokenCount>? = null, cacheTokensDetails: List<ModalityTokenCount>? = null, responseTokensDetails: List<ModalityTokenCount>? = null, toolUsePromptTokensDetails: List<ModalityTokenCount>? = null, trafficType: TrafficType? = null, serviceTier: ServiceTier? = null)

Properties

cachedContentTokenCount

val cachedContentTokenCount: Int? = null

Output only. The number of tokens in the cached content that was used for this request.

cacheTokensDetails

val cacheTokensDetails: List<ModalityTokenCount>? = null

Output only. A detailed breakdown of the token count for each modality in the cached content.

promptTokenCount

val promptTokenCount: Int? = null

The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When cached_content is set, this also includes the number of tokens in the cached content.

promptTokensDetails

val promptTokensDetails: List<ModalityTokenCount>? = null

Output only. A detailed breakdown of the token count for each modality in the prompt.

responseTokenCount

val responseTokenCount: Int? = null

Total number of tokens across all the generated response candidates.

responseTokensDetails

val responseTokensDetails: List<ModalityTokenCount>? = null

List of modalities that were returned in the response.

serviceTier

val serviceTier: ServiceTier? = null

Output only. Service tier of the request. This field is not supported in Vertex AI.

thoughtsTokenCount

val thoughtsTokenCount: Int? = null

Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.

toolUsePromptTokenCount

val toolUsePromptTokenCount: Int? = null

Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.

toolUsePromptTokensDetails

val toolUsePromptTokensDetails: List<ModalityTokenCount>? = null

Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.

totalTokenCount

val totalTokenCount: Int? = null

The total number of tokens for the entire request. This is the sum of prompt_token_count, candidates_token_count, tool_use_prompt_token_count, and thoughts_token_count.

trafficType

val trafficType: TrafficType? = null

Output only. The traffic type for this request. This field is not supported in Gemini API.