google-apis-dialogflow_v2beta1 0.17.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -151,7 +151,12 @@ module Google
151
151
  execute_or_queue_command(command, &block)
152
152
  end
153
153
 
154
- # Exports the specified agent to a ZIP file.
154
+ # Exports the specified agent to a ZIP file. This method is a [long-running
155
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
156
+ # operations). The returned `Operation` type has the following method-specific
157
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
158
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
159
+ # ExportAgentResponse
155
160
  # @param [String] parent
156
161
  # Required. The project that the agent to export is associated with. Format: `
157
162
  # projects/` or `projects//locations/`.
@@ -260,9 +265,16 @@ module Google
260
265
  # the import, the imported draft agent will be trained automatically (unless
261
266
  # disabled in agent settings). However, once the import is done, training may
262
267
  # not be completed yet. Please call TrainAgent and wait for the operation it
263
- # returns in order to train explicitly. Note: You should always train an agent
264
- # prior to sending it queries. See the [training documentation](https://cloud.
265
- # google.com/dialogflow/es/docs/training).
268
+ # returns in order to train explicitly. This method is a [long-running operation]
269
+ # (https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
270
+ # returned `Operation` type has the following method-specific fields: - `
271
+ # metadata`: An empty [Struct message](https://developers.google.com/protocol-
272
+ # buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message]
273
+ # (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
274
+ # empty) The operation only tracks when importing is complete, not when it is
275
+ # done training. Note: You should always train an agent prior to sending it
276
+ # queries. See the [training documentation](https://cloud.google.com/dialogflow/
277
+ # es/docs/training).
266
278
  # @param [String] parent
267
279
  # Required. The project that the agent to import is associated with. Format: `
268
280
  # projects/` or `projects//locations/`.
@@ -301,9 +313,16 @@ module Google
301
313
  # are deleted. After the restore, the restored draft agent will be trained
302
314
  # automatically (unless disabled in agent settings). However, once the restore
303
315
  # is done, training may not be completed yet. Please call TrainAgent and wait
304
- # for the operation it returns in order to train explicitly. Note: You should
305
- # always train an agent prior to sending it queries. See the [training
306
- # documentation](https://cloud.google.com/dialogflow/es/docs/training).
316
+ # for the operation it returns in order to train explicitly. This method is a [
317
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
318
+ # running-operations). The returned `Operation` type has the following method-
319
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
320
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
321
+ # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
322
+ # reference/google.protobuf#empty) The operation only tracks when restoring is
323
+ # complete, not when it is done training. Note: You should always train an agent
324
+ # prior to sending it queries. See the [training documentation](https://cloud.
325
+ # google.com/dialogflow/es/docs/training).
307
326
  # @param [String] parent
308
327
  # Required. The project that the agent to restore is associated with. Format: `
309
328
  # projects/` or `projects//locations/`.
@@ -379,9 +398,14 @@ module Google
379
398
  execute_or_queue_command(command, &block)
380
399
  end
381
400
 
382
- # Trains the specified agent. Note: You should always train an agent prior to
383
- # sending it queries. See the [training documentation](https://cloud.google.com/
384
- # dialogflow/es/docs/training).
401
+ # Trains the specified agent. This method is a [long-running operation](https://
402
+ # cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned
403
+ # `Operation` type has the following method-specific fields: - `metadata`: An
404
+ # empty [Struct message](https://developers.google.com/protocol-buffers/docs/
405
+ # reference/google.protobuf#struct) - `response`: An [Empty message](https://
406
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
407
+ # Note: You should always train an agent prior to sending it queries. See the [
408
+ # training documentation](https://cloud.google.com/dialogflow/es/docs/training).
385
409
  # @param [String] parent
386
410
  # Required. The project that the agent to train is associated with. Format: `
387
411
  # projects/` or `projects//locations/`.
@@ -454,9 +478,15 @@ module Google
454
478
  execute_or_queue_command(command, &block)
455
479
  end
456
480
 
457
- # Deletes entity types in the specified agent. Note: You should always train an
458
- # agent prior to sending it queries. See the [training documentation](https://
459
- # cloud.google.com/dialogflow/es/docs/training).
481
+ # Deletes entity types in the specified agent. This method is a [long-running
482
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
483
+ # operations). The returned `Operation` type has the following method-specific
484
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
485
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
486
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
487
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
488
+ # it queries. See the [training documentation](https://cloud.google.com/
489
+ # dialogflow/es/docs/training).
460
490
  # @param [String] parent
461
491
  # Required. The name of the agent to delete all entities types for. Supported
462
492
  # formats: - `projects//agent`, - `projects//locations//agent`.
@@ -490,9 +520,14 @@ module Google
490
520
  execute_or_queue_command(command, &block)
491
521
  end
492
522
 
493
- # Updates/Creates multiple entity types in the specified agent. Note: You should
494
- # always train an agent prior to sending it queries. See the [training
495
- # documentation](https://cloud.google.com/dialogflow/es/docs/training).
523
+ # Updates/Creates multiple entity types in the specified agent. This method is a
524
+ # [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
525
+ # running-operations). The returned `Operation` type has the following method-
526
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
527
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
528
+ # : BatchUpdateEntityTypesResponse Note: You should always train an agent prior
529
+ # to sending it queries. See the [training documentation](https://cloud.google.
530
+ # com/dialogflow/es/docs/training).
496
531
  # @param [String] parent
497
532
  # Required. The name of the agent to update or create entity types in. Supported
498
533
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -729,9 +764,15 @@ module Google
729
764
  execute_or_queue_command(command, &block)
730
765
  end
731
766
 
732
- # Creates multiple new entities in the specified entity type. Note: You should
733
- # always train an agent prior to sending it queries. See the [training
734
- # documentation](https://cloud.google.com/dialogflow/es/docs/training).
767
+ # Creates multiple new entities in the specified entity type. This method is a [
768
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
769
+ # running-operations). The returned `Operation` type has the following method-
770
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
771
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
772
+ # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
773
+ # reference/google.protobuf#empty) Note: You should always train an agent prior
774
+ # to sending it queries. See the [training documentation](https://cloud.google.
775
+ # com/dialogflow/es/docs/training).
735
776
  # @param [String] parent
736
777
  # Required. The name of the entity type to create entities in. Supported formats:
737
778
  # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`
@@ -765,9 +806,15 @@ module Google
765
806
  execute_or_queue_command(command, &block)
766
807
  end
767
808
 
768
- # Deletes entities in the specified entity type. Note: You should always train
769
- # an agent prior to sending it queries. See the [training documentation](https://
770
- # cloud.google.com/dialogflow/es/docs/training).
809
+ # Deletes entities in the specified entity type. This method is a [long-running
810
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
811
+ # operations). The returned `Operation` type has the following method-specific
812
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
813
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
814
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
815
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
816
+ # it queries. See the [training documentation](https://cloud.google.com/
817
+ # dialogflow/es/docs/training).
771
818
  # @param [String] parent
772
819
  # Required. The name of the entity type to delete entries for. Supported formats:
773
820
  # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`
@@ -805,7 +852,12 @@ module Google
805
852
  # does not affect entities in the entity type that aren't explicitly specified
806
853
  # in the request. Note: You should always train an agent prior to sending it
807
854
  # queries. See the [training documentation](https://cloud.google.com/dialogflow/
808
- # es/docs/training).
855
+ # es/docs/training). This method is a [long-running operation](https://cloud.
856
+ # google.com/dialogflow/es/docs/how/long-running-operations). The returned `
857
+ # Operation` type has the following method-specific fields: - `metadata`: An
858
+ # empty [Struct message](https://developers.google.com/protocol-buffers/docs/
859
+ # reference/google.protobuf#struct) - `response`: An [Empty message](https://
860
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
809
861
  # @param [String] parent
810
862
  # Required. The name of the entity type to update or create entities in.
811
863
  # Supported formats: - `projects//agent/entityTypes/` - `projects//locations//
@@ -1611,9 +1663,15 @@ module Google
1611
1663
  execute_or_queue_command(command, &block)
1612
1664
  end
1613
1665
 
1614
- # Deletes intents in the specified agent. Note: You should always train an agent
1615
- # prior to sending it queries. See the [training documentation](https://cloud.
1616
- # google.com/dialogflow/es/docs/training).
1666
+ # Deletes intents in the specified agent. This method is a [long-running
1667
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
1668
+ # operations). The returned `Operation` type has the following method-specific
1669
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
1670
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
1671
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
1672
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
1673
+ # it queries. See the [training documentation](https://cloud.google.com/
1674
+ # dialogflow/es/docs/training).
1617
1675
  # @param [String] parent
1618
1676
  # Required. The name of the agent to delete all entities types for. Supported
1619
1677
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -1647,9 +1705,14 @@ module Google
1647
1705
  execute_or_queue_command(command, &block)
1648
1706
  end
1649
1707
 
1650
- # Updates/Creates multiple intents in the specified agent. Note: You should
1651
- # always train an agent prior to sending it queries. See the [training
1652
- # documentation](https://cloud.google.com/dialogflow/es/docs/training).
1708
+ # Updates/Creates multiple intents in the specified agent. This method is a [
1709
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
1710
+ # running-operations). The returned `Operation` type has the following method-
1711
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
1712
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
1713
+ # : BatchUpdateIntentsResponse Note: You should always train an agent prior to
1714
+ # sending it queries. See the [training documentation](https://cloud.google.com/
1715
+ # dialogflow/es/docs/training).
1653
1716
  # @param [String] parent
1654
1717
  # Required. The name of the agent to update or create intents in. Supported
1655
1718
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -2098,8 +2161,12 @@ module Google
2098
2161
  execute_or_queue_command(command, &block)
2099
2162
  end
2100
2163
 
2101
- # Creates a new document. Note: The `projects.agent.knowledgeBases.documents`
2102
- # resource is deprecated; only use `projects.knowledgeBases.documents`.
2164
+ # Creates a new document. This method is a [long-running operation](https://
2165
+ # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
2166
+ # Operation` type has the following method-specific fields: - `metadata`:
2167
+ # KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.
2168
+ # knowledgeBases.documents` resource is deprecated; only use `projects.
2169
+ # knowledgeBases.documents`.
2103
2170
  # @param [String] parent
2104
2171
  # Required. The knowledge base to create a document for. Format: `projects//
2105
2172
  # locations//knowledgeBases/`.
@@ -2137,9 +2204,13 @@ module Google
2137
2204
  execute_or_queue_command(command, &block)
2138
2205
  end
2139
2206
 
2140
- # Deletes the specified document. Note: The `projects.agent.knowledgeBases.
2141
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
2142
- # .
2207
+ # Deletes the specified document. This method is a [long-running operation](
2208
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
2209
+ # returned `Operation` type has the following method-specific fields: - `
2210
+ # metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
2211
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
2212
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
2213
+ # only use `projects.knowledgeBases.documents`.
2143
2214
  # @param [String] name
2144
2215
  # Required. The name of the document to delete. Format: `projects//locations//
2145
2216
  # knowledgeBases//documents/`.
@@ -2254,9 +2325,12 @@ module Google
2254
2325
  execute_or_queue_command(command, &block)
2255
2326
  end
2256
2327
 
2257
- # Updates the specified document. Note: The `projects.agent.knowledgeBases.
2258
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
2259
- # .
2328
+ # Updates the specified document. This method is a [long-running operation](
2329
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
2330
+ # returned `Operation` type has the following method-specific fields: - `
2331
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
2332
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
2333
+ # projects.knowledgeBases.documents`.
2260
2334
  # @param [String] name
2261
2335
  # Optional. The document resource name. The name must be empty when creating a
2262
2336
  # document. Format: `projects//locations//knowledgeBases//documents/`.
@@ -2301,9 +2375,12 @@ module Google
2301
2375
  # effects because of internal implementation changes. Note: If the document
2302
2376
  # source is Google Cloud Storage URI, its metadata will be replaced with the
2303
2377
  # custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata`
2304
- # field is set to true in the request. Note: The `projects.agent.knowledgeBases.
2305
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
2306
- # .
2378
+ # field is set to true in the request. This method is a [long-running operation](
2379
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
2380
+ # returned `Operation` type has the following method-specific fields: - `
2381
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
2382
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
2383
+ # projects.knowledgeBases.documents`.
2307
2384
  # @param [String] name
2308
2385
  # Required. The name of the document to reload. Format: `projects//locations//
2309
2386
  # knowledgeBases//documents/`
@@ -4112,8 +4189,12 @@ module Google
4112
4189
  execute_or_queue_command(command, &block)
4113
4190
  end
4114
4191
 
4115
- # Creates a new document. Note: The `projects.agent.knowledgeBases.documents`
4116
- # resource is deprecated; only use `projects.knowledgeBases.documents`.
4192
+ # Creates a new document. This method is a [long-running operation](https://
4193
+ # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
4194
+ # Operation` type has the following method-specific fields: - `metadata`:
4195
+ # KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.
4196
+ # knowledgeBases.documents` resource is deprecated; only use `projects.
4197
+ # knowledgeBases.documents`.
4117
4198
  # @param [String] parent
4118
4199
  # Required. The knowledge base to create a document for. Format: `projects//
4119
4200
  # locations//knowledgeBases/`.
@@ -4151,9 +4232,13 @@ module Google
4151
4232
  execute_or_queue_command(command, &block)
4152
4233
  end
4153
4234
 
4154
- # Deletes the specified document. Note: The `projects.agent.knowledgeBases.
4155
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
4156
- # .
4235
+ # Deletes the specified document. This method is a [long-running operation](
4236
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
4237
+ # returned `Operation` type has the following method-specific fields: - `
4238
+ # metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
4239
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
4240
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
4241
+ # only use `projects.knowledgeBases.documents`.
4157
4242
  # @param [String] name
4158
4243
  # Required. The name of the document to delete. Format: `projects//locations//
4159
4244
  # knowledgeBases//documents/`.
@@ -4219,7 +4304,10 @@ module Google
4219
4304
 
4220
4305
  # Create documents by importing data from external sources. Dialogflow supports
4221
4306
  # up to 350 documents in each request. If you try to import more, Dialogflow
4222
- # will return an error.
4307
+ # will return an error. This method is a [long-running operation](https://cloud.
4308
+ # google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
4309
+ # Operation` type has the following method-specific fields: - `metadata`:
4310
+ # KnowledgeOperationMetadata - `response`: ImportDocumentsResponse
4223
4311
  # @param [String] parent
4224
4312
  # Required. The knowledge base to import documents into. Format: `projects//
4225
4313
  # locations//knowledgeBases/`.
@@ -4304,9 +4392,12 @@ module Google
4304
4392
  execute_or_queue_command(command, &block)
4305
4393
  end
4306
4394
 
4307
- # Updates the specified document. Note: The `projects.agent.knowledgeBases.
4308
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
4309
- # .
4395
+ # Updates the specified document. This method is a [long-running operation](
4396
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
4397
+ # returned `Operation` type has the following method-specific fields: - `
4398
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
4399
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
4400
+ # projects.knowledgeBases.documents`.
4310
4401
  # @param [String] name
4311
4402
  # Optional. The document resource name. The name must be empty when creating a
4312
4403
  # document. Format: `projects//locations//knowledgeBases//documents/`.
@@ -4351,9 +4442,12 @@ module Google
4351
4442
  # effects because of internal implementation changes. Note: If the document
4352
4443
  # source is Google Cloud Storage URI, its metadata will be replaced with the
4353
4444
  # custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata`
4354
- # field is set to true in the request. Note: The `projects.agent.knowledgeBases.
4355
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
4356
- # .
4445
+ # field is set to true in the request. This method is a [long-running operation](
4446
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
4447
+ # returned `Operation` type has the following method-specific fields: - `
4448
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
4449
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
4450
+ # projects.knowledgeBases.documents`.
4357
4451
  # @param [String] name
4358
4452
  # Required. The name of the document to reload. Format: `projects//locations//
4359
4453
  # knowledgeBases//documents/`
@@ -4418,6 +4512,36 @@ module Google
4418
4512
  execute_or_queue_command(command, &block)
4419
4513
  end
4420
4514
 
4515
+ # Gets information about a location.
4516
+ # @param [String] name
4517
+ # Resource name for the location.
4518
+ # @param [String] fields
4519
+ # Selector specifying which fields to include in a partial response.
4520
+ # @param [String] quota_user
4521
+ # Available to use for quota purposes for server-side applications. Can be any
4522
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4523
+ # @param [Google::Apis::RequestOptions] options
4524
+ # Request-specific options
4525
+ #
4526
+ # @yield [result, err] Result & error if block supplied
4527
+ # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudLocationLocation] parsed result object
4528
+ # @yieldparam err [StandardError] error object if request failed
4529
+ #
4530
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudLocationLocation]
4531
+ #
4532
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4533
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4534
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4535
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
4536
+ command = make_simple_command(:get, 'v2beta1/{+name}', options)
4537
+ command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudLocationLocation::Representation
4538
+ command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudLocationLocation
4539
+ command.params['name'] = name unless name.nil?
4540
+ command.query['fields'] = fields unless fields.nil?
4541
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4542
+ execute_or_queue_command(command, &block)
4543
+ end
4544
+
4421
4545
  # Retrieves the specified agent.
4422
4546
  # @param [String] parent
4423
4547
  # Required. The project that the agent to fetch is associated with. Format: `
@@ -4449,6 +4573,49 @@ module Google
4449
4573
  execute_or_queue_command(command, &block)
4450
4574
  end
4451
4575
 
4576
+ # Lists information about the supported locations for this service.
4577
+ # @param [String] name
4578
+ # The resource that owns the locations collection, if applicable.
4579
+ # @param [String] filter
4580
+ # A filter to narrow down results to a preferred subset. The filtering language
4581
+ # accepts strings like "displayName=tokyo", and is documented in more detail in [
4582
+ # AIP-160](https://google.aip.dev/160).
4583
+ # @param [Fixnum] page_size
4584
+ # The maximum number of results to return. If not set, the service selects a
4585
+ # default.
4586
+ # @param [String] page_token
4587
+ # A page token received from the `next_page_token` field in the response. Send
4588
+ # that page token to receive the subsequent page.
4589
+ # @param [String] fields
4590
+ # Selector specifying which fields to include in a partial response.
4591
+ # @param [String] quota_user
4592
+ # Available to use for quota purposes for server-side applications. Can be any
4593
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4594
+ # @param [Google::Apis::RequestOptions] options
4595
+ # Request-specific options
4596
+ #
4597
+ # @yield [result, err] Result & error if block supplied
4598
+ # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse] parsed result object
4599
+ # @yieldparam err [StandardError] error object if request failed
4600
+ #
4601
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse]
4602
+ #
4603
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4604
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4605
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4606
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4607
+ command = make_simple_command(:get, 'v2beta1/{+name}/locations', options)
4608
+ command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse::Representation
4609
+ command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse
4610
+ command.params['name'] = name unless name.nil?
4611
+ command.query['filter'] = filter unless filter.nil?
4612
+ command.query['pageSize'] = page_size unless page_size.nil?
4613
+ command.query['pageToken'] = page_token unless page_token.nil?
4614
+ command.query['fields'] = fields unless fields.nil?
4615
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4616
+ execute_or_queue_command(command, &block)
4617
+ end
4618
+
4452
4619
  # Creates/updates the specified agent. Note: You should always train an agent
4453
4620
  # prior to sending it queries. See the [training documentation](https://cloud.
4454
4621
  # google.com/dialogflow/es/docs/training).
@@ -4488,7 +4655,12 @@ module Google
4488
4655
  execute_or_queue_command(command, &block)
4489
4656
  end
4490
4657
 
4491
- # Exports the specified agent to a ZIP file.
4658
+ # Exports the specified agent to a ZIP file. This method is a [long-running
4659
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
4660
+ # operations). The returned `Operation` type has the following method-specific
4661
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
4662
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
4663
+ # ExportAgentResponse
4492
4664
  # @param [String] parent
4493
4665
  # Required. The project that the agent to export is associated with. Format: `
4494
4666
  # projects/` or `projects//locations/`.
@@ -4597,9 +4769,16 @@ module Google
4597
4769
  # the import, the imported draft agent will be trained automatically (unless
4598
4770
  # disabled in agent settings). However, once the import is done, training may
4599
4771
  # not be completed yet. Please call TrainAgent and wait for the operation it
4600
- # returns in order to train explicitly. Note: You should always train an agent
4601
- # prior to sending it queries. See the [training documentation](https://cloud.
4602
- # google.com/dialogflow/es/docs/training).
4772
+ # returns in order to train explicitly. This method is a [long-running operation]
4773
+ # (https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
4774
+ # returned `Operation` type has the following method-specific fields: - `
4775
+ # metadata`: An empty [Struct message](https://developers.google.com/protocol-
4776
+ # buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message]
4777
+ # (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
4778
+ # empty) The operation only tracks when importing is complete, not when it is
4779
+ # done training. Note: You should always train an agent prior to sending it
4780
+ # queries. See the [training documentation](https://cloud.google.com/dialogflow/
4781
+ # es/docs/training).
4603
4782
  # @param [String] parent
4604
4783
  # Required. The project that the agent to import is associated with. Format: `
4605
4784
  # projects/` or `projects//locations/`.
@@ -4638,9 +4817,16 @@ module Google
4638
4817
  # are deleted. After the restore, the restored draft agent will be trained
4639
4818
  # automatically (unless disabled in agent settings). However, once the restore
4640
4819
  # is done, training may not be completed yet. Please call TrainAgent and wait
4641
- # for the operation it returns in order to train explicitly. Note: You should
4642
- # always train an agent prior to sending it queries. See the [training
4643
- # documentation](https://cloud.google.com/dialogflow/es/docs/training).
4820
+ # for the operation it returns in order to train explicitly. This method is a [
4821
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
4822
+ # running-operations). The returned `Operation` type has the following method-
4823
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
4824
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
4825
+ # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
4826
+ # reference/google.protobuf#empty) The operation only tracks when restoring is
4827
+ # complete, not when it is done training. Note: You should always train an agent
4828
+ # prior to sending it queries. See the [training documentation](https://cloud.
4829
+ # google.com/dialogflow/es/docs/training).
4644
4830
  # @param [String] parent
4645
4831
  # Required. The project that the agent to restore is associated with. Format: `
4646
4832
  # projects/` or `projects//locations/`.
@@ -4716,9 +4902,14 @@ module Google
4716
4902
  execute_or_queue_command(command, &block)
4717
4903
  end
4718
4904
 
4719
- # Trains the specified agent. Note: You should always train an agent prior to
4720
- # sending it queries. See the [training documentation](https://cloud.google.com/
4721
- # dialogflow/es/docs/training).
4905
+ # Trains the specified agent. This method is a [long-running operation](https://
4906
+ # cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned
4907
+ # `Operation` type has the following method-specific fields: - `metadata`: An
4908
+ # empty [Struct message](https://developers.google.com/protocol-buffers/docs/
4909
+ # reference/google.protobuf#struct) - `response`: An [Empty message](https://
4910
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
4911
+ # Note: You should always train an agent prior to sending it queries. See the [
4912
+ # training documentation](https://cloud.google.com/dialogflow/es/docs/training).
4722
4913
  # @param [String] parent
4723
4914
  # Required. The project that the agent to train is associated with. Format: `
4724
4915
  # projects/` or `projects//locations/`.
@@ -4791,9 +4982,15 @@ module Google
4791
4982
  execute_or_queue_command(command, &block)
4792
4983
  end
4793
4984
 
4794
- # Deletes entity types in the specified agent. Note: You should always train an
4795
- # agent prior to sending it queries. See the [training documentation](https://
4796
- # cloud.google.com/dialogflow/es/docs/training).
4985
+ # Deletes entity types in the specified agent. This method is a [long-running
4986
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
4987
+ # operations). The returned `Operation` type has the following method-specific
4988
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
4989
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
4990
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
4991
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
4992
+ # it queries. See the [training documentation](https://cloud.google.com/
4993
+ # dialogflow/es/docs/training).
4797
4994
  # @param [String] parent
4798
4995
  # Required. The name of the agent to delete all entities types for. Supported
4799
4996
  # formats: - `projects//agent`, - `projects//locations//agent`.
@@ -4827,9 +5024,14 @@ module Google
4827
5024
  execute_or_queue_command(command, &block)
4828
5025
  end
4829
5026
 
4830
- # Updates/Creates multiple entity types in the specified agent. Note: You should
4831
- # always train an agent prior to sending it queries. See the [training
4832
- # documentation](https://cloud.google.com/dialogflow/es/docs/training).
5027
+ # Updates/Creates multiple entity types in the specified agent. This method is a
5028
+ # [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
5029
+ # running-operations). The returned `Operation` type has the following method-
5030
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
5031
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
5032
+ # : BatchUpdateEntityTypesResponse Note: You should always train an agent prior
5033
+ # to sending it queries. See the [training documentation](https://cloud.google.
5034
+ # com/dialogflow/es/docs/training).
4833
5035
  # @param [String] parent
4834
5036
  # Required. The name of the agent to update or create entity types in. Supported
4835
5037
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -5066,9 +5268,15 @@ module Google
5066
5268
  execute_or_queue_command(command, &block)
5067
5269
  end
5068
5270
 
5069
- # Creates multiple new entities in the specified entity type. Note: You should
5070
- # always train an agent prior to sending it queries. See the [training
5071
- # documentation](https://cloud.google.com/dialogflow/es/docs/training).
5271
+ # Creates multiple new entities in the specified entity type. This method is a [
5272
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
5273
+ # running-operations). The returned `Operation` type has the following method-
5274
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
5275
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
5276
+ # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
5277
+ # reference/google.protobuf#empty) Note: You should always train an agent prior
5278
+ # to sending it queries. See the [training documentation](https://cloud.google.
5279
+ # com/dialogflow/es/docs/training).
5072
5280
  # @param [String] parent
5073
5281
  # Required. The name of the entity type to create entities in. Supported formats:
5074
5282
  # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`
@@ -5102,9 +5310,15 @@ module Google
5102
5310
  execute_or_queue_command(command, &block)
5103
5311
  end
5104
5312
 
5105
- # Deletes entities in the specified entity type. Note: You should always train
5106
- # an agent prior to sending it queries. See the [training documentation](https://
5107
- # cloud.google.com/dialogflow/es/docs/training).
5313
+ # Deletes entities in the specified entity type. This method is a [long-running
5314
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
5315
+ # operations). The returned `Operation` type has the following method-specific
5316
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
5317
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
5318
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
5319
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
5320
+ # it queries. See the [training documentation](https://cloud.google.com/
5321
+ # dialogflow/es/docs/training).
5108
5322
  # @param [String] parent
5109
5323
  # Required. The name of the entity type to delete entries for. Supported formats:
5110
5324
  # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`
@@ -5142,7 +5356,12 @@ module Google
5142
5356
  # does not affect entities in the entity type that aren't explicitly specified
5143
5357
  # in the request. Note: You should always train an agent prior to sending it
5144
5358
  # queries. See the [training documentation](https://cloud.google.com/dialogflow/
5145
- # es/docs/training).
5359
+ # es/docs/training). This method is a [long-running operation](https://cloud.
5360
+ # google.com/dialogflow/es/docs/how/long-running-operations). The returned `
5361
+ # Operation` type has the following method-specific fields: - `metadata`: An
5362
+ # empty [Struct message](https://developers.google.com/protocol-buffers/docs/
5363
+ # reference/google.protobuf#struct) - `response`: An [Empty message](https://
5364
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
5146
5365
  # @param [String] parent
5147
5366
  # Required. The name of the entity type to update or create entities in.
5148
5367
  # Supported formats: - `projects//agent/entityTypes/` - `projects//locations//
@@ -5948,9 +6167,15 @@ module Google
5948
6167
  execute_or_queue_command(command, &block)
5949
6168
  end
5950
6169
 
5951
- # Deletes intents in the specified agent. Note: You should always train an agent
5952
- # prior to sending it queries. See the [training documentation](https://cloud.
5953
- # google.com/dialogflow/es/docs/training).
6170
+ # Deletes intents in the specified agent. This method is a [long-running
6171
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
6172
+ # operations). The returned `Operation` type has the following method-specific
6173
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
6174
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
6175
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
6176
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
6177
+ # it queries. See the [training documentation](https://cloud.google.com/
6178
+ # dialogflow/es/docs/training).
5954
6179
  # @param [String] parent
5955
6180
  # Required. The name of the agent to delete all entities types for. Supported
5956
6181
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -5984,9 +6209,14 @@ module Google
5984
6209
  execute_or_queue_command(command, &block)
5985
6210
  end
5986
6211
 
5987
- # Updates/Creates multiple intents in the specified agent. Note: You should
5988
- # always train an agent prior to sending it queries. See the [training
5989
- # documentation](https://cloud.google.com/dialogflow/es/docs/training).
6212
+ # Updates/Creates multiple intents in the specified agent. This method is a [
6213
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
6214
+ # running-operations). The returned `Operation` type has the following method-
6215
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
6216
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
6217
+ # : BatchUpdateIntentsResponse Note: You should always train an agent prior to
6218
+ # sending it queries. See the [training documentation](https://cloud.google.com/
6219
+ # dialogflow/es/docs/training).
5990
6220
  # @param [String] parent
5991
6221
  # Required. The name of the agent to update or create intents in. Supported
5992
6222
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -7919,8 +8149,12 @@ module Google
7919
8149
  execute_or_queue_command(command, &block)
7920
8150
  end
7921
8151
 
7922
- # Creates a new document. Note: The `projects.agent.knowledgeBases.documents`
7923
- # resource is deprecated; only use `projects.knowledgeBases.documents`.
8152
+ # Creates a new document. This method is a [long-running operation](https://
8153
+ # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
8154
+ # Operation` type has the following method-specific fields: - `metadata`:
8155
+ # KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.
8156
+ # knowledgeBases.documents` resource is deprecated; only use `projects.
8157
+ # knowledgeBases.documents`.
7924
8158
  # @param [String] parent
7925
8159
  # Required. The knowledge base to create a document for. Format: `projects//
7926
8160
  # locations//knowledgeBases/`.
@@ -7958,9 +8192,13 @@ module Google
7958
8192
  execute_or_queue_command(command, &block)
7959
8193
  end
7960
8194
 
7961
- # Deletes the specified document. Note: The `projects.agent.knowledgeBases.
7962
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
7963
- # .
8195
+ # Deletes the specified document. This method is a [long-running operation](
8196
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
8197
+ # returned `Operation` type has the following method-specific fields: - `
8198
+ # metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
8199
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
8200
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
8201
+ # only use `projects.knowledgeBases.documents`.
7964
8202
  # @param [String] name
7965
8203
  # Required. The name of the document to delete. Format: `projects//locations//
7966
8204
  # knowledgeBases//documents/`.
@@ -8026,7 +8264,10 @@ module Google
8026
8264
 
8027
8265
  # Create documents by importing data from external sources. Dialogflow supports
8028
8266
  # up to 350 documents in each request. If you try to import more, Dialogflow
8029
- # will return an error.
8267
+ # will return an error. This method is a [long-running operation](https://cloud.
8268
+ # google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
8269
+ # Operation` type has the following method-specific fields: - `metadata`:
8270
+ # KnowledgeOperationMetadata - `response`: ImportDocumentsResponse
8030
8271
  # @param [String] parent
8031
8272
  # Required. The knowledge base to import documents into. Format: `projects//
8032
8273
  # locations//knowledgeBases/`.
@@ -8111,9 +8352,12 @@ module Google
8111
8352
  execute_or_queue_command(command, &block)
8112
8353
  end
8113
8354
 
8114
- # Updates the specified document. Note: The `projects.agent.knowledgeBases.
8115
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
8116
- # .
8355
+ # Updates the specified document. This method is a [long-running operation](
8356
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
8357
+ # returned `Operation` type has the following method-specific fields: - `
8358
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
8359
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
8360
+ # projects.knowledgeBases.documents`.
8117
8361
  # @param [String] name
8118
8362
  # Optional. The document resource name. The name must be empty when creating a
8119
8363
  # document. Format: `projects//locations//knowledgeBases//documents/`.
@@ -8158,9 +8402,12 @@ module Google
8158
8402
  # effects because of internal implementation changes. Note: If the document
8159
8403
  # source is Google Cloud Storage URI, its metadata will be replaced with the
8160
8404
  # custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata`
8161
- # field is set to true in the request. Note: The `projects.agent.knowledgeBases.
8162
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
8163
- # .
8405
+ # field is set to true in the request. This method is a [long-running operation](
8406
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
8407
+ # returned `Operation` type has the following method-specific fields: - `
8408
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
8409
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
8410
+ # projects.knowledgeBases.documents`.
8164
8411
  # @param [String] name
8165
8412
  # Required. The name of the document to reload. Format: `projects//locations//
8166
8413
  # knowledgeBases//documents/`