google-apis-dialogflow_v2beta1 0.18.0 → 0.22.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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//
@@ -1158,9 +1210,12 @@ module Google
1158
1210
  # Processes a natural language query and returns structured, actionable data as
1159
1211
  # a result. This method is not idempotent, because it may cause contexts and
1160
1212
  # session entity types to be updated, which in turn might affect results of
1161
- # future queries. Note: Always use agent versions for production traffic. See [
1162
- # Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-
1163
- # versions).
1213
+ # future queries. If you might use [Agent Assist](https://cloud.google.com/
1214
+ # dialogflow/docs/#aa) or other CCAI products now or in the future, consider
1215
+ # using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has
1216
+ # additional functionality for Agent Assist and other CCAI products. Note:
1217
+ # Always use agent versions for production traffic. See [Versions and
1218
+ # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
1164
1219
  # @param [String] session
1165
1220
  # Required. The name of the session this query is sent to. Supported formats: - `
1166
1221
  # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `
@@ -1611,9 +1666,15 @@ module Google
1611
1666
  execute_or_queue_command(command, &block)
1612
1667
  end
1613
1668
 
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).
1669
+ # Deletes intents in the specified agent. This method is a [long-running
1670
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
1671
+ # operations). The returned `Operation` type has the following method-specific
1672
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
1673
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
1674
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
1675
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
1676
+ # it queries. See the [training documentation](https://cloud.google.com/
1677
+ # dialogflow/es/docs/training).
1617
1678
  # @param [String] parent
1618
1679
  # Required. The name of the agent to delete all entities types for. Supported
1619
1680
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -1647,9 +1708,14 @@ module Google
1647
1708
  execute_or_queue_command(command, &block)
1648
1709
  end
1649
1710
 
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).
1711
+ # Updates/Creates multiple intents in the specified agent. This method is a [
1712
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
1713
+ # running-operations). The returned `Operation` type has the following method-
1714
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
1715
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
1716
+ # : BatchUpdateIntentsResponse Note: You should always train an agent prior to
1717
+ # sending it queries. See the [training documentation](https://cloud.google.com/
1718
+ # dialogflow/es/docs/training).
1653
1719
  # @param [String] parent
1654
1720
  # Required. The name of the agent to update or create intents in. Supported
1655
1721
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -2098,8 +2164,12 @@ module Google
2098
2164
  execute_or_queue_command(command, &block)
2099
2165
  end
2100
2166
 
2101
- # Creates a new document. Note: The `projects.agent.knowledgeBases.documents`
2102
- # resource is deprecated; only use `projects.knowledgeBases.documents`.
2167
+ # Creates a new document. This method is a [long-running operation](https://
2168
+ # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
2169
+ # Operation` type has the following method-specific fields: - `metadata`:
2170
+ # KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.
2171
+ # knowledgeBases.documents` resource is deprecated; only use `projects.
2172
+ # knowledgeBases.documents`.
2103
2173
  # @param [String] parent
2104
2174
  # Required. The knowledge base to create a document for. Format: `projects//
2105
2175
  # locations//knowledgeBases/`.
@@ -2137,9 +2207,13 @@ module Google
2137
2207
  execute_or_queue_command(command, &block)
2138
2208
  end
2139
2209
 
2140
- # Deletes the specified document. Note: The `projects.agent.knowledgeBases.
2141
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
2142
- # .
2210
+ # Deletes the specified document. This method is a [long-running operation](
2211
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
2212
+ # returned `Operation` type has the following method-specific fields: - `
2213
+ # metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
2214
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
2215
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
2216
+ # only use `projects.knowledgeBases.documents`.
2143
2217
  # @param [String] name
2144
2218
  # Required. The name of the document to delete. Format: `projects//locations//
2145
2219
  # knowledgeBases//documents/`.
@@ -2254,9 +2328,12 @@ module Google
2254
2328
  execute_or_queue_command(command, &block)
2255
2329
  end
2256
2330
 
2257
- # Updates the specified document. Note: The `projects.agent.knowledgeBases.
2258
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
2259
- # .
2331
+ # Updates the specified document. This method is a [long-running operation](
2332
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
2333
+ # returned `Operation` type has the following method-specific fields: - `
2334
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
2335
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
2336
+ # projects.knowledgeBases.documents`.
2260
2337
  # @param [String] name
2261
2338
  # Optional. The document resource name. The name must be empty when creating a
2262
2339
  # document. Format: `projects//locations//knowledgeBases//documents/`.
@@ -2301,9 +2378,12 @@ module Google
2301
2378
  # effects because of internal implementation changes. Note: If the document
2302
2379
  # source is Google Cloud Storage URI, its metadata will be replaced with the
2303
2380
  # 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
- # .
2381
+ # field is set to true in the request. This method is a [long-running operation](
2382
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
2383
+ # returned `Operation` type has the following method-specific fields: - `
2384
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
2385
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
2386
+ # projects.knowledgeBases.documents`.
2307
2387
  # @param [String] name
2308
2388
  # Required. The name of the document to reload. Format: `projects//locations//
2309
2389
  # knowledgeBases//documents/`
@@ -2376,9 +2456,12 @@ module Google
2376
2456
  # Processes a natural language query and returns structured, actionable data as
2377
2457
  # a result. This method is not idempotent, because it may cause contexts and
2378
2458
  # session entity types to be updated, which in turn might affect results of
2379
- # future queries. Note: Always use agent versions for production traffic. See [
2380
- # Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-
2381
- # versions).
2459
+ # future queries. If you might use [Agent Assist](https://cloud.google.com/
2460
+ # dialogflow/docs/#aa) or other CCAI products now or in the future, consider
2461
+ # using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has
2462
+ # additional functionality for Agent Assist and other CCAI products. Note:
2463
+ # Always use agent versions for production traffic. See [Versions and
2464
+ # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
2382
2465
  # @param [String] session
2383
2466
  # Required. The name of the session this query is sent to. Supported formats: - `
2384
2467
  # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `
@@ -4112,8 +4195,12 @@ module Google
4112
4195
  execute_or_queue_command(command, &block)
4113
4196
  end
4114
4197
 
4115
- # Creates a new document. Note: The `projects.agent.knowledgeBases.documents`
4116
- # resource is deprecated; only use `projects.knowledgeBases.documents`.
4198
+ # Creates a new document. This method is a [long-running operation](https://
4199
+ # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
4200
+ # Operation` type has the following method-specific fields: - `metadata`:
4201
+ # KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.
4202
+ # knowledgeBases.documents` resource is deprecated; only use `projects.
4203
+ # knowledgeBases.documents`.
4117
4204
  # @param [String] parent
4118
4205
  # Required. The knowledge base to create a document for. Format: `projects//
4119
4206
  # locations//knowledgeBases/`.
@@ -4151,9 +4238,13 @@ module Google
4151
4238
  execute_or_queue_command(command, &block)
4152
4239
  end
4153
4240
 
4154
- # Deletes the specified document. Note: The `projects.agent.knowledgeBases.
4155
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
4156
- # .
4241
+ # Deletes the specified document. This method is a [long-running operation](
4242
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
4243
+ # returned `Operation` type has the following method-specific fields: - `
4244
+ # metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
4245
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
4246
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
4247
+ # only use `projects.knowledgeBases.documents`.
4157
4248
  # @param [String] name
4158
4249
  # Required. The name of the document to delete. Format: `projects//locations//
4159
4250
  # knowledgeBases//documents/`.
@@ -4219,7 +4310,10 @@ module Google
4219
4310
 
4220
4311
  # Create documents by importing data from external sources. Dialogflow supports
4221
4312
  # up to 350 documents in each request. If you try to import more, Dialogflow
4222
- # will return an error.
4313
+ # will return an error. This method is a [long-running operation](https://cloud.
4314
+ # google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
4315
+ # Operation` type has the following method-specific fields: - `metadata`:
4316
+ # KnowledgeOperationMetadata - `response`: ImportDocumentsResponse
4223
4317
  # @param [String] parent
4224
4318
  # Required. The knowledge base to import documents into. Format: `projects//
4225
4319
  # locations//knowledgeBases/`.
@@ -4304,9 +4398,12 @@ module Google
4304
4398
  execute_or_queue_command(command, &block)
4305
4399
  end
4306
4400
 
4307
- # Updates the specified document. Note: The `projects.agent.knowledgeBases.
4308
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
4309
- # .
4401
+ # Updates the specified document. This method is a [long-running operation](
4402
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
4403
+ # returned `Operation` type has the following method-specific fields: - `
4404
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
4405
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
4406
+ # projects.knowledgeBases.documents`.
4310
4407
  # @param [String] name
4311
4408
  # Optional. The document resource name. The name must be empty when creating a
4312
4409
  # document. Format: `projects//locations//knowledgeBases//documents/`.
@@ -4351,9 +4448,12 @@ module Google
4351
4448
  # effects because of internal implementation changes. Note: If the document
4352
4449
  # source is Google Cloud Storage URI, its metadata will be replaced with the
4353
4450
  # 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
- # .
4451
+ # field is set to true in the request. This method is a [long-running operation](
4452
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
4453
+ # returned `Operation` type has the following method-specific fields: - `
4454
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
4455
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
4456
+ # projects.knowledgeBases.documents`.
4357
4457
  # @param [String] name
4358
4458
  # Required. The name of the document to reload. Format: `projects//locations//
4359
4459
  # knowledgeBases//documents/`
@@ -4418,6 +4518,36 @@ module Google
4418
4518
  execute_or_queue_command(command, &block)
4419
4519
  end
4420
4520
 
4521
+ # Gets information about a location.
4522
+ # @param [String] name
4523
+ # Resource name for the location.
4524
+ # @param [String] fields
4525
+ # Selector specifying which fields to include in a partial response.
4526
+ # @param [String] quota_user
4527
+ # Available to use for quota purposes for server-side applications. Can be any
4528
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4529
+ # @param [Google::Apis::RequestOptions] options
4530
+ # Request-specific options
4531
+ #
4532
+ # @yield [result, err] Result & error if block supplied
4533
+ # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudLocationLocation] parsed result object
4534
+ # @yieldparam err [StandardError] error object if request failed
4535
+ #
4536
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudLocationLocation]
4537
+ #
4538
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4539
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4540
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4541
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
4542
+ command = make_simple_command(:get, 'v2beta1/{+name}', options)
4543
+ command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudLocationLocation::Representation
4544
+ command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudLocationLocation
4545
+ command.params['name'] = name unless name.nil?
4546
+ command.query['fields'] = fields unless fields.nil?
4547
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4548
+ execute_or_queue_command(command, &block)
4549
+ end
4550
+
4421
4551
  # Retrieves the specified agent.
4422
4552
  # @param [String] parent
4423
4553
  # Required. The project that the agent to fetch is associated with. Format: `
@@ -4449,6 +4579,49 @@ module Google
4449
4579
  execute_or_queue_command(command, &block)
4450
4580
  end
4451
4581
 
4582
+ # Lists information about the supported locations for this service.
4583
+ # @param [String] name
4584
+ # The resource that owns the locations collection, if applicable.
4585
+ # @param [String] filter
4586
+ # A filter to narrow down results to a preferred subset. The filtering language
4587
+ # accepts strings like "displayName=tokyo", and is documented in more detail in [
4588
+ # AIP-160](https://google.aip.dev/160).
4589
+ # @param [Fixnum] page_size
4590
+ # The maximum number of results to return. If not set, the service selects a
4591
+ # default.
4592
+ # @param [String] page_token
4593
+ # A page token received from the `next_page_token` field in the response. Send
4594
+ # that page token to receive the subsequent page.
4595
+ # @param [String] fields
4596
+ # Selector specifying which fields to include in a partial response.
4597
+ # @param [String] quota_user
4598
+ # Available to use for quota purposes for server-side applications. Can be any
4599
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4600
+ # @param [Google::Apis::RequestOptions] options
4601
+ # Request-specific options
4602
+ #
4603
+ # @yield [result, err] Result & error if block supplied
4604
+ # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse] parsed result object
4605
+ # @yieldparam err [StandardError] error object if request failed
4606
+ #
4607
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse]
4608
+ #
4609
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4610
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4611
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4612
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4613
+ command = make_simple_command(:get, 'v2beta1/{+name}/locations', options)
4614
+ command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse::Representation
4615
+ command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse
4616
+ command.params['name'] = name unless name.nil?
4617
+ command.query['filter'] = filter unless filter.nil?
4618
+ command.query['pageSize'] = page_size unless page_size.nil?
4619
+ command.query['pageToken'] = page_token unless page_token.nil?
4620
+ command.query['fields'] = fields unless fields.nil?
4621
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4622
+ execute_or_queue_command(command, &block)
4623
+ end
4624
+
4452
4625
  # Creates/updates the specified agent. Note: You should always train an agent
4453
4626
  # prior to sending it queries. See the [training documentation](https://cloud.
4454
4627
  # google.com/dialogflow/es/docs/training).
@@ -4488,7 +4661,12 @@ module Google
4488
4661
  execute_or_queue_command(command, &block)
4489
4662
  end
4490
4663
 
4491
- # Exports the specified agent to a ZIP file.
4664
+ # Exports the specified agent to a ZIP file. This method is a [long-running
4665
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
4666
+ # operations). The returned `Operation` type has the following method-specific
4667
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
4668
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
4669
+ # ExportAgentResponse
4492
4670
  # @param [String] parent
4493
4671
  # Required. The project that the agent to export is associated with. Format: `
4494
4672
  # projects/` or `projects//locations/`.
@@ -4597,9 +4775,16 @@ module Google
4597
4775
  # the import, the imported draft agent will be trained automatically (unless
4598
4776
  # disabled in agent settings). However, once the import is done, training may
4599
4777
  # 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).
4778
+ # returns in order to train explicitly. This method is a [long-running operation]
4779
+ # (https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
4780
+ # returned `Operation` type has the following method-specific fields: - `
4781
+ # metadata`: An empty [Struct message](https://developers.google.com/protocol-
4782
+ # buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message]
4783
+ # (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
4784
+ # empty) The operation only tracks when importing is complete, not when it is
4785
+ # done training. Note: You should always train an agent prior to sending it
4786
+ # queries. See the [training documentation](https://cloud.google.com/dialogflow/
4787
+ # es/docs/training).
4603
4788
  # @param [String] parent
4604
4789
  # Required. The project that the agent to import is associated with. Format: `
4605
4790
  # projects/` or `projects//locations/`.
@@ -4638,9 +4823,16 @@ module Google
4638
4823
  # are deleted. After the restore, the restored draft agent will be trained
4639
4824
  # automatically (unless disabled in agent settings). However, once the restore
4640
4825
  # 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).
4826
+ # for the operation it returns in order to train explicitly. This method is a [
4827
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
4828
+ # running-operations). The returned `Operation` type has the following method-
4829
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
4830
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
4831
+ # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
4832
+ # reference/google.protobuf#empty) The operation only tracks when restoring is
4833
+ # complete, not when it is done training. Note: You should always train an agent
4834
+ # prior to sending it queries. See the [training documentation](https://cloud.
4835
+ # google.com/dialogflow/es/docs/training).
4644
4836
  # @param [String] parent
4645
4837
  # Required. The project that the agent to restore is associated with. Format: `
4646
4838
  # projects/` or `projects//locations/`.
@@ -4716,9 +4908,14 @@ module Google
4716
4908
  execute_or_queue_command(command, &block)
4717
4909
  end
4718
4910
 
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).
4911
+ # Trains the specified agent. This method is a [long-running operation](https://
4912
+ # cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned
4913
+ # `Operation` type has the following method-specific fields: - `metadata`: An
4914
+ # empty [Struct message](https://developers.google.com/protocol-buffers/docs/
4915
+ # reference/google.protobuf#struct) - `response`: An [Empty message](https://
4916
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
4917
+ # Note: You should always train an agent prior to sending it queries. See the [
4918
+ # training documentation](https://cloud.google.com/dialogflow/es/docs/training).
4722
4919
  # @param [String] parent
4723
4920
  # Required. The project that the agent to train is associated with. Format: `
4724
4921
  # projects/` or `projects//locations/`.
@@ -4791,9 +4988,15 @@ module Google
4791
4988
  execute_or_queue_command(command, &block)
4792
4989
  end
4793
4990
 
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).
4991
+ # Deletes entity types in the specified agent. This method is a [long-running
4992
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
4993
+ # operations). The returned `Operation` type has the following method-specific
4994
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
4995
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
4996
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
4997
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
4998
+ # it queries. See the [training documentation](https://cloud.google.com/
4999
+ # dialogflow/es/docs/training).
4797
5000
  # @param [String] parent
4798
5001
  # Required. The name of the agent to delete all entities types for. Supported
4799
5002
  # formats: - `projects//agent`, - `projects//locations//agent`.
@@ -4827,9 +5030,14 @@ module Google
4827
5030
  execute_or_queue_command(command, &block)
4828
5031
  end
4829
5032
 
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).
5033
+ # Updates/Creates multiple entity types in the specified agent. This method is a
5034
+ # [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
5035
+ # running-operations). The returned `Operation` type has the following method-
5036
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
5037
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
5038
+ # : BatchUpdateEntityTypesResponse Note: You should always train an agent prior
5039
+ # to sending it queries. See the [training documentation](https://cloud.google.
5040
+ # com/dialogflow/es/docs/training).
4833
5041
  # @param [String] parent
4834
5042
  # Required. The name of the agent to update or create entity types in. Supported
4835
5043
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -5066,9 +5274,15 @@ module Google
5066
5274
  execute_or_queue_command(command, &block)
5067
5275
  end
5068
5276
 
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).
5277
+ # Creates multiple new entities in the specified entity type. This method is a [
5278
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
5279
+ # running-operations). The returned `Operation` type has the following method-
5280
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
5281
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
5282
+ # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
5283
+ # reference/google.protobuf#empty) Note: You should always train an agent prior
5284
+ # to sending it queries. See the [training documentation](https://cloud.google.
5285
+ # com/dialogflow/es/docs/training).
5072
5286
  # @param [String] parent
5073
5287
  # Required. The name of the entity type to create entities in. Supported formats:
5074
5288
  # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`
@@ -5102,9 +5316,15 @@ module Google
5102
5316
  execute_or_queue_command(command, &block)
5103
5317
  end
5104
5318
 
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).
5319
+ # Deletes entities in the specified entity type. This method is a [long-running
5320
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
5321
+ # operations). The returned `Operation` type has the following method-specific
5322
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
5323
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
5324
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
5325
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
5326
+ # it queries. See the [training documentation](https://cloud.google.com/
5327
+ # dialogflow/es/docs/training).
5108
5328
  # @param [String] parent
5109
5329
  # Required. The name of the entity type to delete entries for. Supported formats:
5110
5330
  # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`
@@ -5142,7 +5362,12 @@ module Google
5142
5362
  # does not affect entities in the entity type that aren't explicitly specified
5143
5363
  # in the request. Note: You should always train an agent prior to sending it
5144
5364
  # queries. See the [training documentation](https://cloud.google.com/dialogflow/
5145
- # es/docs/training).
5365
+ # es/docs/training). This method is a [long-running operation](https://cloud.
5366
+ # google.com/dialogflow/es/docs/how/long-running-operations). The returned `
5367
+ # Operation` type has the following method-specific fields: - `metadata`: An
5368
+ # empty [Struct message](https://developers.google.com/protocol-buffers/docs/
5369
+ # reference/google.protobuf#struct) - `response`: An [Empty message](https://
5370
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
5146
5371
  # @param [String] parent
5147
5372
  # Required. The name of the entity type to update or create entities in.
5148
5373
  # Supported formats: - `projects//agent/entityTypes/` - `projects//locations//
@@ -5495,9 +5720,12 @@ module Google
5495
5720
  # Processes a natural language query and returns structured, actionable data as
5496
5721
  # a result. This method is not idempotent, because it may cause contexts and
5497
5722
  # session entity types to be updated, which in turn might affect results of
5498
- # future queries. Note: Always use agent versions for production traffic. See [
5499
- # Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-
5500
- # versions).
5723
+ # future queries. If you might use [Agent Assist](https://cloud.google.com/
5724
+ # dialogflow/docs/#aa) or other CCAI products now or in the future, consider
5725
+ # using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has
5726
+ # additional functionality for Agent Assist and other CCAI products. Note:
5727
+ # Always use agent versions for production traffic. See [Versions and
5728
+ # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
5501
5729
  # @param [String] session
5502
5730
  # Required. The name of the session this query is sent to. Supported formats: - `
5503
5731
  # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `
@@ -5948,9 +6176,15 @@ module Google
5948
6176
  execute_or_queue_command(command, &block)
5949
6177
  end
5950
6178
 
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).
6179
+ # Deletes intents in the specified agent. This method is a [long-running
6180
+ # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
6181
+ # operations). The returned `Operation` type has the following method-specific
6182
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
6183
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
6184
+ # Empty message](https://developers.google.com/protocol-buffers/docs/reference/
6185
+ # google.protobuf#empty) Note: You should always train an agent prior to sending
6186
+ # it queries. See the [training documentation](https://cloud.google.com/
6187
+ # dialogflow/es/docs/training).
5954
6188
  # @param [String] parent
5955
6189
  # Required. The name of the agent to delete all entities types for. Supported
5956
6190
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -5984,9 +6218,14 @@ module Google
5984
6218
  execute_or_queue_command(command, &block)
5985
6219
  end
5986
6220
 
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).
6221
+ # Updates/Creates multiple intents in the specified agent. This method is a [
6222
+ # long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
6223
+ # running-operations). The returned `Operation` type has the following method-
6224
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
6225
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
6226
+ # : BatchUpdateIntentsResponse Note: You should always train an agent prior to
6227
+ # sending it queries. See the [training documentation](https://cloud.google.com/
6228
+ # dialogflow/es/docs/training).
5990
6229
  # @param [String] parent
5991
6230
  # Required. The name of the agent to update or create intents in. Supported
5992
6231
  # formats: - `projects//agent` - `projects//locations//agent`
@@ -6277,9 +6516,12 @@ module Google
6277
6516
  # Processes a natural language query and returns structured, actionable data as
6278
6517
  # a result. This method is not idempotent, because it may cause contexts and
6279
6518
  # session entity types to be updated, which in turn might affect results of
6280
- # future queries. Note: Always use agent versions for production traffic. See [
6281
- # Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-
6282
- # versions).
6519
+ # future queries. If you might use [Agent Assist](https://cloud.google.com/
6520
+ # dialogflow/docs/#aa) or other CCAI products now or in the future, consider
6521
+ # using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has
6522
+ # additional functionality for Agent Assist and other CCAI products. Note:
6523
+ # Always use agent versions for production traffic. See [Versions and
6524
+ # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
6283
6525
  # @param [String] session
6284
6526
  # Required. The name of the session this query is sent to. Supported formats: - `
6285
6527
  # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `
@@ -7919,8 +8161,12 @@ module Google
7919
8161
  execute_or_queue_command(command, &block)
7920
8162
  end
7921
8163
 
7922
- # Creates a new document. Note: The `projects.agent.knowledgeBases.documents`
7923
- # resource is deprecated; only use `projects.knowledgeBases.documents`.
8164
+ # Creates a new document. This method is a [long-running operation](https://
8165
+ # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
8166
+ # Operation` type has the following method-specific fields: - `metadata`:
8167
+ # KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.
8168
+ # knowledgeBases.documents` resource is deprecated; only use `projects.
8169
+ # knowledgeBases.documents`.
7924
8170
  # @param [String] parent
7925
8171
  # Required. The knowledge base to create a document for. Format: `projects//
7926
8172
  # locations//knowledgeBases/`.
@@ -7958,9 +8204,13 @@ module Google
7958
8204
  execute_or_queue_command(command, &block)
7959
8205
  end
7960
8206
 
7961
- # Deletes the specified document. Note: The `projects.agent.knowledgeBases.
7962
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
7963
- # .
8207
+ # Deletes the specified document. This method is a [long-running operation](
8208
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
8209
+ # returned `Operation` type has the following method-specific fields: - `
8210
+ # metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
8211
+ # developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
8212
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
8213
+ # only use `projects.knowledgeBases.documents`.
7964
8214
  # @param [String] name
7965
8215
  # Required. The name of the document to delete. Format: `projects//locations//
7966
8216
  # knowledgeBases//documents/`.
@@ -8026,7 +8276,10 @@ module Google
8026
8276
 
8027
8277
  # Create documents by importing data from external sources. Dialogflow supports
8028
8278
  # up to 350 documents in each request. If you try to import more, Dialogflow
8029
- # will return an error.
8279
+ # will return an error. This method is a [long-running operation](https://cloud.
8280
+ # google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
8281
+ # Operation` type has the following method-specific fields: - `metadata`:
8282
+ # KnowledgeOperationMetadata - `response`: ImportDocumentsResponse
8030
8283
  # @param [String] parent
8031
8284
  # Required. The knowledge base to import documents into. Format: `projects//
8032
8285
  # locations//knowledgeBases/`.
@@ -8111,9 +8364,12 @@ module Google
8111
8364
  execute_or_queue_command(command, &block)
8112
8365
  end
8113
8366
 
8114
- # Updates the specified document. Note: The `projects.agent.knowledgeBases.
8115
- # documents` resource is deprecated; only use `projects.knowledgeBases.documents`
8116
- # .
8367
+ # Updates the specified document. This method is a [long-running operation](
8368
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
8369
+ # returned `Operation` type has the following method-specific fields: - `
8370
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
8371
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
8372
+ # projects.knowledgeBases.documents`.
8117
8373
  # @param [String] name
8118
8374
  # Optional. The document resource name. The name must be empty when creating a
8119
8375
  # document. Format: `projects//locations//knowledgeBases//documents/`.
@@ -8158,9 +8414,12 @@ module Google
8158
8414
  # effects because of internal implementation changes. Note: If the document
8159
8415
  # source is Google Cloud Storage URI, its metadata will be replaced with the
8160
8416
  # 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
- # .
8417
+ # field is set to true in the request. This method is a [long-running operation](
8418
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
8419
+ # returned `Operation` type has the following method-specific fields: - `
8420
+ # metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `
8421
+ # projects.agent.knowledgeBases.documents` resource is deprecated; only use `
8422
+ # projects.knowledgeBases.documents`.
8164
8423
  # @param [String] name
8165
8424
  # Required. The name of the document to reload. Format: `projects//locations//
8166
8425
  # knowledgeBases//documents/`