Blame - docs/dyn/firebaseml_v1beta2.projects.models.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

81

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">Creates a model in Firebase ML. The longrunning operation will eventually return a Model</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes a model</p>

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Gets a model resource.</p>

89

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

90

<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

91

<p class="firstline">Lists the models</p>

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

96

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Updates a model. The longrunning operation will eventually return a Model.</p>

98

<h3>Method Details</h3>

99

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

106

<pre>Creates a model in Firebase ML. The longrunning operation will eventually return a Model

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

107

108

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

109

parent: string, Required. The parent project resource where the model is to be created. The parent must have the form `projects/{project_id}` (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

110

body: object, The request body.

111

The object takes the form of:

112

113

{ # An ML model hosted in Firebase ML

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

114

"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model

115

"sizeBytes": "A String", # Output only. The size of the TFLite model

116

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.

117

"automlModel": "A String", # The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)

118

},

119

"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3

120

"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.

121

"tags": [ # User defined tags which can be used to group/filter models during listing

122

"A String",

123

],

124

"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

125

"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.

126

{ # This resource represents a long-running operation that is the result of a network API call.

127

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

128

"a_key": "", # Properties of the object. Contains field @type with type URL.

129

},

130

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

131

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

132

"a_key": "", # Properties of the object. Contains field @type with type URL.

133

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

134

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

135

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

136

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

137

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

138

{

139

"a_key": "", # Properties of the object. Contains field @type with type URL.

140

},

141

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

142

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

143

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

144

},

145

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

146

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

147

"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

148

"validationError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

149

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

150

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

151

{

152

"a_key": "", # Properties of the object. Contains field @type with type URL.

153

},

154

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

155

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

156

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

157

"published": True or False, # Indicates if this model has been published.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

158

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

159

"name": "A String", # The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

160

"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.

161

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

162

163

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

170

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

171

{ # This resource represents a long-running operation that is the result of a network API call.

172

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

173

"a_key": "", # Properties of the object. Contains field @type with type URL.

174

},

175

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

176

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

177

"a_key": "", # Properties of the object. Contains field @type with type URL.

178

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

179

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

180

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

181

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

182

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

183

{

184

"a_key": "", # Properties of the object. Contains field @type with type URL.

185

},

186

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

187

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

188

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

194

<pre>Deletes a model

195

196

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

197

name: string, Required. The name of the model to delete. The name must have the form `projects/{project_id}/models/{model_id}` (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

198

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

205

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

206

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

212

<pre>Gets a model resource.

213

214

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

215

name: string, Required. The name of the model to get. The name must have the form `projects/{project_id}/models/{model_id}` (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

216

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

223

224

{ # An ML model hosted in Firebase ML

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

225

"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model

226

"sizeBytes": "A String", # Output only. The size of the TFLite model

227

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.

228

"automlModel": "A String", # The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)

229

},

230

"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3

231

"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.

232

"tags": [ # User defined tags which can be used to group/filter models during listing

233

"A String",

234

],

235

"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

236

"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.

237

{ # This resource represents a long-running operation that is the result of a network API call.

238

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

239

"a_key": "", # Properties of the object. Contains field @type with type URL.

240

},

241

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

242

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

243

"a_key": "", # Properties of the object. Contains field @type with type URL.

244

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

245

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

246

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

247

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

248

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

249

{

250

"a_key": "", # Properties of the object. Contains field @type with type URL.

251

},

252

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

253

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

254

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

255

},

256

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

257

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

258

"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

259

"validationError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

260

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

261

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

262

{

263

"a_key": "", # Properties of the object. Contains field @type with type URL.

264

},

265

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

266

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

267

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

268

"published": True or False, # Indicates if this model has been published.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

269

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

270

"name": "A String", # The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

271

"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.

272

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

276

<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

277

<pre>Lists the models

278

279

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

280

parent: string, Required. The name of the parent to list models for. The parent must have the form `projects/{project_id}' (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

281

filter: string, A filter for the list e.g. 'tags: abc' to list models which are tagged with "abc"

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

282

pageSize: integer, The maximum number of items to return

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

283

pageToken: string, The next_page_token value returned from a previous List request, if any.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

284

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

291

292

{ # The response for list models

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

293

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

294

"models": [ # The list of models

295

{ # An ML model hosted in Firebase ML

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

296

"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model

297

"sizeBytes": "A String", # Output only. The size of the TFLite model

298

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.

299

"automlModel": "A String", # The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)

300

},

301

"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3

302

"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.

303

"tags": [ # User defined tags which can be used to group/filter models during listing

304

"A String",

305

],

306

"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

307

"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.

308

{ # This resource represents a long-running operation that is the result of a network API call.

309

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

310

"a_key": "", # Properties of the object. Contains field @type with type URL.

311

},

312

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

313

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

314

"a_key": "", # Properties of the object. Contains field @type with type URL.

315

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

316

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

317

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

318

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

319

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

320

{

321

"a_key": "", # Properties of the object. Contains field @type with type URL.

322

},

323

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

324

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

325

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

326

},

327

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

328

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

329

"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

330

"validationError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

331

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

332

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

333

{

334

"a_key": "", # Properties of the object. Contains field @type with type URL.

335

},

336

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

337

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

338

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

339

"published": True or False, # Indicates if this model has been published.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

340

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

341

"name": "A String", # The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

342

"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

343

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

344

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

350

<pre>Retrieves the next page of results.

351

352

Args:

353

previous_request: The request for the previous page. (required)

354

previous_response: The response from the request for the previous page. (required)

355

356

Returns:

357

A request object that you can call 'execute()' on to request the next

358

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

364

<pre>Updates a model. The longrunning operation will eventually return a Model.

365

366

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

367

name: string, The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

368

body: object, The request body.

369

The object takes the form of:

370

371

{ # An ML model hosted in Firebase ML

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

372

"tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model

373

"sizeBytes": "A String", # Output only. The size of the TFLite model

374

"gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.

375

"automlModel": "A String", # The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)

376

},

377

"etag": "A String", # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3

378

"updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.

379

"tags": [ # User defined tags which can be used to group/filter models during listing

380

"A String",

381

],

382

"createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

383

"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.

384

{ # This resource represents a long-running operation that is the result of a network API call.

385

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

386

"a_key": "", # Properties of the object. Contains field @type with type URL.

387

},

388

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

389

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

390

"a_key": "", # Properties of the object. Contains field @type with type URL.

391

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

392

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

393

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

394

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

395

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

396

{

397

"a_key": "", # Properties of the object. Contains field @type with type URL.

398

},

399

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

400

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

401

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

402

},

403

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

404

"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

405

"state": { # State common to all model types. Includes publishing and validation information. # State common to all model types. Includes publishing and validation information.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

406

"validationError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

407

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

408

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

409

{

410

"a_key": "", # Properties of the object. Contains field @type with type URL.

411

},

412

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

413

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

414

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

415

"published": True or False, # Indicates if this model has been published.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

416

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

417

"name": "A String", # The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

418

"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.

419

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

420

421

updateMask: string, The update mask

422

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

429

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

430

{ # This resource represents a long-running operation that is the result of a network API call.

431

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

432

"a_key": "", # Properties of the object. Contains field @type with type URL.

433

},

434

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

435

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

436

"a_key": "", # Properties of the object. Contains field @type with type URL.

437

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

438

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

439

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

440

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

441

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

442

{

443

"a_key": "", # Properties of the object. Contains field @type with type URL.

444

},

445

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

446

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

447

},

Bu Sun Kim