1717package com .google .api .services .firebaseml .v2beta .model ;
1818
1919/**
20- * Usage metadata about response(s).
20+ * Usage metadata about the content generation request and response. This message provides a
21+ * detailed breakdown of token usage and other relevant metrics.
2122 *
2223 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
2324 * transmitted over HTTP when working with the Firebase ML API. For a detailed explanation see:
3031public final class GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata extends com .google .api .client .json .GenericJson {
3132
3233 /**
33- * Output only. List of modalities of the cached content in the request input .
34+ * Output only. A detailed breakdown of the token count for each modality in the cached content .
3435 * The value may be {@code null}.
3536 */
3637 @ com .google .api .client .util .Key
3738 private java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > cacheTokensDetails ;
3839
3940 /**
40- * Output only. Number of tokens in the cached part in the input (the cached content) .
41+ * Output only. The number of tokens in the cached content that was used for this request .
4142 * The value may be {@code null}.
4243 */
4344 @ com .google .api .client .util .Key
4445 private java .lang .Integer cachedContentTokenCount ;
4546
4647 /**
47- * Number of tokens in the response(s) .
48+ * The total number of tokens in the generated candidates .
4849 * The value may be {@code null}.
4950 */
5051 @ com .google .api .client .util .Key
5152 private java .lang .Integer candidatesTokenCount ;
5253
5354 /**
54- * Output only. List of modalities that were returned in the response.
55+ * Output only. A detailed breakdown of the token count for each modality in the generated
56+ * candidates.
5557 * The value may be {@code null}.
5658 */
5759 @ com .google .api .client .util .Key
5860 private java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > candidatesTokensDetails ;
5961
6062 /**
61- * Number of tokens in the request. When `cached_content` is set, this is still the total
62- * effective prompt size meaning this includes the number of tokens in the cached content.
63+ * The total number of tokens in the prompt. This includes any text, images, or other media
64+ * provided in the request. When `cached_content` is set, this also includes the number of tokens
65+ * in the cached content.
6366 * The value may be {@code null}.
6467 */
6568 @ com .google .api .client .util .Key
6669 private java .lang .Integer promptTokenCount ;
6770
6871 /**
69- * Output only. List of modalities that were processed in the request input .
72+ * Output only. A detailed breakdown of the token count for each modality in the prompt .
7073 * The value may be {@code null}.
7174 */
7275 @ com .google .api .client .util .Key
7376 private java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > promptTokensDetails ;
7477
7578 /**
76- * Output only. Number of tokens present in thoughts output.
79+ * Output only. The number of tokens that were part of the model's generated "thoughts" output, if
80+ * applicable.
7781 * The value may be {@code null}.
7882 */
7983 @ com .google .api .client .util .Key
8084 private java .lang .Integer thoughtsTokenCount ;
8185
8286 /**
83- * Output only. Number of tokens present in tool-use prompt(s).
87+ * Output only. The number of tokens in the results from tool executions, which are provided back
88+ * to the model as input, if applicable.
8489 * The value may be {@code null}.
8590 */
8691 @ com .google .api .client .util .Key
8792 private java .lang .Integer toolUsePromptTokenCount ;
8893
8994 /**
90- * Output only. List of modalities that were processed for tool-use request inputs.
95+ * Output only. A detailed breakdown by modality of the token counts from the results of tool
96+ * executions, which are provided back to the model as input.
9197 * The value may be {@code null}.
9298 */
9399 @ com .google .api .client .util .Key
94100 private java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > toolUsePromptTokensDetails ;
95101
96102 /**
97- * Total token count for prompt, response candidates, and tool-use prompts (if present).
103+ * The total number of tokens for the entire request. This is the sum of `prompt_token_count`,
104+ * `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
98105 * The value may be {@code null}.
99106 */
100107 @ com .google .api .client .util .Key
101108 private java .lang .Integer totalTokenCount ;
102109
103110 /**
104- * Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned
105- * Throughput quota.
111+ * Output only. The traffic type for this request.
106112 * The value may be {@code null}.
107113 */
108114 @ com .google .api .client .util .Key
109115 private java .lang .String trafficType ;
110116
111117 /**
112- * Output only. List of modalities of the cached content in the request input .
118+ * Output only. A detailed breakdown of the token count for each modality in the cached content .
113119 * @return value or {@code null} for none
114120 */
115121 public java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > getCacheTokensDetails () {
116122 return cacheTokensDetails ;
117123 }
118124
119125 /**
120- * Output only. List of modalities of the cached content in the request input .
126+ * Output only. A detailed breakdown of the token count for each modality in the cached content .
121127 * @param cacheTokensDetails cacheTokensDetails or {@code null} for none
122128 */
123129 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setCacheTokensDetails (java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > cacheTokensDetails ) {
@@ -126,15 +132,15 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setCache
126132 }
127133
128134 /**
129- * Output only. Number of tokens in the cached part in the input (the cached content) .
135+ * Output only. The number of tokens in the cached content that was used for this request .
130136 * @return value or {@code null} for none
131137 */
132138 public java .lang .Integer getCachedContentTokenCount () {
133139 return cachedContentTokenCount ;
134140 }
135141
136142 /**
137- * Output only. Number of tokens in the cached part in the input (the cached content) .
143+ * Output only. The number of tokens in the cached content that was used for this request .
138144 * @param cachedContentTokenCount cachedContentTokenCount or {@code null} for none
139145 */
140146 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setCachedContentTokenCount (java .lang .Integer cachedContentTokenCount ) {
@@ -143,15 +149,15 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setCache
143149 }
144150
145151 /**
146- * Number of tokens in the response(s) .
152+ * The total number of tokens in the generated candidates .
147153 * @return value or {@code null} for none
148154 */
149155 public java .lang .Integer getCandidatesTokenCount () {
150156 return candidatesTokenCount ;
151157 }
152158
153159 /**
154- * Number of tokens in the response(s) .
160+ * The total number of tokens in the generated candidates .
155161 * @param candidatesTokenCount candidatesTokenCount or {@code null} for none
156162 */
157163 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setCandidatesTokenCount (java .lang .Integer candidatesTokenCount ) {
@@ -160,15 +166,17 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setCandi
160166 }
161167
162168 /**
163- * Output only. List of modalities that were returned in the response.
169+ * Output only. A detailed breakdown of the token count for each modality in the generated
170+ * candidates.
164171 * @return value or {@code null} for none
165172 */
166173 public java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > getCandidatesTokensDetails () {
167174 return candidatesTokensDetails ;
168175 }
169176
170177 /**
171- * Output only. List of modalities that were returned in the response.
178+ * Output only. A detailed breakdown of the token count for each modality in the generated
179+ * candidates.
172180 * @param candidatesTokensDetails candidatesTokensDetails or {@code null} for none
173181 */
174182 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setCandidatesTokensDetails (java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > candidatesTokensDetails ) {
@@ -177,17 +185,19 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setCandi
177185 }
178186
179187 /**
180- * Number of tokens in the request. When `cached_content` is set, this is still the total
181- * effective prompt size meaning this includes the number of tokens in the cached content.
188+ * The total number of tokens in the prompt. This includes any text, images, or other media
189+ * provided in the request. When `cached_content` is set, this also includes the number of tokens
190+ * in the cached content.
182191 * @return value or {@code null} for none
183192 */
184193 public java .lang .Integer getPromptTokenCount () {
185194 return promptTokenCount ;
186195 }
187196
188197 /**
189- * Number of tokens in the request. When `cached_content` is set, this is still the total
190- * effective prompt size meaning this includes the number of tokens in the cached content.
198+ * The total number of tokens in the prompt. This includes any text, images, or other media
199+ * provided in the request. When `cached_content` is set, this also includes the number of tokens
200+ * in the cached content.
191201 * @param promptTokenCount promptTokenCount or {@code null} for none
192202 */
193203 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setPromptTokenCount (java .lang .Integer promptTokenCount ) {
@@ -196,15 +206,15 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setPromp
196206 }
197207
198208 /**
199- * Output only. List of modalities that were processed in the request input .
209+ * Output only. A detailed breakdown of the token count for each modality in the prompt .
200210 * @return value or {@code null} for none
201211 */
202212 public java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > getPromptTokensDetails () {
203213 return promptTokensDetails ;
204214 }
205215
206216 /**
207- * Output only. List of modalities that were processed in the request input .
217+ * Output only. A detailed breakdown of the token count for each modality in the prompt .
208218 * @param promptTokensDetails promptTokensDetails or {@code null} for none
209219 */
210220 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setPromptTokensDetails (java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > promptTokensDetails ) {
@@ -213,15 +223,17 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setPromp
213223 }
214224
215225 /**
216- * Output only. Number of tokens present in thoughts output.
226+ * Output only. The number of tokens that were part of the model's generated "thoughts" output, if
227+ * applicable.
217228 * @return value or {@code null} for none
218229 */
219230 public java .lang .Integer getThoughtsTokenCount () {
220231 return thoughtsTokenCount ;
221232 }
222233
223234 /**
224- * Output only. Number of tokens present in thoughts output.
235+ * Output only. The number of tokens that were part of the model's generated "thoughts" output, if
236+ * applicable.
225237 * @param thoughtsTokenCount thoughtsTokenCount or {@code null} for none
226238 */
227239 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setThoughtsTokenCount (java .lang .Integer thoughtsTokenCount ) {
@@ -230,15 +242,17 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setThoug
230242 }
231243
232244 /**
233- * Output only. Number of tokens present in tool-use prompt(s).
245+ * Output only. The number of tokens in the results from tool executions, which are provided back
246+ * to the model as input, if applicable.
234247 * @return value or {@code null} for none
235248 */
236249 public java .lang .Integer getToolUsePromptTokenCount () {
237250 return toolUsePromptTokenCount ;
238251 }
239252
240253 /**
241- * Output only. Number of tokens present in tool-use prompt(s).
254+ * Output only. The number of tokens in the results from tool executions, which are provided back
255+ * to the model as input, if applicable.
242256 * @param toolUsePromptTokenCount toolUsePromptTokenCount or {@code null} for none
243257 */
244258 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setToolUsePromptTokenCount (java .lang .Integer toolUsePromptTokenCount ) {
@@ -247,15 +261,17 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setToolU
247261 }
248262
249263 /**
250- * Output only. List of modalities that were processed for tool-use request inputs.
264+ * Output only. A detailed breakdown by modality of the token counts from the results of tool
265+ * executions, which are provided back to the model as input.
251266 * @return value or {@code null} for none
252267 */
253268 public java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > getToolUsePromptTokensDetails () {
254269 return toolUsePromptTokensDetails ;
255270 }
256271
257272 /**
258- * Output only. List of modalities that were processed for tool-use request inputs.
273+ * Output only. A detailed breakdown by modality of the token counts from the results of tool
274+ * executions, which are provided back to the model as input.
259275 * @param toolUsePromptTokensDetails toolUsePromptTokensDetails or {@code null} for none
260276 */
261277 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setToolUsePromptTokensDetails (java .util .List <GoogleCloudAiplatformV1beta1ModalityTokenCount > toolUsePromptTokensDetails ) {
@@ -264,15 +280,17 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setToolU
264280 }
265281
266282 /**
267- * Total token count for prompt, response candidates, and tool-use prompts (if present).
283+ * The total number of tokens for the entire request. This is the sum of `prompt_token_count`,
284+ * `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
268285 * @return value or {@code null} for none
269286 */
270287 public java .lang .Integer getTotalTokenCount () {
271288 return totalTokenCount ;
272289 }
273290
274291 /**
275- * Total token count for prompt, response candidates, and tool-use prompts (if present).
292+ * The total number of tokens for the entire request. This is the sum of `prompt_token_count`,
293+ * `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
276294 * @param totalTokenCount totalTokenCount or {@code null} for none
277295 */
278296 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setTotalTokenCount (java .lang .Integer totalTokenCount ) {
@@ -281,17 +299,15 @@ public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setTotal
281299 }
282300
283301 /**
284- * Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned
285- * Throughput quota.
302+ * Output only. The traffic type for this request.
286303 * @return value or {@code null} for none
287304 */
288305 public java .lang .String getTrafficType () {
289306 return trafficType ;
290307 }
291308
292309 /**
293- * Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned
294- * Throughput quota.
310+ * Output only. The traffic type for this request.
295311 * @param trafficType trafficType or {@code null} for none
296312 */
297313 public GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata setTrafficType (java .lang .String trafficType ) {
0 commit comments