Interface UsageMetadata

Usage metadata about response(s).

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

Properties

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

Properties

OptionalcachedContentTokenCount

cachedContentTokenCount?: number

Number of tokens in the cached part of the prompt (the cached content).

OptionalcacheTokensDetails

cacheTokensDetails?: ModalityTokenCount[]

List of modalities that were processed in the cache input.

OptionalpromptTokenCount

promptTokenCount?: number

Number of tokens in the prompt. When cached_content is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.

OptionalpromptTokensDetails

promptTokensDetails?: ModalityTokenCount[]

List of modalities that were processed in the request input.

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.

OptionalthoughtsTokenCount

thoughtsTokenCount?: number

Number of tokens of thoughts for thinking models.

OptionaltoolUsePromptTokenCount

toolUsePromptTokenCount?: number

Number of tokens present in tool-use prompt(s).

OptionaltoolUsePromptTokensDetails

toolUsePromptTokensDetails?: ModalityTokenCount[]

List of modalities that were processed in the tool-use prompt.

OptionaltotalTokenCount

totalTokenCount?: number

Total token count for prompt, response candidates, and tool-use prompts(if present).

OptionaltrafficType

trafficType?: TrafficType

Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.

Settings

On This Page

Properties