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 \ GenerateContentResponseMethods
__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 |
↳ candidates_token_count |
int
Number of tokens in the response(s). |
↳ 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). |
↳ prompt_tokens_details |
array<Google\Cloud\AIPlatform\V1\ModalityTokenCount>
Output only. List of modalities that were processed in the request input. |
↳ cache_tokens_details |
array<Google\Cloud\AIPlatform\V1\ModalityTokenCount>
Output only. List of modalities of the cached content in the request input. |
↳ candidates_tokens_details |
array<Google\Cloud\AIPlatform\V1\ModalityTokenCount>
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 |
|
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPromptTokensDetails
Output only. List of modalities that were processed in the request input.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\ModalityTokenCount>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCacheTokensDetails
Output only. List of modalities of the cached content in the request input.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCacheTokensDetails
Output only. List of modalities of the cached content in the request input.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\ModalityTokenCount>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCandidatesTokensDetails
Output only. List of modalities that were returned in the response.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCandidatesTokensDetails
Output only. List of modalities that were returned in the response.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\ModalityTokenCount>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|