blob: f4e6464e008febdd8c6ed394dac93aa7741a009e [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="firebaseml_v1beta2.html">Firebase ML API</a> . <a href="firebaseml_v1beta2.projects.html">projects</a> . <a href="firebaseml_v1beta2.projects.models.html">models</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a model in Firebase ML.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a model</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a model resource.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists the models</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates a model. The longrunning operation will eventually return a Model.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
98 <pre>Creates a model in Firebase ML.
99The longrunning operation will eventually return a Model
100
101Args:
102 parent: string, Required. The parent project resource where the model is to be created.
103The parent must have the form `projects/{project_id}` (required)
104 body: object, The request body.
105 The object takes the form of:
106
107{ # An ML model hosted in Firebase ML
108 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Model.
109 # Model names have the form `projects/{project_id}/models/{model_id}`
110 # The name is ignored when creating a model.
111 &quot;modelHash&quot;: &quot;A String&quot;, # Output only. The model_hash will change if a new file is available for download.
112 &quot;tags&quot;: [ # User defined tags which can be used to group/filter models during listing
113 &quot;A String&quot;,
114 ],
115 &quot;tfliteModel&quot;: { # Information that is specific to TfLite models. # A TFLite Model
116 &quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the TFLite model
117 &quot;gcsTfliteUri&quot;: &quot;A String&quot;, # The TfLite file containing the model. (Stored in Google Cloud).
118 # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
119 # Note: If you update the file in the original location, it is
120 # necessary to call UpdateModel for ML to pick up and validate the
121 # updated file.
122 },
123 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the model to create. The name can be up to 32 characters long
124 # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)
125 # and ASCII digits 0-9. It must start with a letter.
126 &quot;etag&quot;: &quot;A String&quot;, # Output only. See RFC7232
127 # https://tools.ietf.org/html/rfc7232#section-2.3
128 &quot;activeOperations&quot;: [ # Output only. Lists operation ids associated with this model whose status is NOT done.
129 { # This resource represents a long-running operation that is the result of a
130 # network API call.
131 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
132 # method returns no data on success, such as `Delete`, the response is
133 # `google.protobuf.Empty`. If the original method is standard
134 # `Get`/`Create`/`Update`, the response should be the resource. For other
135 # methods, the response should have the type `XxxResponse`, where `Xxx`
136 # is the original method name. For example, if the original method name
137 # is `TakeSnapshot()`, the inferred response type is
138 # `TakeSnapshotResponse`.
139 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
140 },
141 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
142 # originally returns it. If you use the default HTTP mapping, the
143 # `name` should be a resource name ending with `operations/{unique_id}`.
144 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
145 # different programming environments, including REST APIs and RPC APIs. It is
146 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
147 # three pieces of data: error code, error message, and error details.
148 #
149 # You can find out more about this error model and how to work with it in the
150 # [API Design Guide](https://cloud.google.com/apis/design/errors).
151 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
152 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
153 # user-facing error message should be localized and sent in the
154 # google.rpc.Status.details field, or localized by the client.
155 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
156 # message types for APIs to use.
157 {
158 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
159 },
160 ],
161 },
162 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
163 # contains progress information and common metadata such as create time.
164 # Some services might not provide such metadata. Any method that returns a
165 # long-running operation should document the metadata type, if any.
166 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
167 },
168 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
169 # If `true`, the operation is completed, and either `error` or `response` is
170 # available.
171 },
172 ],
173 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this model was created in Firebase ML.
174 &quot;state&quot;: { # State common to all model types. # State common to all model types.
175 # Includes publishing and validation information.
176 # Includes publishing and validation information.
177 &quot;published&quot;: True or False, # Indicates if this model has been published.
178 &quot;validationError&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.
179 # A model may have validation errors if there were problems during
180 # the model creation/update.
181 # e.g. in the case of a TfLiteModel, if a tflite model file was
182 # missing or in the wrong format.
183 # This field will be empty for valid models.
184 # different programming environments, including REST APIs and RPC APIs. It is
185 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
186 # three pieces of data: error code, error message, and error details.
187 #
188 # You can find out more about this error model and how to work with it in the
189 # [API Design Guide](https://cloud.google.com/apis/design/errors).
190 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
191 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
192 # user-facing error message should be localized and sent in the
193 # google.rpc.Status.details field, or localized by the client.
194 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
195 # message types for APIs to use.
196 {
197 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
198 },
199 ],
200 },
201 },
202 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this model was updated in Firebase ML.
203 }
204
205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210Returns:
211 An object of the form:
212
213 { # This resource represents a long-running operation that is the result of a
214 # network API call.
215 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
216 # method returns no data on success, such as `Delete`, the response is
217 # `google.protobuf.Empty`. If the original method is standard
218 # `Get`/`Create`/`Update`, the response should be the resource. For other
219 # methods, the response should have the type `XxxResponse`, where `Xxx`
220 # is the original method name. For example, if the original method name
221 # is `TakeSnapshot()`, the inferred response type is
222 # `TakeSnapshotResponse`.
223 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
224 },
225 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
226 # originally returns it. If you use the default HTTP mapping, the
227 # `name` should be a resource name ending with `operations/{unique_id}`.
228 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
229 # different programming environments, including REST APIs and RPC APIs. It is
230 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
231 # three pieces of data: error code, error message, and error details.
232 #
233 # You can find out more about this error model and how to work with it in the
234 # [API Design Guide](https://cloud.google.com/apis/design/errors).
235 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
236 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
237 # user-facing error message should be localized and sent in the
238 # google.rpc.Status.details field, or localized by the client.
239 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
240 # message types for APIs to use.
241 {
242 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
243 },
244 ],
245 },
246 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
247 # contains progress information and common metadata such as create time.
248 # Some services might not provide such metadata. Any method that returns a
249 # long-running operation should document the metadata type, if any.
250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
251 },
252 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
253 # If `true`, the operation is completed, and either `error` or `response` is
254 # available.
255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
260 <pre>Deletes a model
261
262Args:
263 name: string, Required. The name of the model to delete.
264The name must have the form `projects/{project_id}/models/{model_id}` (required)
265 x__xgafv: string, V1 error format.
266 Allowed values
267 1 - v1 error format
268 2 - v2 error format
269
270Returns:
271 An object of the form:
272
273 { # A generic empty message that you can re-use to avoid defining duplicated
274 # empty messages in your APIs. A typical example is to use it as the request
275 # or the response type of an API method. For instance:
276 #
277 # service Foo {
278 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
279 # }
280 #
281 # The JSON representation for `Empty` is empty JSON object `{}`.
282 }</pre>
283</div>
284
285<div class="method">
286 <code class="details" id="get">get(name, x__xgafv=None)</code>
287 <pre>Gets a model resource.
288
289Args:
290 name: string, Required. The name of the model to get.
291The name must have the form `projects/{project_id}/models/{model_id}` (required)
292 x__xgafv: string, V1 error format.
293 Allowed values
294 1 - v1 error format
295 2 - v2 error format
296
297Returns:
298 An object of the form:
299
300 { # An ML model hosted in Firebase ML
301 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Model.
302 # Model names have the form `projects/{project_id}/models/{model_id}`
303 # The name is ignored when creating a model.
304 &quot;modelHash&quot;: &quot;A String&quot;, # Output only. The model_hash will change if a new file is available for download.
305 &quot;tags&quot;: [ # User defined tags which can be used to group/filter models during listing
306 &quot;A String&quot;,
307 ],
308 &quot;tfliteModel&quot;: { # Information that is specific to TfLite models. # A TFLite Model
309 &quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the TFLite model
310 &quot;gcsTfliteUri&quot;: &quot;A String&quot;, # The TfLite file containing the model. (Stored in Google Cloud).
311 # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
312 # Note: If you update the file in the original location, it is
313 # necessary to call UpdateModel for ML to pick up and validate the
314 # updated file.
315 },
316 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the model to create. The name can be up to 32 characters long
317 # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)
318 # and ASCII digits 0-9. It must start with a letter.
319 &quot;etag&quot;: &quot;A String&quot;, # Output only. See RFC7232
320 # https://tools.ietf.org/html/rfc7232#section-2.3
321 &quot;activeOperations&quot;: [ # Output only. Lists operation ids associated with this model whose status is NOT done.
322 { # This resource represents a long-running operation that is the result of a
323 # network API call.
324 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
325 # method returns no data on success, such as `Delete`, the response is
326 # `google.protobuf.Empty`. If the original method is standard
327 # `Get`/`Create`/`Update`, the response should be the resource. For other
328 # methods, the response should have the type `XxxResponse`, where `Xxx`
329 # is the original method name. For example, if the original method name
330 # is `TakeSnapshot()`, the inferred response type is
331 # `TakeSnapshotResponse`.
332 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
333 },
334 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
335 # originally returns it. If you use the default HTTP mapping, the
336 # `name` should be a resource name ending with `operations/{unique_id}`.
337 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
338 # different programming environments, including REST APIs and RPC APIs. It is
339 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
340 # three pieces of data: error code, error message, and error details.
341 #
342 # You can find out more about this error model and how to work with it in the
343 # [API Design Guide](https://cloud.google.com/apis/design/errors).
344 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
345 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
346 # user-facing error message should be localized and sent in the
347 # google.rpc.Status.details field, or localized by the client.
348 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
349 # message types for APIs to use.
350 {
351 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
352 },
353 ],
354 },
355 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
356 # contains progress information and common metadata such as create time.
357 # Some services might not provide such metadata. Any method that returns a
358 # long-running operation should document the metadata type, if any.
359 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
360 },
361 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
362 # If `true`, the operation is completed, and either `error` or `response` is
363 # available.
364 },
365 ],
366 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this model was created in Firebase ML.
367 &quot;state&quot;: { # State common to all model types. # State common to all model types.
368 # Includes publishing and validation information.
369 # Includes publishing and validation information.
370 &quot;published&quot;: True or False, # Indicates if this model has been published.
371 &quot;validationError&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.
372 # A model may have validation errors if there were problems during
373 # the model creation/update.
374 # e.g. in the case of a TfLiteModel, if a tflite model file was
375 # missing or in the wrong format.
376 # This field will be empty for valid models.
377 # different programming environments, including REST APIs and RPC APIs. It is
378 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
379 # three pieces of data: error code, error message, and error details.
380 #
381 # You can find out more about this error model and how to work with it in the
382 # [API Design Guide](https://cloud.google.com/apis/design/errors).
383 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
384 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
385 # user-facing error message should be localized and sent in the
386 # google.rpc.Status.details field, or localized by the client.
387 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
388 # message types for APIs to use.
389 {
390 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
391 },
392 ],
393 },
394 },
395 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this model was updated in Firebase ML.
396 }</pre>
397</div>
398
399<div class="method">
400 <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
401 <pre>Lists the models
402
403Args:
404 parent: string, Required. The name of the parent to list models for.
405The parent must have the form `projects/{project_id}&#x27; (required)
406 filter: string, A filter for the list
407e.g. &#x27;tags: abc&#x27; to list models which are tagged with &quot;abc&quot;
408 pageToken: string, The next_page_token value returned from a previous List request, if any.
409 pageSize: integer, The maximum number of items to return
410 x__xgafv: string, V1 error format.
411 Allowed values
412 1 - v1 error format
413 2 - v2 error format
414
415Returns:
416 An object of the form:
417
418 { # The response for list models
419 &quot;models&quot;: [ # The list of models
420 { # An ML model hosted in Firebase ML
421 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Model.
422 # Model names have the form `projects/{project_id}/models/{model_id}`
423 # The name is ignored when creating a model.
424 &quot;modelHash&quot;: &quot;A String&quot;, # Output only. The model_hash will change if a new file is available for download.
425 &quot;tags&quot;: [ # User defined tags which can be used to group/filter models during listing
426 &quot;A String&quot;,
427 ],
428 &quot;tfliteModel&quot;: { # Information that is specific to TfLite models. # A TFLite Model
429 &quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the TFLite model
430 &quot;gcsTfliteUri&quot;: &quot;A String&quot;, # The TfLite file containing the model. (Stored in Google Cloud).
431 # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
432 # Note: If you update the file in the original location, it is
433 # necessary to call UpdateModel for ML to pick up and validate the
434 # updated file.
435 },
436 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the model to create. The name can be up to 32 characters long
437 # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)
438 # and ASCII digits 0-9. It must start with a letter.
439 &quot;etag&quot;: &quot;A String&quot;, # Output only. See RFC7232
440 # https://tools.ietf.org/html/rfc7232#section-2.3
441 &quot;activeOperations&quot;: [ # Output only. Lists operation ids associated with this model whose status is NOT done.
442 { # This resource represents a long-running operation that is the result of a
443 # network API call.
444 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
445 # method returns no data on success, such as `Delete`, the response is
446 # `google.protobuf.Empty`. If the original method is standard
447 # `Get`/`Create`/`Update`, the response should be the resource. For other
448 # methods, the response should have the type `XxxResponse`, where `Xxx`
449 # is the original method name. For example, if the original method name
450 # is `TakeSnapshot()`, the inferred response type is
451 # `TakeSnapshotResponse`.
452 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
453 },
454 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
455 # originally returns it. If you use the default HTTP mapping, the
456 # `name` should be a resource name ending with `operations/{unique_id}`.
457 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
458 # different programming environments, including REST APIs and RPC APIs. It is
459 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
460 # three pieces of data: error code, error message, and error details.
461 #
462 # You can find out more about this error model and how to work with it in the
463 # [API Design Guide](https://cloud.google.com/apis/design/errors).
464 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
465 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
466 # user-facing error message should be localized and sent in the
467 # google.rpc.Status.details field, or localized by the client.
468 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
469 # message types for APIs to use.
470 {
471 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
472 },
473 ],
474 },
475 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
476 # contains progress information and common metadata such as create time.
477 # Some services might not provide such metadata. Any method that returns a
478 # long-running operation should document the metadata type, if any.
479 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
480 },
481 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
482 # If `true`, the operation is completed, and either `error` or `response` is
483 # available.
484 },
485 ],
486 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this model was created in Firebase ML.
487 &quot;state&quot;: { # State common to all model types. # State common to all model types.
488 # Includes publishing and validation information.
489 # Includes publishing and validation information.
490 &quot;published&quot;: True or False, # Indicates if this model has been published.
491 &quot;validationError&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.
492 # A model may have validation errors if there were problems during
493 # the model creation/update.
494 # e.g. in the case of a TfLiteModel, if a tflite model file was
495 # missing or in the wrong format.
496 # This field will be empty for valid models.
497 # different programming environments, including REST APIs and RPC APIs. It is
498 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
499 # three pieces of data: error code, error message, and error details.
500 #
501 # You can find out more about this error model and how to work with it in the
502 # [API Design Guide](https://cloud.google.com/apis/design/errors).
503 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
504 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
505 # user-facing error message should be localized and sent in the
506 # google.rpc.Status.details field, or localized by the client.
507 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
508 # message types for APIs to use.
509 {
510 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
511 },
512 ],
513 },
514 },
515 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this model was updated in Firebase ML.
516 },
517 ],
518 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
519 # more results in the list.
520 }</pre>
521</div>
522
523<div class="method">
524 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
525 <pre>Retrieves the next page of results.
526
527Args:
528 previous_request: The request for the previous page. (required)
529 previous_response: The response from the request for the previous page. (required)
530
531Returns:
532 A request object that you can call &#x27;execute()&#x27; on to request the next
533 page. Returns None if there are no more items in the collection.
534 </pre>
535</div>
536
537<div class="method">
538 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
539 <pre>Updates a model. The longrunning operation will eventually return a Model.
540
541Args:
542 name: string, The resource name of the Model.
543Model names have the form `projects/{project_id}/models/{model_id}`
544The name is ignored when creating a model. (required)
545 body: object, The request body.
546 The object takes the form of:
547
548{ # An ML model hosted in Firebase ML
549 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Model.
550 # Model names have the form `projects/{project_id}/models/{model_id}`
551 # The name is ignored when creating a model.
552 &quot;modelHash&quot;: &quot;A String&quot;, # Output only. The model_hash will change if a new file is available for download.
553 &quot;tags&quot;: [ # User defined tags which can be used to group/filter models during listing
554 &quot;A String&quot;,
555 ],
556 &quot;tfliteModel&quot;: { # Information that is specific to TfLite models. # A TFLite Model
557 &quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the TFLite model
558 &quot;gcsTfliteUri&quot;: &quot;A String&quot;, # The TfLite file containing the model. (Stored in Google Cloud).
559 # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
560 # Note: If you update the file in the original location, it is
561 # necessary to call UpdateModel for ML to pick up and validate the
562 # updated file.
563 },
564 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the model to create. The name can be up to 32 characters long
565 # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)
566 # and ASCII digits 0-9. It must start with a letter.
567 &quot;etag&quot;: &quot;A String&quot;, # Output only. See RFC7232
568 # https://tools.ietf.org/html/rfc7232#section-2.3
569 &quot;activeOperations&quot;: [ # Output only. Lists operation ids associated with this model whose status is NOT done.
570 { # This resource represents a long-running operation that is the result of a
571 # network API call.
572 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
573 # method returns no data on success, such as `Delete`, the response is
574 # `google.protobuf.Empty`. If the original method is standard
575 # `Get`/`Create`/`Update`, the response should be the resource. For other
576 # methods, the response should have the type `XxxResponse`, where `Xxx`
577 # is the original method name. For example, if the original method name
578 # is `TakeSnapshot()`, the inferred response type is
579 # `TakeSnapshotResponse`.
580 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
581 },
582 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
583 # originally returns it. If you use the default HTTP mapping, the
584 # `name` should be a resource name ending with `operations/{unique_id}`.
585 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
586 # different programming environments, including REST APIs and RPC APIs. It is
587 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
588 # three pieces of data: error code, error message, and error details.
589 #
590 # You can find out more about this error model and how to work with it in the
591 # [API Design Guide](https://cloud.google.com/apis/design/errors).
592 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
593 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
594 # user-facing error message should be localized and sent in the
595 # google.rpc.Status.details field, or localized by the client.
596 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
597 # message types for APIs to use.
598 {
599 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
600 },
601 ],
602 },
603 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
604 # contains progress information and common metadata such as create time.
605 # Some services might not provide such metadata. Any method that returns a
606 # long-running operation should document the metadata type, if any.
607 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
608 },
609 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
610 # If `true`, the operation is completed, and either `error` or `response` is
611 # available.
612 },
613 ],
614 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this model was created in Firebase ML.
615 &quot;state&quot;: { # State common to all model types. # State common to all model types.
616 # Includes publishing and validation information.
617 # Includes publishing and validation information.
618 &quot;published&quot;: True or False, # Indicates if this model has been published.
619 &quot;validationError&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.
620 # A model may have validation errors if there were problems during
621 # the model creation/update.
622 # e.g. in the case of a TfLiteModel, if a tflite model file was
623 # missing or in the wrong format.
624 # This field will be empty for valid models.
625 # different programming environments, including REST APIs and RPC APIs. It is
626 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
627 # three pieces of data: error code, error message, and error details.
628 #
629 # You can find out more about this error model and how to work with it in the
630 # [API Design Guide](https://cloud.google.com/apis/design/errors).
631 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
632 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
633 # user-facing error message should be localized and sent in the
634 # google.rpc.Status.details field, or localized by the client.
635 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
636 # message types for APIs to use.
637 {
638 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
639 },
640 ],
641 },
642 },
643 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this model was updated in Firebase ML.
644 }
645
646 updateMask: string, The update mask
647 x__xgafv: string, V1 error format.
648 Allowed values
649 1 - v1 error format
650 2 - v2 error format
651
652Returns:
653 An object of the form:
654
655 { # This resource represents a long-running operation that is the result of a
656 # network API call.
657 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
658 # method returns no data on success, such as `Delete`, the response is
659 # `google.protobuf.Empty`. If the original method is standard
660 # `Get`/`Create`/`Update`, the response should be the resource. For other
661 # methods, the response should have the type `XxxResponse`, where `Xxx`
662 # is the original method name. For example, if the original method name
663 # is `TakeSnapshot()`, the inferred response type is
664 # `TakeSnapshotResponse`.
665 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
666 },
667 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
668 # originally returns it. If you use the default HTTP mapping, the
669 # `name` should be a resource name ending with `operations/{unique_id}`.
670 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
671 # different programming environments, including REST APIs and RPC APIs. It is
672 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
673 # three pieces of data: error code, error message, and error details.
674 #
675 # You can find out more about this error model and how to work with it in the
676 # [API Design Guide](https://cloud.google.com/apis/design/errors).
677 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
678 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
679 # user-facing error message should be localized and sent in the
680 # google.rpc.Status.details field, or localized by the client.
681 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
682 # message types for APIs to use.
683 {
684 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
685 },
686 ],
687 },
688 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
689 # contains progress information and common metadata such as create time.
690 # Some services might not provide such metadata. Any method that returns a
691 # long-running operation should document the metadata type, if any.
692 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
693 },
694 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
695 # If `true`, the operation is completed, and either `error` or `response` is
696 # available.
697 }</pre>
698</div>
699
700</body></html>