com.google.cloud.aiplatform.v1

Interface UsageMetadataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UsageMetadata, UsageMetadata.Builder

@Generated
public interface UsageMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getCachedContentTokenCount() Output only.
ModalityTokenCount	getCacheTokensDetails(int index) Output only.
int	getCacheTokensDetailsCount() Output only.
List<ModalityTokenCount>	getCacheTokensDetailsList() Output only.
ModalityTokenCountOrBuilder	getCacheTokensDetailsOrBuilder(int index) Output only.
List<? extends ModalityTokenCountOrBuilder>	getCacheTokensDetailsOrBuilderList() Output only.
int	getCandidatesTokenCount() The total number of tokens in the generated candidates.
ModalityTokenCount	getCandidatesTokensDetails(int index) Output only.
int	getCandidatesTokensDetailsCount() Output only.
List<ModalityTokenCount>	getCandidatesTokensDetailsList() Output only.
ModalityTokenCountOrBuilder	getCandidatesTokensDetailsOrBuilder(int index) Output only.
List<? extends ModalityTokenCountOrBuilder>	getCandidatesTokensDetailsOrBuilderList() Output only.
int	getPromptTokenCount() The total number of tokens in the prompt.
ModalityTokenCount	getPromptTokensDetails(int index) Output only.
int	getPromptTokensDetailsCount() Output only.
List<ModalityTokenCount>	getPromptTokensDetailsList() Output only.
ModalityTokenCountOrBuilder	getPromptTokensDetailsOrBuilder(int index) Output only.
List<? extends ModalityTokenCountOrBuilder>	getPromptTokensDetailsOrBuilderList() Output only.
int	getThoughtsTokenCount() Output only.
int	getToolUsePromptTokenCount() Output only.
ModalityTokenCount	getToolUsePromptTokensDetails(int index) Output only.
int	getToolUsePromptTokensDetailsCount() Output only.
List<ModalityTokenCount>	getToolUsePromptTokensDetailsList() Output only.
ModalityTokenCountOrBuilder	getToolUsePromptTokensDetailsOrBuilder(int index) Output only.
List<? extends ModalityTokenCountOrBuilder>	getToolUsePromptTokensDetailsOrBuilderList() Output only.
int	getTotalTokenCount() The total number of tokens for the entire request.
UsageMetadata.TrafficType	getTrafficType() Output only.
int	getTrafficTypeValue() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getPromptTokenCount

int getPromptTokenCount()

 The total number of tokens in the prompt. This includes any text, images,
 or other media provided in the request. When `cached_content` is set,
 this also includes the number of tokens in the cached content.
 

int32 prompt_token_count = 1;

Returns:

The promptTokenCount.

getCandidatesTokenCount

int getCandidatesTokenCount()

 The total number of tokens in the generated candidates.
 

int32 candidates_token_count = 2;

Returns:

The candidatesTokenCount.

getTotalTokenCount

int getTotalTokenCount()

 The total number of tokens for the entire request. This is the sum of
 `prompt_token_count`, `candidates_token_count`,
 `tool_use_prompt_token_count`, and `thoughts_token_count`.
 

int32 total_token_count = 3;

Returns:

The totalTokenCount.

getToolUsePromptTokenCount

int getToolUsePromptTokenCount()

 Output only. The number of tokens in the results from tool executions,
 which are provided back to the model as input, if applicable.
 

int32 tool_use_prompt_token_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The toolUsePromptTokenCount.

getThoughtsTokenCount

int getThoughtsTokenCount()

 Output only. The number of tokens that were part of the model's generated
 "thoughts" output, if applicable.
 

int32 thoughts_token_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The thoughtsTokenCount.

getCachedContentTokenCount

int getCachedContentTokenCount()

 Output only. The number of tokens in the cached content that was used for
 this request.
 

int32 cached_content_token_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The cachedContentTokenCount.

getPromptTokensDetailsList

List<ModalityTokenCount> getPromptTokensDetailsList()

 Output only. A detailed breakdown of the token count for each modality in
 the prompt.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPromptTokensDetails

ModalityTokenCount getPromptTokensDetails(int index)

 Output only. A detailed breakdown of the token count for each modality in
 the prompt.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPromptTokensDetailsCount

int getPromptTokensDetailsCount()

 Output only. A detailed breakdown of the token count for each modality in
 the prompt.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPromptTokensDetailsOrBuilderList

List<? extends ModalityTokenCountOrBuilder> getPromptTokensDetailsOrBuilderList()

 Output only. A detailed breakdown of the token count for each modality in
 the prompt.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPromptTokensDetailsOrBuilder

ModalityTokenCountOrBuilder getPromptTokensDetailsOrBuilder(int index)

 Output only. A detailed breakdown of the token count for each modality in
 the prompt.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCacheTokensDetailsList

List<ModalityTokenCount> getCacheTokensDetailsList()

 Output only. A detailed breakdown of the token count for each modality in
 the cached content.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCacheTokensDetails

ModalityTokenCount getCacheTokensDetails(int index)

 Output only. A detailed breakdown of the token count for each modality in
 the cached content.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCacheTokensDetailsCount

int getCacheTokensDetailsCount()

 Output only. A detailed breakdown of the token count for each modality in
 the cached content.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCacheTokensDetailsOrBuilderList

List<? extends ModalityTokenCountOrBuilder> getCacheTokensDetailsOrBuilderList()

 Output only. A detailed breakdown of the token count for each modality in
 the cached content.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCacheTokensDetailsOrBuilder

ModalityTokenCountOrBuilder getCacheTokensDetailsOrBuilder(int index)

 Output only. A detailed breakdown of the token count for each modality in
 the cached content.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidatesTokensDetailsList

List<ModalityTokenCount> getCandidatesTokensDetailsList()

 Output only. A detailed breakdown of the token count for each modality in
 the generated candidates.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidatesTokensDetails

ModalityTokenCount getCandidatesTokensDetails(int index)

 Output only. A detailed breakdown of the token count for each modality in
 the generated candidates.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidatesTokensDetailsCount

int getCandidatesTokensDetailsCount()

 Output only. A detailed breakdown of the token count for each modality in
 the generated candidates.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidatesTokensDetailsOrBuilderList

List<? extends ModalityTokenCountOrBuilder> getCandidatesTokensDetailsOrBuilderList()

 Output only. A detailed breakdown of the token count for each modality in
 the generated candidates.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidatesTokensDetailsOrBuilder

ModalityTokenCountOrBuilder getCandidatesTokensDetailsOrBuilder(int index)

 Output only. A detailed breakdown of the token count for each modality in
 the generated candidates.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getToolUsePromptTokensDetailsList

List<ModalityTokenCount> getToolUsePromptTokensDetailsList()

 Output only. A detailed breakdown by modality of the token counts from the
 results of tool executions, which are provided back to the model as input.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getToolUsePromptTokensDetails

ModalityTokenCount getToolUsePromptTokensDetails(int index)

 Output only. A detailed breakdown by modality of the token counts from the
 results of tool executions, which are provided back to the model as input.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getToolUsePromptTokensDetailsCount

int getToolUsePromptTokensDetailsCount()

 Output only. A detailed breakdown by modality of the token counts from the
 results of tool executions, which are provided back to the model as input.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getToolUsePromptTokensDetailsOrBuilderList

List<? extends ModalityTokenCountOrBuilder> getToolUsePromptTokensDetailsOrBuilderList()

 Output only. A detailed breakdown by modality of the token counts from the
 results of tool executions, which are provided back to the model as input.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getToolUsePromptTokensDetailsOrBuilder

ModalityTokenCountOrBuilder getToolUsePromptTokensDetailsOrBuilder(int index)

 Output only. A detailed breakdown by modality of the token counts from the
 results of tool executions, which are provided back to the model as input.
 

repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getTrafficTypeValue

int getTrafficTypeValue()

 Output only. The traffic type for this request.
 

.google.cloud.aiplatform.v1.UsageMetadata.TrafficType traffic_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for trafficType.

getTrafficType

UsageMetadata.TrafficType getTrafficType()

 Output only. The traffic type for this request.
 

.google.cloud.aiplatform.v1.UsageMetadata.TrafficType traffic_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The trafficType.