Interface UsageMetadata

Usage metadata about response(s).

interface UsageMetadata {
    cachedContentTokenCount?: number;
    cacheTokensDetails?: ModalityTokenCount[];
    promptTokenCount?: number;
    promptTokensDetails?: ModalityTokenCount[];
    responseTokenCount?: number;
    responseTokensDetails?: ModalityTokenCount[];
    serviceTier?: ServiceTier;
    thoughtsTokenCount?: number;
    toolUsePromptTokenCount?: number;
    toolUsePromptTokensDetails?: ModalityTokenCount[];
    totalTokenCount?: number;
    trafficType?: TrafficType;
}

Properties

cachedContentTokenCount? cacheTokensDetails? promptTokenCount? promptTokensDetails? responseTokenCount? responseTokensDetails? serviceTier? thoughtsTokenCount? toolUsePromptTokenCount? toolUsePromptTokensDetails? totalTokenCount? trafficType?

Properties

OptionalcachedContentTokenCount

cachedContentTokenCount?: number

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

OptionalcacheTokensDetails

cacheTokensDetails?: ModalityTokenCount[]

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

OptionalpromptTokenCount

promptTokenCount?: number

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.

OptionalpromptTokensDetails

promptTokensDetails?: ModalityTokenCount[]

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

OptionalresponseTokenCount

responseTokenCount?: number

Total number of tokens across all the generated response candidates.

OptionalresponseTokensDetails

responseTokensDetails?: ModalityTokenCount[]

List of modalities that were returned in the response.

OptionalserviceTier

serviceTier?: ServiceTier

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

OptionalthoughtsTokenCount

thoughtsTokenCount?: number

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

OptionaltoolUsePromptTokenCount

toolUsePromptTokenCount?: number

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

OptionaltoolUsePromptTokensDetails

toolUsePromptTokensDetails?: ModalityTokenCount[]

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.

OptionaltotalTokenCount

totalTokenCount?: number

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.

OptionaltrafficType

trafficType?: TrafficType

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

Settings

On This Page

Properties