Usage metadata about a GenerateContentResponse.
Signature:
export interface UsageMetadata
Properties
| Property | Type | Description |
|---|---|---|
| candidatesTokenCount | number | |
| candidatesTokensDetails | ModalityTokenCount[] | |
| promptTokenCount | number | |
| promptTokensDetails | ModalityTokenCount[] | |
| thoughtsTokenCount | number | The number of tokens used by the model's internal "thinking" process. |
| toolUsePromptTokenCount | number | The number of tokens used by tools. |
| toolUsePromptTokensDetails | ModalityTokenCount[] | A list of tokens used by tools, broken down by modality. |
| totalTokenCount | number |
UsageMetadata.candidatesTokenCount
Signature:
candidatesTokenCount: number;
UsageMetadata.candidatesTokensDetails
Signature:
candidatesTokensDetails?: ModalityTokenCount[];
UsageMetadata.promptTokenCount
Signature:
promptTokenCount: number;
UsageMetadata.promptTokensDetails
Signature:
promptTokensDetails?: ModalityTokenCount[];
UsageMetadata.thoughtsTokenCount
The number of tokens used by the model's internal "thinking" process.
Signature:
thoughtsTokenCount?: number;
UsageMetadata.toolUsePromptTokenCount
The number of tokens used by tools.
Signature:
toolUsePromptTokenCount?: number;
UsageMetadata.toolUsePromptTokensDetails
A list of tokens used by tools, broken down by modality.
Signature:
toolUsePromptTokensDetails?: ModalityTokenCount[];
UsageMetadata.totalTokenCount
Signature:
totalTokenCount: number;