| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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. |
| 99 | The longrunning operation will eventually return a Model |
| 100 | |
| 101 | Args: |
| 102 | parent: string, Required. The parent project resource where the model is to be created. |
| 103 | The 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 | "name": "A String", # 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 | "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 112 | "displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long |
| 113 | # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) |
| 114 | # and ASCII digits 0-9. It must start with a letter. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 115 | "tags": [ # User defined tags which can be used to group/filter models during listing |
| 116 | "A String", |
| 117 | ], |
| 118 | "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 119 | "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done. |
| 120 | { # This resource represents a long-running operation that is the result of a |
| 121 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 122 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 123 | # If `true`, the operation is completed, and either `error` or `response` is |
| 124 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "response": { # The normal response of the operation in case of success. If the original |
| 126 | # method returns no data on success, such as `Delete`, the response is |
| 127 | # `google.protobuf.Empty`. If the original method is standard |
| 128 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 129 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 130 | # is the original method name. For example, if the original method name |
| 131 | # is `TakeSnapshot()`, the inferred response type is |
| 132 | # `TakeSnapshotResponse`. |
| 133 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 134 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 136 | # different programming environments, including REST APIs and RPC APIs. It is |
| 137 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 138 | # three pieces of data: error code, error message, and error details. |
| 139 | # |
| 140 | # You can find out more about this error model and how to work with it in the |
| 141 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 142 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 143 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 144 | # user-facing error message should be localized and sent in the |
| 145 | # google.rpc.Status.details field, or localized by the client. |
| 146 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 147 | # message types for APIs to use. |
| 148 | { |
| 149 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 150 | }, |
| 151 | ], |
| 152 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 153 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 154 | # originally returns it. If you use the default HTTP mapping, the |
| 155 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 156 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 157 | # contains progress information and common metadata such as create time. |
| 158 | # Some services might not provide such metadata. Any method that returns a |
| 159 | # long-running operation should document the metadata type, if any. |
| 160 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 161 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | }, |
| 163 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 164 | "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | "state": { # State common to all model types. # State common to all model types. |
| 166 | # Includes publishing and validation information. |
| 167 | # Includes publishing and validation information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 168 | "validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any. |
| 169 | # A model may have validation errors if there were problems during |
| 170 | # the model creation/update. |
| 171 | # e.g. in the case of a TfLiteModel, if a tflite model file was |
| 172 | # missing or in the wrong format. |
| 173 | # This field will be empty for valid models. |
| 174 | # different programming environments, including REST APIs and RPC APIs. It is |
| 175 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 176 | # three pieces of data: error code, error message, and error details. |
| 177 | # |
| 178 | # You can find out more about this error model and how to work with it in the |
| 179 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 180 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 181 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 182 | # user-facing error message should be localized and sent in the |
| 183 | # google.rpc.Status.details field, or localized by the client. |
| 184 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 185 | # message types for APIs to use. |
| 186 | { |
| 187 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 188 | }, |
| 189 | ], |
| 190 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 191 | "published": True or False, # Indicates if this model has been published. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 193 | "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model |
| 194 | "sizeBytes": "A String", # Output only. The size of the TFLite model |
| 195 | "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). |
| 196 | # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite |
| 197 | # Note: If you update the file in the original location, it is |
| 198 | # necessary to call UpdateModel for ML to pick up and validate the |
| 199 | # updated file. |
| 200 | }, |
| 201 | "etag": "A String", # Output only. See RFC7232 |
| 202 | # https://tools.ietf.org/html/rfc7232#section-2.3 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 203 | } |
| 204 | |
| 205 | x__xgafv: string, V1 error format. |
| 206 | Allowed values |
| 207 | 1 - v1 error format |
| 208 | 2 - v2 error format |
| 209 | |
| 210 | Returns: |
| 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 215 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 216 | # If `true`, the operation is completed, and either `error` or `response` is |
| 217 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 218 | "response": { # The normal response of the operation in case of success. If the original |
| 219 | # method returns no data on success, such as `Delete`, the response is |
| 220 | # `google.protobuf.Empty`. If the original method is standard |
| 221 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 222 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 223 | # is the original method name. For example, if the original method name |
| 224 | # is `TakeSnapshot()`, the inferred response type is |
| 225 | # `TakeSnapshotResponse`. |
| 226 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 227 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 228 | "error": { # 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 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 236 | "message": "A String", # 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 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 240 | # message types for APIs to use. |
| 241 | { |
| 242 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 243 | }, |
| 244 | ], |
| 245 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 246 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 247 | # originally returns it. If you use the default HTTP mapping, the |
| 248 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 249 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 250 | # contains progress information and common metadata such as create time. |
| 251 | # Some services might not provide such metadata. Any method that returns a |
| 252 | # long-running operation should document the metadata type, if any. |
| 253 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 254 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| 262 | Args: |
| 263 | name: string, Required. The name of the model to delete. |
| 264 | The 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 | |
| 270 | Returns: |
| 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 | |
| 289 | Args: |
| 290 | name: string, Required. The name of the model to get. |
| 291 | The 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 | |
| 297 | Returns: |
| 298 | An object of the form: |
| 299 | |
| 300 | { # An ML model hosted in Firebase ML |
| 301 | "name": "A String", # 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 | "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | "displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long |
| 306 | # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) |
| 307 | # and ASCII digits 0-9. It must start with a letter. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 308 | "tags": [ # User defined tags which can be used to group/filter models during listing |
| 309 | "A String", |
| 310 | ], |
| 311 | "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 312 | "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done. |
| 313 | { # This resource represents a long-running operation that is the result of a |
| 314 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 315 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 316 | # If `true`, the operation is completed, and either `error` or `response` is |
| 317 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 318 | "response": { # The normal response of the operation in case of success. If the original |
| 319 | # method returns no data on success, such as `Delete`, the response is |
| 320 | # `google.protobuf.Empty`. If the original method is standard |
| 321 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 322 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 323 | # is the original method name. For example, if the original method name |
| 324 | # is `TakeSnapshot()`, the inferred response type is |
| 325 | # `TakeSnapshotResponse`. |
| 326 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 327 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 328 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 329 | # different programming environments, including REST APIs and RPC APIs. It is |
| 330 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 331 | # three pieces of data: error code, error message, and error details. |
| 332 | # |
| 333 | # You can find out more about this error model and how to work with it in the |
| 334 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 335 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 336 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 337 | # user-facing error message should be localized and sent in the |
| 338 | # google.rpc.Status.details field, or localized by the client. |
| 339 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 340 | # message types for APIs to use. |
| 341 | { |
| 342 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 343 | }, |
| 344 | ], |
| 345 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 346 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 347 | # originally returns it. If you use the default HTTP mapping, the |
| 348 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 349 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 350 | # contains progress information and common metadata such as create time. |
| 351 | # Some services might not provide such metadata. Any method that returns a |
| 352 | # long-running operation should document the metadata type, if any. |
| 353 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 354 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 355 | }, |
| 356 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 357 | "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | "state": { # State common to all model types. # State common to all model types. |
| 359 | # Includes publishing and validation information. |
| 360 | # Includes publishing and validation information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 361 | "validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any. |
| 362 | # A model may have validation errors if there were problems during |
| 363 | # the model creation/update. |
| 364 | # e.g. in the case of a TfLiteModel, if a tflite model file was |
| 365 | # missing or in the wrong format. |
| 366 | # This field will be empty for valid models. |
| 367 | # different programming environments, including REST APIs and RPC APIs. It is |
| 368 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 369 | # three pieces of data: error code, error message, and error details. |
| 370 | # |
| 371 | # You can find out more about this error model and how to work with it in the |
| 372 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 373 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 374 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 375 | # user-facing error message should be localized and sent in the |
| 376 | # google.rpc.Status.details field, or localized by the client. |
| 377 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 378 | # message types for APIs to use. |
| 379 | { |
| 380 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 381 | }, |
| 382 | ], |
| 383 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 384 | "published": True or False, # Indicates if this model has been published. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 385 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 386 | "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model |
| 387 | "sizeBytes": "A String", # Output only. The size of the TFLite model |
| 388 | "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). |
| 389 | # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite |
| 390 | # Note: If you update the file in the original location, it is |
| 391 | # necessary to call UpdateModel for ML to pick up and validate the |
| 392 | # updated file. |
| 393 | }, |
| 394 | "etag": "A String", # Output only. See RFC7232 |
| 395 | # https://tools.ietf.org/html/rfc7232#section-2.3 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 396 | }</pre> |
| 397 | </div> |
| 398 | |
| 399 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 400 | <code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 401 | <pre>Lists the models |
| 402 | |
| 403 | Args: |
| 404 | parent: string, Required. The name of the parent to list models for. |
| 405 | The parent must have the form `projects/{project_id}' (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 406 | pageToken: string, The next_page_token value returned from a previous List request, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 407 | filter: string, A filter for the list |
| 408 | e.g. 'tags: abc' to list models which are tagged with "abc" |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| 415 | Returns: |
| 416 | An object of the form: |
| 417 | |
| 418 | { # The response for list models |
| 419 | "models": [ # The list of models |
| 420 | { # An ML model hosted in Firebase ML |
| 421 | "name": "A String", # 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 | "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | "displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long |
| 426 | # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) |
| 427 | # and ASCII digits 0-9. It must start with a letter. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 428 | "tags": [ # User defined tags which can be used to group/filter models during listing |
| 429 | "A String", |
| 430 | ], |
| 431 | "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 432 | "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done. |
| 433 | { # This resource represents a long-running operation that is the result of a |
| 434 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 435 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 436 | # If `true`, the operation is completed, and either `error` or `response` is |
| 437 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 438 | "response": { # The normal response of the operation in case of success. If the original |
| 439 | # method returns no data on success, such as `Delete`, the response is |
| 440 | # `google.protobuf.Empty`. If the original method is standard |
| 441 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 442 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 443 | # is the original method name. For example, if the original method name |
| 444 | # is `TakeSnapshot()`, the inferred response type is |
| 445 | # `TakeSnapshotResponse`. |
| 446 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 447 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 448 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 449 | # different programming environments, including REST APIs and RPC APIs. It is |
| 450 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 451 | # three pieces of data: error code, error message, and error details. |
| 452 | # |
| 453 | # You can find out more about this error model and how to work with it in the |
| 454 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 455 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 456 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 457 | # user-facing error message should be localized and sent in the |
| 458 | # google.rpc.Status.details field, or localized by the client. |
| 459 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 460 | # message types for APIs to use. |
| 461 | { |
| 462 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 463 | }, |
| 464 | ], |
| 465 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 466 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 467 | # originally returns it. If you use the default HTTP mapping, the |
| 468 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 469 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 470 | # contains progress information and common metadata such as create time. |
| 471 | # Some services might not provide such metadata. Any method that returns a |
| 472 | # long-running operation should document the metadata type, if any. |
| 473 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 474 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 475 | }, |
| 476 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 477 | "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 478 | "state": { # State common to all model types. # State common to all model types. |
| 479 | # Includes publishing and validation information. |
| 480 | # Includes publishing and validation information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 481 | "validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any. |
| 482 | # A model may have validation errors if there were problems during |
| 483 | # the model creation/update. |
| 484 | # e.g. in the case of a TfLiteModel, if a tflite model file was |
| 485 | # missing or in the wrong format. |
| 486 | # This field will be empty for valid models. |
| 487 | # different programming environments, including REST APIs and RPC APIs. It is |
| 488 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 489 | # three pieces of data: error code, error message, and error details. |
| 490 | # |
| 491 | # You can find out more about this error model and how to work with it in the |
| 492 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 493 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 494 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 495 | # user-facing error message should be localized and sent in the |
| 496 | # google.rpc.Status.details field, or localized by the client. |
| 497 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 498 | # message types for APIs to use. |
| 499 | { |
| 500 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 501 | }, |
| 502 | ], |
| 503 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 504 | "published": True or False, # Indicates if this model has been published. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 505 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 506 | "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model |
| 507 | "sizeBytes": "A String", # Output only. The size of the TFLite model |
| 508 | "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). |
| 509 | # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite |
| 510 | # Note: If you update the file in the original location, it is |
| 511 | # necessary to call UpdateModel for ML to pick up and validate the |
| 512 | # updated file. |
| 513 | }, |
| 514 | "etag": "A String", # Output only. See RFC7232 |
| 515 | # https://tools.ietf.org/html/rfc7232#section-2.3 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 516 | }, |
| 517 | ], |
| 518 | "nextPageToken": "A String", # 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 | |
| 527 | Args: |
| 528 | previous_request: The request for the previous page. (required) |
| 529 | previous_response: The response from the request for the previous page. (required) |
| 530 | |
| 531 | Returns: |
| 532 | A request object that you can call 'execute()' 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 | |
| 541 | Args: |
| 542 | name: string, The resource name of the Model. |
| 543 | Model names have the form `projects/{project_id}/models/{model_id}` |
| 544 | The 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 | "name": "A String", # 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 | "modelHash": "A String", # Output only. The model_hash will change if a new file is available for download. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 553 | "displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long |
| 554 | # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) |
| 555 | # and ASCII digits 0-9. It must start with a letter. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 556 | "tags": [ # User defined tags which can be used to group/filter models during listing |
| 557 | "A String", |
| 558 | ], |
| 559 | "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 560 | "activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done. |
| 561 | { # This resource represents a long-running operation that is the result of a |
| 562 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 563 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 564 | # If `true`, the operation is completed, and either `error` or `response` is |
| 565 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 566 | "response": { # The normal response of the operation in case of success. If the original |
| 567 | # method returns no data on success, such as `Delete`, the response is |
| 568 | # `google.protobuf.Empty`. If the original method is standard |
| 569 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 570 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 571 | # is the original method name. For example, if the original method name |
| 572 | # is `TakeSnapshot()`, the inferred response type is |
| 573 | # `TakeSnapshotResponse`. |
| 574 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 575 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 576 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 577 | # different programming environments, including REST APIs and RPC APIs. It is |
| 578 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 579 | # three pieces of data: error code, error message, and error details. |
| 580 | # |
| 581 | # You can find out more about this error model and how to work with it in the |
| 582 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 583 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 584 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 585 | # user-facing error message should be localized and sent in the |
| 586 | # google.rpc.Status.details field, or localized by the client. |
| 587 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 588 | # message types for APIs to use. |
| 589 | { |
| 590 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 591 | }, |
| 592 | ], |
| 593 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 594 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 595 | # originally returns it. If you use the default HTTP mapping, the |
| 596 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 597 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 598 | # contains progress information and common metadata such as create time. |
| 599 | # Some services might not provide such metadata. Any method that returns a |
| 600 | # long-running operation should document the metadata type, if any. |
| 601 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 602 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 603 | }, |
| 604 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 605 | "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 606 | "state": { # State common to all model types. # State common to all model types. |
| 607 | # Includes publishing and validation information. |
| 608 | # Includes publishing and validation information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 609 | "validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any. |
| 610 | # A model may have validation errors if there were problems during |
| 611 | # the model creation/update. |
| 612 | # e.g. in the case of a TfLiteModel, if a tflite model file was |
| 613 | # missing or in the wrong format. |
| 614 | # This field will be empty for valid models. |
| 615 | # different programming environments, including REST APIs and RPC APIs. It is |
| 616 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 617 | # three pieces of data: error code, error message, and error details. |
| 618 | # |
| 619 | # You can find out more about this error model and how to work with it in the |
| 620 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 621 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 622 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 623 | # user-facing error message should be localized and sent in the |
| 624 | # google.rpc.Status.details field, or localized by the client. |
| 625 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 626 | # message types for APIs to use. |
| 627 | { |
| 628 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 629 | }, |
| 630 | ], |
| 631 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 632 | "published": True or False, # Indicates if this model has been published. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 633 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 634 | "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model |
| 635 | "sizeBytes": "A String", # Output only. The size of the TFLite model |
| 636 | "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). |
| 637 | # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite |
| 638 | # Note: If you update the file in the original location, it is |
| 639 | # necessary to call UpdateModel for ML to pick up and validate the |
| 640 | # updated file. |
| 641 | }, |
| 642 | "etag": "A String", # Output only. See RFC7232 |
| 643 | # https://tools.ietf.org/html/rfc7232#section-2.3 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| 652 | Returns: |
| 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 657 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 658 | # If `true`, the operation is completed, and either `error` or `response` is |
| 659 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 660 | "response": { # The normal response of the operation in case of success. If the original |
| 661 | # method returns no data on success, such as `Delete`, the response is |
| 662 | # `google.protobuf.Empty`. If the original method is standard |
| 663 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 664 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 665 | # is the original method name. For example, if the original method name |
| 666 | # is `TakeSnapshot()`, the inferred response type is |
| 667 | # `TakeSnapshotResponse`. |
| 668 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 669 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 670 | "error": { # 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 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 678 | "message": "A String", # 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 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 682 | # message types for APIs to use. |
| 683 | { |
| 684 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 685 | }, |
| 686 | ], |
| 687 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 688 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 689 | # originally returns it. If you use the default HTTP mapping, the |
| 690 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 691 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 692 | # contains progress information and common metadata such as create time. |
| 693 | # Some services might not provide such metadata. Any method that returns a |
| 694 | # long-running operation should document the metadata type, if any. |
| 695 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 696 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 697 | }</pre> |
| 698 | </div> |
| 699 | |
| 700 | </body></html> |