Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class UsageMetadata.
Usage metadata about response(s).
Generated from protobuf message google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata
Namespace
Google \ Cloud \ AIPlatform \ V1 \ GenerateContentResponse
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ prompt_token_count
int
Number of tokens in the request. When cached_content is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
↳ candidates_token_count
int
Number of tokens in the response(s).
↳ thoughts_token_count
int
Output only. Number of tokens present in thoughts output.
↳ total_token_count
int
Total token count for prompt and response candidates.
↳ cached_content_token_count
int
Output only. Number of tokens in the cached part in the input (the cached content).
Output only. List of modalities that were returned in the response.
getPromptTokenCount
Number of tokens in the request. When cached_content is set, this is
still the total effective prompt size meaning this includes the number of
tokens in the cached content.
Returns
Type
Description
int
setPromptTokenCount
Number of tokens in the request. When cached_content is set, this is
still the total effective prompt size meaning this includes the number of
tokens in the cached content.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getCandidatesTokenCount
Number of tokens in the response(s).
Returns
Type
Description
int
setCandidatesTokenCount
Number of tokens in the response(s).
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getThoughtsTokenCount
Output only. Number of tokens present in thoughts output.
Returns
Type
Description
int
setThoughtsTokenCount
Output only. Number of tokens present in thoughts output.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getTotalTokenCount
Total token count for prompt and response candidates.
Returns
Type
Description
int
setTotalTokenCount
Total token count for prompt and response candidates.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getCachedContentTokenCount
Output only. Number of tokens in the cached part in the input (the cached
content).
Returns
Type
Description
int
setCachedContentTokenCount
Output only. Number of tokens in the cached part in the input (the cached
content).
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPromptTokensDetails
Output only. List of modalities that were processed in the request input.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class UsageMetadata (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.GenerateContentResponse.UsageMetadata)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.GenerateContentResponse.UsageMetadata)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.GenerateContentResponse.UsageMetadata)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.GenerateContentResponse.UsageMetadata)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.GenerateContentResponse.UsageMetadata)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.GenerateContentResponse.UsageMetadata)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.GenerateContentResponse.UsageMetadata)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.GenerateContentResponse.UsageMetadata)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.GenerateContentResponse.UsageMetadata) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class UsageMetadata.\n\nUsage metadata about response(s).\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1 \\\\ GenerateContentResponse\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPromptTokenCount\n\nNumber of tokens in the request. When `cached_content` is set, this is\nstill the total effective prompt size meaning this includes the number of\ntokens in the cached content.\n\n### setPromptTokenCount\n\nNumber of tokens in the request. When `cached_content` is set, this is\nstill the total effective prompt size meaning this includes the number of\ntokens in the cached content.\n\n### getCandidatesTokenCount\n\nNumber of tokens in the response(s).\n\n### setCandidatesTokenCount\n\nNumber of tokens in the response(s).\n\n### getThoughtsTokenCount\n\nOutput only. Number of tokens present in thoughts output.\n\n### setThoughtsTokenCount\n\nOutput only. Number of tokens present in thoughts output.\n\n### getTotalTokenCount\n\nTotal token count for prompt and response candidates.\n\n### setTotalTokenCount\n\nTotal token count for prompt and response candidates.\n\n### getCachedContentTokenCount\n\nOutput only. Number of tokens in the cached part in the input (the cached\ncontent).\n\n### setCachedContentTokenCount\n\nOutput only. Number of tokens in the cached part in the input (the cached\ncontent).\n\n### getPromptTokensDetails\n\nOutput only. List of modalities that were processed in the request input.\n\n### setPromptTokensDetails\n\nOutput only. List of modalities that were processed in the request input.\n\n### getCacheTokensDetails\n\nOutput only. List of modalities of the cached content in the request\ninput.\n\n### setCacheTokensDetails\n\nOutput only. List of modalities of the cached content in the request\ninput.\n\n### getCandidatesTokensDetails\n\nOutput only. List of modalities that were returned in the response.\n\n### setCandidatesTokensDetails\n\nOutput only. List of modalities that were returned in the response."]]
