Interface GenerateContentResponse.UsageMetadataOrBuilder (3.88.0)

Version latest

• 3.88.0 (latest)
• 3.86.0
• 3.84.0
• 3.83.0
• 3.82.0
• 3.81.0
• 3.79.0
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 3.71.0
• 3.69.0
• 3.68.0
• 3.65.0
• 3.64.0
• 3.63.0
• 3.61.0
• 3.60.0
• 3.59.0
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static interface GenerateContentResponse.UsageMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCacheTokensDetails(int index)

public abstract ModalityTokenCount getCacheTokensDetails(int index)

Output only. List of modalities of the cached content in the request input.

repeated .google.cloud.aiplatform.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. List of modalities of the cached content in the request input.

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

Returns
Type	Description
int

getCacheTokensDetailsList()

public abstract List<ModalityTokenCount> getCacheTokensDetailsList()

Output only. List of modalities of the cached content in the request input.

repeated .google.cloud.aiplatform.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. List of modalities of the cached content in the request input.

repeated .google.cloud.aiplatform.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. List of modalities of the cached content in the request input.

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

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.ModalityTokenCountOrBuilder>

getCachedContentTokenCount()

public abstract int getCachedContentTokenCount()

Output only. Number of tokens in the cached part in the input (the cached content).

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

Returns
Type	Description
int	The cachedContentTokenCount.

getCandidatesTokenCount()

public abstract int getCandidatesTokenCount()

Number of tokens in the response(s).

int32 candidates_token_count = 2;

Returns
Type	Description
int	The candidatesTokenCount.

getCandidatesTokensDetails(int index)

public abstract ModalityTokenCount getCandidatesTokensDetails(int index)

Output only. List of modalities that were returned in the response.

repeated .google.cloud.aiplatform.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. List of modalities that were returned in the response.

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

Returns
Type	Description
int

getCandidatesTokensDetailsList()

public abstract List<ModalityTokenCount> getCandidatesTokensDetailsList()

Output only. List of modalities that were returned in the response.

repeated .google.cloud.aiplatform.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. List of modalities that were returned in the response.

repeated .google.cloud.aiplatform.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. List of modalities that were returned in the response.

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

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.ModalityTokenCountOrBuilder>

getPromptTokenCount()

public abstract int 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.

int32 prompt_token_count = 1;

Returns
Type	Description
int	The promptTokenCount.

getPromptTokensDetails(int index)

public abstract ModalityTokenCount getPromptTokensDetails(int index)

Output only. List of modalities that were processed in the request input.

repeated .google.cloud.aiplatform.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. List of modalities that were processed in the request input.

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

Returns
Type	Description
int

getPromptTokensDetailsList()

public abstract List<ModalityTokenCount> getPromptTokensDetailsList()

Output only. List of modalities that were processed in the request input.

repeated .google.cloud.aiplatform.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. List of modalities that were processed in the request input.

repeated .google.cloud.aiplatform.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. List of modalities that were processed in the request input.

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

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.ModalityTokenCountOrBuilder>

getThoughtsTokenCount()

public abstract int getThoughtsTokenCount()

Output only. Number of tokens present in thoughts output.

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

Returns
Type	Description
int	The thoughtsTokenCount.

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

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.ModalityTokenCountOrBuilder>

getTotalTokenCount()

public abstract int getTotalTokenCount()

Total token count for prompt and response candidates.

int32 total_token_count = 3;

Returns
Type	Description
int	The totalTokenCount.

getTrafficType()

public abstract GenerateContentResponse.UsageMetadata.TrafficType getTrafficType()

Output only. The traffic type for this request.

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

Returns
Type	Description
GenerateContentResponse.UsageMetadata.TrafficType	The trafficType.

getTrafficTypeValue()

public abstract int getTrafficTypeValue()

Output only. The traffic type for this request.

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

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