Interface UsageMetadataOrBuilder (1.43.0)

Version latest

• 1.43.0 (latest)
• 1.42.0
• 1.40.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface UsageMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCacheTokensDetails(int index)

public abstract ModalityTokenCount getCacheTokensDetails(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
ModalityTokenCount

getCacheTokensDetailsCount()

public abstract int getCacheTokensDetailsCount()

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

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

Returns
Type	Description
int

getCacheTokensDetailsList()

public abstract List<ModalityTokenCount> getCacheTokensDetailsList()

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

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

Returns
Type	Description
List<ModalityTokenCount>

getCacheTokensDetailsOrBuilder(int index)

public abstract ModalityTokenCountOrBuilder getCacheTokensDetailsOrBuilder(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
ModalityTokenCountOrBuilder

getCacheTokensDetailsOrBuilderList()

public abstract List<? extends ModalityTokenCountOrBuilder> getCacheTokensDetailsOrBuilderList()

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

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

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.ModalityTokenCountOrBuilder>

getCachedContentTokenCount()

public abstract 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
Type	Description
int	The cachedContentTokenCount.

getCandidatesTokenCount()

public abstract int getCandidatesTokenCount()

The total number of tokens in the generated candidates.

int32 candidates_token_count = 2;

Returns
Type	Description
int	The candidatesTokenCount.

getCandidatesTokensDetails(int index)

public abstract ModalityTokenCount getCandidatesTokensDetails(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
ModalityTokenCount

getCandidatesTokensDetailsCount()

public abstract int getCandidatesTokensDetailsCount()

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

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

Returns
Type	Description
int

getCandidatesTokensDetailsList()

public abstract List<ModalityTokenCount> getCandidatesTokensDetailsList()

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

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

Returns
Type	Description
List<ModalityTokenCount>

getCandidatesTokensDetailsOrBuilder(int index)

public abstract ModalityTokenCountOrBuilder getCandidatesTokensDetailsOrBuilder(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
ModalityTokenCountOrBuilder

getCandidatesTokensDetailsOrBuilderList()

public abstract List<? extends ModalityTokenCountOrBuilder> getCandidatesTokensDetailsOrBuilderList()

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

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

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.ModalityTokenCountOrBuilder>

getPromptTokenCount()

public abstract 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
Type	Description
int	The promptTokenCount.

getPromptTokensDetails(int index)

public abstract ModalityTokenCount getPromptTokensDetails(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
ModalityTokenCount

getPromptTokensDetailsCount()

public abstract int getPromptTokensDetailsCount()

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

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

Returns
Type	Description
int

getPromptTokensDetailsList()

public abstract List<ModalityTokenCount> getPromptTokensDetailsList()

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

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

Returns
Type	Description
List<ModalityTokenCount>

getPromptTokensDetailsOrBuilder(int index)

public abstract ModalityTokenCountOrBuilder getPromptTokensDetailsOrBuilder(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
ModalityTokenCountOrBuilder

getPromptTokensDetailsOrBuilderList()

public abstract List<? extends ModalityTokenCountOrBuilder> getPromptTokensDetailsOrBuilderList()

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

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

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.ModalityTokenCountOrBuilder>

getThoughtsTokenCount()

public abstract 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
Type	Description
int	The thoughtsTokenCount.

getToolUsePromptTokenCount()

public abstract 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
Type	Description
int	The toolUsePromptTokenCount.

getToolUsePromptTokensDetails(int index)

public abstract 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.vertexai.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
ModalityTokenCount

getToolUsePromptTokensDetailsCount()

public abstract 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.vertexai.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getToolUsePromptTokensDetailsList()

public abstract 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.vertexai.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<ModalityTokenCount>

getToolUsePromptTokensDetailsOrBuilder(int index)

public abstract 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.vertexai.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
ModalityTokenCountOrBuilder

getToolUsePromptTokensDetailsOrBuilderList()

public abstract 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.vertexai.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.ModalityTokenCountOrBuilder>

getTotalTokenCount()

public abstract 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
Type	Description
int	The totalTokenCount.

getTrafficType()

public abstract UsageMetadata.TrafficType getTrafficType()

Output only. The traffic type for this request.

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

Returns
Type	Description
UsageMetadata.TrafficType	The trafficType.

getTrafficTypeValue()

public abstract int getTrafficTypeValue()

Output only. The traffic type for this request.

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

Returns
Type	Description
int	The enum numeric value on the wire for trafficType.