| 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="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.locations.html">locations</a> . <a href="dialogflow_v2beta1.projects.locations.agent.html">agent</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="dialogflow_v2beta1.projects.locations.agent.entityTypes.html">entityTypes()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the entityTypes Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="dialogflow_v2beta1.projects.locations.agent.environments.html">environments()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the environments Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="dialogflow_v2beta1.projects.locations.agent.intents.html">intents()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the intents Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="dialogflow_v2beta1.projects.locations.agent.sessions.html">sessions()</a></code> |
| 94 | </p> |
| 95 | <p class="firstline">Returns the sessions Resource.</p> |
| 96 | |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">Exports the specified agent to a ZIP file.</p> |
| 100 | <p class="toc_element"> |
| 101 | <code><a href="#fulfillment">fulfillment(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 102 | <p class="firstline">Updates the fulfillment.</p> |
| 103 | <p class="toc_element"> |
| 104 | <code><a href="#getFulfillment">getFulfillment(name, x__xgafv=None)</a></code></p> |
| 105 | <p class="firstline">Retrieves the fulfillment.</p> |
| 106 | <p class="toc_element"> |
| 107 | <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p> |
| 108 | <p class="firstline">Imports the specified agent from a ZIP file.</p> |
| 109 | <p class="toc_element"> |
| 110 | <code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p> |
| 111 | <p class="firstline">Restores the specified agent from a ZIP file.</p> |
| 112 | <p class="toc_element"> |
| 113 | <code><a href="#train">train(parent, body=None, x__xgafv=None)</a></code></p> |
| 114 | <p class="firstline">Trains the specified agent.</p> |
| 115 | <h3>Method Details</h3> |
| 116 | <div class="method"> |
| 117 | <code class="details" id="export">export(parent, body=None, x__xgafv=None)</code> |
| 118 | <pre>Exports the specified agent to a ZIP file. |
| 119 | |
| 120 | |
| 121 | Operation <response: ExportAgentResponse> |
| 122 | |
| 123 | Args: |
| 124 | parent: string, Required. The project that the agent to export is associated with. |
| 125 | Format: `projects/<Project ID>`. (required) |
| 126 | body: object, The request body. |
| 127 | The object takes the form of: |
| 128 | |
| 129 | { # The request message for Agents.ExportAgent. |
| 130 | "agentUri": "A String", # Optional. The |
| 131 | # [Google Cloud Storage](https://cloud.google.com/storage/docs/) |
| 132 | # URI to export the agent to. |
| 133 | # The format of this URI must be `gs://<bucket-name>/<object-name>`. |
| 134 | # If left unspecified, the serialized agent is returned inline. |
| 135 | } |
| 136 | |
| 137 | x__xgafv: string, V1 error format. |
| 138 | Allowed values |
| 139 | 1 - v1 error format |
| 140 | 2 - v2 error format |
| 141 | |
| 142 | Returns: |
| 143 | An object of the form: |
| 144 | |
| 145 | { # This resource represents a long-running operation that is the result of a |
| 146 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 147 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 148 | # originally returns it. If you use the default HTTP mapping, the |
| 149 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 150 | "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. |
| 151 | # different programming environments, including REST APIs and RPC APIs. It is |
| 152 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 153 | # three pieces of data: error code, error message, and error details. |
| 154 | # |
| 155 | # You can find out more about this error model and how to work with it in the |
| 156 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 157 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 158 | # user-facing error message should be localized and sent in the |
| 159 | # google.rpc.Status.details field, or localized by the client. |
| 160 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 161 | # message types for APIs to use. |
| 162 | { |
| 163 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 164 | }, |
| 165 | ], |
| 166 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 167 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 168 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 169 | # contains progress information and common metadata such as create time. |
| 170 | # Some services might not provide such metadata. Any method that returns a |
| 171 | # long-running operation should document the metadata type, if any. |
| 172 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 173 | }, |
| 174 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 175 | # If `true`, the operation is completed, and either `error` or `response` is |
| 176 | # available. |
| 177 | "response": { # The normal response of the operation in case of success. If the original |
| 178 | # method returns no data on success, such as `Delete`, the response is |
| 179 | # `google.protobuf.Empty`. If the original method is standard |
| 180 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 181 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 182 | # is the original method name. For example, if the original method name |
| 183 | # is `TakeSnapshot()`, the inferred response type is |
| 184 | # `TakeSnapshotResponse`. |
| 185 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 186 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 187 | }</pre> |
| 188 | </div> |
| 189 | |
| 190 | <div class="method"> |
| 191 | <code class="details" id="fulfillment">fulfillment(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 192 | <pre>Updates the fulfillment. |
| 193 | |
| 194 | Args: |
| 195 | name: string, Required. The unique identifier of the fulfillment. |
| 196 | Format: `projects/<Project ID>/agent/fulfillment`. (required) |
| 197 | body: object, The request body. |
| 198 | The object takes the form of: |
| 199 | |
| 200 | { # Represents a fulfillment. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 201 | "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. |
| 202 | { # Whether fulfillment is enabled for the specific feature. |
| 203 | "type": "A String", # The type of the feature that enabled for fulfillment. |
| 204 | }, |
| 205 | ], |
| 206 | "name": "A String", # Required. The unique identifier of the fulfillment. |
| 207 | # Format: `projects/<Project ID>/agent/fulfillment`. |
| 208 | "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. |
| 209 | "enabled": True or False, # Optional. Whether fulfillment is enabled. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 210 | "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service. |
| 211 | # Dialogflow supports two mechanisms for authentications: |
| 212 | # - Basic authentication with username and password. |
| 213 | # - Authentication with additional authentication headers. |
| 214 | # More information could be found at: |
| 215 | # https://cloud.google.com/dialogflow/docs/fulfillment-configure. |
| 216 | "uri": "A String", # Required. The fulfillment URI for receiving POST requests. |
| 217 | # It must use https protocol. |
| 218 | "password": "A String", # Optional. The password for HTTP Basic authentication. |
| 219 | "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions |
| 220 | # integration. Defaults to false. |
| 221 | "username": "A String", # Optional. The user name for HTTP Basic authentication. |
| 222 | "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. |
| 223 | "a_key": "A String", |
| 224 | }, |
| 225 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 226 | } |
| 227 | |
| 228 | updateMask: string, Required. The mask to control which fields get updated. If the mask is not |
| 229 | present, all fields will be updated. |
| 230 | x__xgafv: string, V1 error format. |
| 231 | Allowed values |
| 232 | 1 - v1 error format |
| 233 | 2 - v2 error format |
| 234 | |
| 235 | Returns: |
| 236 | An object of the form: |
| 237 | |
| 238 | { # Represents a fulfillment. |
| 239 | "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. |
| 240 | { # Whether fulfillment is enabled for the specific feature. |
| 241 | "type": "A String", # The type of the feature that enabled for fulfillment. |
| 242 | }, |
| 243 | ], |
| 244 | "name": "A String", # Required. The unique identifier of the fulfillment. |
| 245 | # Format: `projects/<Project ID>/agent/fulfillment`. |
| 246 | "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. |
| 247 | "enabled": True or False, # Optional. Whether fulfillment is enabled. |
| 248 | "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service. |
| 249 | # Dialogflow supports two mechanisms for authentications: |
| 250 | # - Basic authentication with username and password. |
| 251 | # - Authentication with additional authentication headers. |
| 252 | # More information could be found at: |
| 253 | # https://cloud.google.com/dialogflow/docs/fulfillment-configure. |
| 254 | "uri": "A String", # Required. The fulfillment URI for receiving POST requests. |
| 255 | # It must use https protocol. |
| 256 | "password": "A String", # Optional. The password for HTTP Basic authentication. |
| 257 | "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions |
| 258 | # integration. Defaults to false. |
| 259 | "username": "A String", # Optional. The user name for HTTP Basic authentication. |
| 260 | "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. |
| 261 | "a_key": "A String", |
| 262 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 264 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 265 | </div> |
| 266 | |
| 267 | <div class="method"> |
| 268 | <code class="details" id="getFulfillment">getFulfillment(name, x__xgafv=None)</code> |
| 269 | <pre>Retrieves the fulfillment. |
| 270 | |
| 271 | Args: |
| 272 | name: string, Required. The name of the fulfillment. |
| 273 | Format: `projects/<Project ID>/agent/fulfillment`. (required) |
| 274 | x__xgafv: string, V1 error format. |
| 275 | Allowed values |
| 276 | 1 - v1 error format |
| 277 | 2 - v2 error format |
| 278 | |
| 279 | Returns: |
| 280 | An object of the form: |
| 281 | |
| 282 | { # Represents a fulfillment. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 283 | "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. |
| 284 | { # Whether fulfillment is enabled for the specific feature. |
| 285 | "type": "A String", # The type of the feature that enabled for fulfillment. |
| 286 | }, |
| 287 | ], |
| 288 | "name": "A String", # Required. The unique identifier of the fulfillment. |
| 289 | # Format: `projects/<Project ID>/agent/fulfillment`. |
| 290 | "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. |
| 291 | "enabled": True or False, # Optional. Whether fulfillment is enabled. |
| 292 | "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service. |
| 293 | # Dialogflow supports two mechanisms for authentications: |
| 294 | # - Basic authentication with username and password. |
| 295 | # - Authentication with additional authentication headers. |
| 296 | # More information could be found at: |
| 297 | # https://cloud.google.com/dialogflow/docs/fulfillment-configure. |
| 298 | "uri": "A String", # Required. The fulfillment URI for receiving POST requests. |
| 299 | # It must use https protocol. |
| 300 | "password": "A String", # Optional. The password for HTTP Basic authentication. |
| 301 | "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions |
| 302 | # integration. Defaults to false. |
| 303 | "username": "A String", # Optional. The user name for HTTP Basic authentication. |
| 304 | "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. |
| 305 | "a_key": "A String", |
| 306 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 308 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 309 | </div> |
| 310 | |
| 311 | <div class="method"> |
| 312 | <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code> |
| 313 | <pre>Imports the specified agent from a ZIP file. |
| 314 | |
| 315 | Uploads new intents and entity types without deleting the existing ones. |
| 316 | Intents and entity types with the same name are replaced with the new |
| 317 | versions from ImportAgentRequest. |
| 318 | |
| 319 | |
| 320 | Operation <response: google.protobuf.Empty> |
| 321 | |
| 322 | Args: |
| 323 | parent: string, Required. The project that the agent to import is associated with. |
| 324 | Format: `projects/<Project ID>`. (required) |
| 325 | body: object, The request body. |
| 326 | The object takes the form of: |
| 327 | |
| 328 | { # The request message for Agents.ImportAgent. |
| 329 | "agentContent": "A String", # Zip compressed raw byte content for agent. |
| 330 | "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to import. |
| 331 | # Note: The URI must start with "gs://". |
| 332 | } |
| 333 | |
| 334 | x__xgafv: string, V1 error format. |
| 335 | Allowed values |
| 336 | 1 - v1 error format |
| 337 | 2 - v2 error format |
| 338 | |
| 339 | Returns: |
| 340 | An object of the form: |
| 341 | |
| 342 | { # This resource represents a long-running operation that is the result of a |
| 343 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 344 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 345 | # originally returns it. If you use the default HTTP mapping, the |
| 346 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 347 | "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. |
| 348 | # different programming environments, including REST APIs and RPC APIs. It is |
| 349 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 350 | # three pieces of data: error code, error message, and error details. |
| 351 | # |
| 352 | # You can find out more about this error model and how to work with it in the |
| 353 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 354 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 355 | # user-facing error message should be localized and sent in the |
| 356 | # google.rpc.Status.details field, or localized by the client. |
| 357 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 358 | # message types for APIs to use. |
| 359 | { |
| 360 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 361 | }, |
| 362 | ], |
| 363 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 364 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 365 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 366 | # contains progress information and common metadata such as create time. |
| 367 | # Some services might not provide such metadata. Any method that returns a |
| 368 | # long-running operation should document the metadata type, if any. |
| 369 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 370 | }, |
| 371 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 372 | # If `true`, the operation is completed, and either `error` or `response` is |
| 373 | # available. |
| 374 | "response": { # The normal response of the operation in case of success. If the original |
| 375 | # method returns no data on success, such as `Delete`, the response is |
| 376 | # `google.protobuf.Empty`. If the original method is standard |
| 377 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 378 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 379 | # is the original method name. For example, if the original method name |
| 380 | # is `TakeSnapshot()`, the inferred response type is |
| 381 | # `TakeSnapshotResponse`. |
| 382 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 383 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 384 | }</pre> |
| 385 | </div> |
| 386 | |
| 387 | <div class="method"> |
| 388 | <code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code> |
| 389 | <pre>Restores the specified agent from a ZIP file. |
| 390 | |
| 391 | Replaces the current agent version with a new one. All the intents and |
| 392 | entity types in the older version are deleted. |
| 393 | |
| 394 | |
| 395 | Operation <response: google.protobuf.Empty> |
| 396 | |
| 397 | Args: |
| 398 | parent: string, Required. The project that the agent to restore is associated with. |
| 399 | Format: `projects/<Project ID>`. (required) |
| 400 | body: object, The request body. |
| 401 | The object takes the form of: |
| 402 | |
| 403 | { # The request message for Agents.RestoreAgent. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 404 | "agentContent": "A String", # Zip compressed raw byte content for agent. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 405 | "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to restore. |
| 406 | # Note: The URI must start with "gs://". |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 407 | } |
| 408 | |
| 409 | x__xgafv: string, V1 error format. |
| 410 | Allowed values |
| 411 | 1 - v1 error format |
| 412 | 2 - v2 error format |
| 413 | |
| 414 | Returns: |
| 415 | An object of the form: |
| 416 | |
| 417 | { # This resource represents a long-running operation that is the result of a |
| 418 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 419 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 420 | # originally returns it. If you use the default HTTP mapping, the |
| 421 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 422 | "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. |
| 423 | # different programming environments, including REST APIs and RPC APIs. It is |
| 424 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 425 | # three pieces of data: error code, error message, and error details. |
| 426 | # |
| 427 | # You can find out more about this error model and how to work with it in the |
| 428 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 429 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 430 | # user-facing error message should be localized and sent in the |
| 431 | # google.rpc.Status.details field, or localized by the client. |
| 432 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 433 | # message types for APIs to use. |
| 434 | { |
| 435 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 436 | }, |
| 437 | ], |
| 438 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 439 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 440 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 441 | # contains progress information and common metadata such as create time. |
| 442 | # Some services might not provide such metadata. Any method that returns a |
| 443 | # long-running operation should document the metadata type, if any. |
| 444 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 445 | }, |
| 446 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 447 | # If `true`, the operation is completed, and either `error` or `response` is |
| 448 | # available. |
| 449 | "response": { # The normal response of the operation in case of success. If the original |
| 450 | # method returns no data on success, such as `Delete`, the response is |
| 451 | # `google.protobuf.Empty`. If the original method is standard |
| 452 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 453 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 454 | # is the original method name. For example, if the original method name |
| 455 | # is `TakeSnapshot()`, the inferred response type is |
| 456 | # `TakeSnapshotResponse`. |
| 457 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 458 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 459 | }</pre> |
| 460 | </div> |
| 461 | |
| 462 | <div class="method"> |
| 463 | <code class="details" id="train">train(parent, body=None, x__xgafv=None)</code> |
| 464 | <pre>Trains the specified agent. |
| 465 | |
| 466 | |
| 467 | Operation <response: google.protobuf.Empty> |
| 468 | |
| 469 | Args: |
| 470 | parent: string, Required. The project that the agent to train is associated with. |
| 471 | Format: `projects/<Project ID>`. (required) |
| 472 | body: object, The request body. |
| 473 | The object takes the form of: |
| 474 | |
| 475 | { # The request message for Agents.TrainAgent. |
| 476 | } |
| 477 | |
| 478 | x__xgafv: string, V1 error format. |
| 479 | Allowed values |
| 480 | 1 - v1 error format |
| 481 | 2 - v2 error format |
| 482 | |
| 483 | Returns: |
| 484 | An object of the form: |
| 485 | |
| 486 | { # This resource represents a long-running operation that is the result of a |
| 487 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 488 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 489 | # originally returns it. If you use the default HTTP mapping, the |
| 490 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 491 | "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. |
| 492 | # different programming environments, including REST APIs and RPC APIs. It is |
| 493 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 494 | # three pieces of data: error code, error message, and error details. |
| 495 | # |
| 496 | # You can find out more about this error model and how to work with it in the |
| 497 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 498 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 499 | # user-facing error message should be localized and sent in the |
| 500 | # google.rpc.Status.details field, or localized by the client. |
| 501 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 502 | # message types for APIs to use. |
| 503 | { |
| 504 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 505 | }, |
| 506 | ], |
| 507 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 508 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 509 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 510 | # contains progress information and common metadata such as create time. |
| 511 | # Some services might not provide such metadata. Any method that returns a |
| 512 | # long-running operation should document the metadata type, if any. |
| 513 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 514 | }, |
| 515 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 516 | # If `true`, the operation is completed, and either `error` or `response` is |
| 517 | # available. |
| 518 | "response": { # The normal response of the operation in case of success. If the original |
| 519 | # method returns no data on success, such as `Delete`, the response is |
| 520 | # `google.protobuf.Empty`. If the original method is standard |
| 521 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 522 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 523 | # is the original method name. For example, if the original method name |
| 524 | # is `TakeSnapshot()`, the inferred response type is |
| 525 | # `TakeSnapshotResponse`. |
| 526 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 527 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 528 | }</pre> |
| 529 | </div> |
| 530 | |
| 531 | </body></html> |