public static final class GenerateContentResponse.UsageMetadata extends GeneratedMessage implements GenerateContentResponse.UsageMetadataOrBuilder
Usage metadata about response(s).
Protobuf type google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
CACHED_CONTENT_TOKEN_COUNT_FIELD_NUMBER
public static final int CACHED_CONTENT_TOKEN_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CACHE_TOKENS_DETAILS_FIELD_NUMBER
public static final int CACHE_TOKENS_DETAILS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CANDIDATES_TOKENS_DETAILS_FIELD_NUMBER
public static final int CANDIDATES_TOKENS_DETAILS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CANDIDATES_TOKEN_COUNT_FIELD_NUMBER
public static final int CANDIDATES_TOKEN_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROMPT_TOKENS_DETAILS_FIELD_NUMBER
public static final int PROMPT_TOKENS_DETAILS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROMPT_TOKEN_COUNT_FIELD_NUMBER
public static final int PROMPT_TOKEN_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
THOUGHTS_TOKEN_COUNT_FIELD_NUMBER
public static final int THOUGHTS_TOKEN_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOOL_USE_PROMPT_TOKENS_DETAILS_FIELD_NUMBER
public static final int TOOL_USE_PROMPT_TOKENS_DETAILS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOTAL_TOKEN_COUNT_FIELD_NUMBER
public static final int TOTAL_TOKEN_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRAFFIC_TYPE_FIELD_NUMBER
public static final int TRAFFIC_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static GenerateContentResponse.UsageMetadata getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GenerateContentResponse.UsageMetadata.Builder newBuilder()
newBuilder(GenerateContentResponse.UsageMetadata prototype)
public static GenerateContentResponse.UsageMetadata.Builder newBuilder(GenerateContentResponse.UsageMetadata prototype)
parseDelimitedFrom(InputStream input)
public static GenerateContentResponse.UsageMetadata parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse.UsageMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GenerateContentResponse.UsageMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse.UsageMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GenerateContentResponse.UsageMetadata parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse.UsageMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static GenerateContentResponse.UsageMetadata parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse.UsageMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static GenerateContentResponse.UsageMetadata parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse.UsageMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GenerateContentResponse.UsageMetadata parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse.UsageMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GenerateContentResponse.UsageMetadata> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCacheTokensDetails(int index)
public 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
|
getCacheTokensDetailsCount()
public 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 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];
getCacheTokensDetailsOrBuilder(int index)
public 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
|
getCacheTokensDetailsOrBuilderList()
public 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 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 int getCandidatesTokenCount()
Number of tokens in the response(s).
int32 candidates_token_count = 2;
| Returns |
| Type |
Description |
int |
The candidatesTokenCount.
|
getCandidatesTokensDetails(int index)
public 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
|
getCandidatesTokensDetailsCount()
public 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 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];
getCandidatesTokensDetailsOrBuilder(int index)
public 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
|
getCandidatesTokensDetailsOrBuilderList()
public 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> |
|
getDefaultInstanceForType()
public GenerateContentResponse.UsageMetadata getDefaultInstanceForType()
getParserForType()
public Parser<GenerateContentResponse.UsageMetadata> getParserForType()
Overrides
getPromptTokenCount()
public 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 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
|
getPromptTokensDetailsCount()
public 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 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];
getPromptTokensDetailsOrBuilder(int index)
public 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
|
getPromptTokensDetailsOrBuilderList()
public 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> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getThoughtsTokenCount()
public 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 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
|
getToolUsePromptTokensDetailsCount()
public 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 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];
getToolUsePromptTokensDetailsOrBuilder(int index)
public 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
|
getToolUsePromptTokensDetailsOrBuilderList()
public 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 int getTotalTokenCount()
Total token count for prompt and response candidates.
int32 total_token_count = 3;
| Returns |
| Type |
Description |
int |
The totalTokenCount.
|
getTrafficType()
public 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];
getTrafficTypeValue()
public 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GenerateContentResponse.UsageMetadata.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected GenerateContentResponse.UsageMetadata.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public GenerateContentResponse.UsageMetadata.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
