UsageMetadata interface
Stay organized with collections
Save and categorize content based on your preferences.
Usage metadata about a GenerateContentResponse.
Signature:
export interface UsageMetadata
Properties
Signature:
candidatesTokenCount: number;
Signature:
candidatesTokensDetails?: ModalityTokenCount[];
Signature:
promptTokenCount: number;
Signature:
promptTokensDetails?: ModalityTokenCount[];
The number of tokens used by the model's internal "thinking" process.
Signature:
thoughtsTokenCount?: number;
Signature:
totalTokenCount: number;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-17 UTC.
[null,null,["Last updated 2025-07-17 UTC."],[],[],null,["Usage metadata about a [GenerateContentResponse](./ai.generatecontentresponse.md#generatecontentresponse_interface).\n\n**Signature:** \n\n export interface UsageMetadata \n\nProperties\n\n| Property | Type | Description |\n|---------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------|\n| [candidatesTokenCount](./ai.usagemetadata.md#usagemetadatacandidatestokencount) | number | |\n| [candidatesTokensDetails](./ai.usagemetadata.md#usagemetadatacandidatestokensdetails) | [ModalityTokenCount](./ai.modalitytokencount.md#modalitytokencount_interface)\\[\\] | |\n| [promptTokenCount](./ai.usagemetadata.md#usagemetadataprompttokencount) | number | |\n| [promptTokensDetails](./ai.usagemetadata.md#usagemetadataprompttokensdetails) | [ModalityTokenCount](./ai.modalitytokencount.md#modalitytokencount_interface)\\[\\] | |\n| [thoughtsTokenCount](./ai.usagemetadata.md#usagemetadatathoughtstokencount) | number | The number of tokens used by the model's internal \"thinking\" process. |\n| [totalTokenCount](./ai.usagemetadata.md#usagemetadatatotaltokencount) | number | |\n\nUsageMetadata.candidatesTokenCount\n\n**Signature:** \n\n candidatesTokenCount: number;\n\nUsageMetadata.candidatesTokensDetails\n\n**Signature:** \n\n candidatesTokensDetails?: ModalityTokenCount[];\n\nUsageMetadata.promptTokenCount\n\n**Signature:** \n\n promptTokenCount: number;\n\nUsageMetadata.promptTokensDetails\n\n**Signature:** \n\n promptTokensDetails?: ModalityTokenCount[];\n\nUsageMetadata.thoughtsTokenCount\n\nThe number of tokens used by the model's internal \"thinking\" process.\n\n**Signature:** \n\n thoughtsTokenCount?: number;\n\nUsageMetadata.totalTokenCount\n\n**Signature:** \n\n totalTokenCount: number;"]]