google-apis-dialogflow_v3 0.117.0 → 0.119.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.
@@ -52,9 +52,8 @@ module Google
52
52
  @batch_path = 'batch'
53
53
  end
54
54
 
55
- # Gets information about a location.
55
+ #
56
56
  # @param [String] name
57
- # Resource name for the location.
58
57
  # @param [String] fields
59
58
  # Selector specifying which fields to include in a partial response.
60
59
  # @param [String] quota_user
@@ -82,22 +81,12 @@ module Google
82
81
  execute_or_queue_command(command, &block)
83
82
  end
84
83
 
85
- # Lists information about the supported locations for this service.
84
+ #
86
85
  # @param [String] name
87
- # The resource that owns the locations collection, if applicable.
88
86
  # @param [Array<String>, String] extra_location_types
89
- # Optional. Do not use this field. It is unsupported and is ignored unless
90
- # explicitly documented otherwise. This is primarily for internal usage.
91
87
  # @param [String] filter
92
- # A filter to narrow down results to a preferred subset. The filtering language
93
- # accepts strings like `"displayName=tokyo"`, and is documented in more detail
94
- # in [AIP-160](https://google.aip.dev/160).
95
88
  # @param [Fixnum] page_size
96
- # The maximum number of results to return. If not set, the service selects a
97
- # default.
98
89
  # @param [String] page_token
99
- # A page token received from the `next_page_token` field in the response. Send
100
- # that page token to receive the subsequent page.
101
90
  # @param [String] fields
102
91
  # Selector specifying which fields to include in a partial response.
103
92
  # @param [String] quota_user
@@ -129,11 +118,8 @@ module Google
129
118
  execute_or_queue_command(command, &block)
130
119
  end
131
120
 
132
- # Creates an agent in the specified location. Note: You should always train
133
- # flows prior to sending them queries. See the [training documentation](https://
134
- # cloud.google.com/dialogflow/cx/docs/concept/training).
121
+ #
135
122
  # @param [String] parent
136
- # Required. The location to create a agent for. Format: `projects//locations/`.
137
123
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent] google_cloud_dialogflow_cx_v3_agent_object
138
124
  # @param [String] fields
139
125
  # Selector specifying which fields to include in a partial response.
@@ -164,10 +150,8 @@ module Google
164
150
  execute_or_queue_command(command, &block)
165
151
  end
166
152
 
167
- # Deletes the specified agent.
153
+ #
168
154
  # @param [String] name
169
- # Required. The name of the agent to delete. Format: `projects//locations//
170
- # agents/`.
171
155
  # @param [String] fields
172
156
  # Selector specifying which fields to include in a partial response.
173
157
  # @param [String] quota_user
@@ -195,15 +179,8 @@ module Google
195
179
  execute_or_queue_command(command, &block)
196
180
  end
197
181
 
198
- # Exports the specified agent to a binary file. This method is a [long-running
199
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
200
- # operation). The returned `Operation` type has the following method-specific
201
- # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
202
- # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
203
- # ExportAgentResponse
182
+ #
204
183
  # @param [String] name
205
- # Required. The name of the agent to export. Format: `projects//locations//
206
- # agents/`.
207
184
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportAgentRequest] google_cloud_dialogflow_cx_v3_export_agent_request_object
208
185
  # @param [String] fields
209
186
  # Selector specifying which fields to include in a partial response.
@@ -234,9 +211,8 @@ module Google
234
211
  execute_or_queue_command(command, &block)
235
212
  end
236
213
 
237
- # Retrieves the specified agent.
214
+ #
238
215
  # @param [String] name
239
- # Required. The name of the agent. Format: `projects//locations//agents/`.
240
216
  # @param [String] fields
241
217
  # Selector specifying which fields to include in a partial response.
242
218
  # @param [String] quota_user
@@ -264,11 +240,9 @@ module Google
264
240
  execute_or_queue_command(command, &block)
265
241
  end
266
242
 
267
- # Gets the generative settings for the agent.
243
+ #
268
244
  # @param [String] name
269
- # Required. Format: `projects//locations//agents//generativeSettings`.
270
245
  # @param [String] language_code
271
- # Required. Language code of the generative settings.
272
246
  # @param [String] fields
273
247
  # Selector specifying which fields to include in a partial response.
274
248
  # @param [String] quota_user
@@ -297,13 +271,9 @@ module Google
297
271
  execute_or_queue_command(command, &block)
298
272
  end
299
273
 
300
- # Gets the latest agent validation result. Agent validation is performed when
301
- # ValidateAgent is called.
274
+ #
302
275
  # @param [String] name
303
- # Required. The agent name. Format: `projects//locations//agents//
304
- # validationResult`.
305
276
  # @param [String] language_code
306
- # If not specified, the agent's default language is used.
307
277
  # @param [String] fields
308
278
  # Selector specifying which fields to include in a partial response.
309
279
  # @param [String] quota_user
@@ -332,14 +302,10 @@ module Google
332
302
  execute_or_queue_command(command, &block)
333
303
  end
334
304
 
335
- # Returns the list of all agents in the specified location.
305
+ #
336
306
  # @param [String] parent
337
- # Required. The location to list all agents for. Format: `projects//locations/`.
338
307
  # @param [Fixnum] page_size
339
- # The maximum number of items to return in a single page. By default 100 and at
340
- # most 1000.
341
308
  # @param [String] page_token
342
- # The next_page_token value returned from a previous list request.
343
309
  # @param [String] fields
344
310
  # Selector specifying which fields to include in a partial response.
345
311
  # @param [String] quota_user
@@ -369,17 +335,10 @@ module Google
369
335
  execute_or_queue_command(command, &block)
370
336
  end
371
337
 
372
- # Updates the specified agent. Note: You should always train flows prior to
373
- # sending them queries. See the [training documentation](https://cloud.google.
374
- # com/dialogflow/cx/docs/concept/training).
338
+ #
375
339
  # @param [String] name
376
- # The unique identifier of the agent. Required for the Agents.UpdateAgent method.
377
- # Agents.CreateAgent populates the name automatically. Format: `projects//
378
- # locations//agents/`.
379
340
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent] google_cloud_dialogflow_cx_v3_agent_object
380
341
  # @param [String] update_mask
381
- # The mask to control which fields get updated. If the mask is not present, all
382
- # fields will be updated.
383
342
  # @param [String] fields
384
343
  # Selector specifying which fields to include in a partial response.
385
344
  # @param [String] quota_user
@@ -410,20 +369,8 @@ module Google
410
369
  execute_or_queue_command(command, &block)
411
370
  end
412
371
 
413
- # Restores the specified agent from a binary file. Replaces the current agent
414
- # with a new one. Note that all existing resources in agent (e.g. intents,
415
- # entity types, flows) will be removed. This method is a [long-running operation]
416
- # (https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
417
- # returned `Operation` type has the following method-specific fields: - `
418
- # metadata`: An empty [Struct message](https://developers.google.com/protocol-
419
- # buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message]
420
- # (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
421
- # empty) Note: You should always train flows prior to sending them queries. See
422
- # the [training documentation](https://cloud.google.com/dialogflow/cx/docs/
423
- # concept/training).
372
+ #
424
373
  # @param [String] name
425
- # Required. The name of the agent to restore into. Format: `projects//locations//
426
- # agents/`.
427
374
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RestoreAgentRequest] google_cloud_dialogflow_cx_v3_restore_agent_request_object
428
375
  # @param [String] fields
429
376
  # Selector specifying which fields to include in a partial response.
@@ -454,13 +401,10 @@ module Google
454
401
  execute_or_queue_command(command, &block)
455
402
  end
456
403
 
457
- # Updates the generative settings for the agent.
404
+ #
458
405
  # @param [String] name
459
- # Format: `projects//locations//agents//generativeSettings`.
460
406
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings] google_cloud_dialogflow_cx_v3_generative_settings_object
461
407
  # @param [String] update_mask
462
- # Optional. The mask to control which fields get updated. If the mask is not
463
- # present, all fields will be updated.
464
408
  # @param [String] fields
465
409
  # Selector specifying which fields to include in a partial response.
466
410
  # @param [String] quota_user
@@ -491,11 +435,8 @@ module Google
491
435
  execute_or_queue_command(command, &block)
492
436
  end
493
437
 
494
- # Validates the specified agent and creates or updates validation results. The
495
- # agent in draft version is validated. Please call this API after the training
496
- # is completed to get the complete validation results.
438
+ #
497
439
  # @param [String] name
498
- # Required. The agent to validate. Format: `projects//locations//agents/`.
499
440
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateAgentRequest] google_cloud_dialogflow_cx_v3_validate_agent_request_object
500
441
  # @param [String] fields
501
442
  # Selector specifying which fields to include in a partial response.
@@ -526,10 +467,8 @@ module Google
526
467
  execute_or_queue_command(command, &block)
527
468
  end
528
469
 
529
- # Retrieves the specified Changelog.
470
+ #
530
471
  # @param [String] name
531
- # Required. The name of the changelog to get. Format: `projects//locations//
532
- # agents//changelogs/`.
533
472
  # @param [String] fields
534
473
  # Selector specifying which fields to include in a partial response.
535
474
  # @param [String] quota_user
@@ -557,26 +496,11 @@ module Google
557
496
  execute_or_queue_command(command, &block)
558
497
  end
559
498
 
560
- # Returns the list of Changelogs.
499
+ #
561
500
  # @param [String] parent
562
- # Required. The agent containing the changelogs. Format: `projects//locations//
563
- # agents/`.
564
501
  # @param [String] filter
565
- # The filter string. Supports filter by user_email, resource, type and
566
- # create_time. Some examples: 1. By user email: user_email = "someone@google.com"
567
- # 2. By resource name: resource = "projects/123/locations/global/agents/456/
568
- # flows/789" 3. By resource display name: display_name = "my agent" 4. By action:
569
- # action = "Create" 5. By type: type = "flows" 6. By create time. Currently
570
- # predicates on `create_time` and `create_time_epoch_seconds` are supported:
571
- # create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.
572
- # 01Z 7. Combination of above filters: resource = "projects/123/locations/global/
573
- # agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <=
574
- # 2017-01-15T01:30:15.01Z
575
502
  # @param [Fixnum] page_size
576
- # The maximum number of items to return in a single page. By default 100 and at
577
- # most 1000.
578
503
  # @param [String] page_token
579
- # The next_page_token value returned from a previous list request.
580
504
  # @param [String] fields
581
505
  # Selector specifying which fields to include in a partial response.
582
506
  # @param [String] quota_user
@@ -607,19 +531,10 @@ module Google
607
531
  execute_or_queue_command(command, &block)
608
532
  end
609
533
 
610
- # Creates an entity type in the specified agent. Note: You should always train a
611
- # flow prior to sending it queries. See the [training documentation](https://
612
- # cloud.google.com/dialogflow/cx/docs/concept/training).
534
+ #
613
535
  # @param [String] parent
614
- # Required. The agent to create a entity type for. Format: `projects//locations//
615
- # agents/`.
616
536
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType] google_cloud_dialogflow_cx_v3_entity_type_object
617
537
  # @param [String] language_code
618
- # The language of the following fields in `entity_type`: * `EntityType.entities.
619
- # value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value`
620
- # If not specified, the agent's default language is used. [Many languages](https:
621
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
622
- # languages must be enabled in the agent before they can be used.
623
538
  # @param [String] fields
624
539
  # Selector specifying which fields to include in a partial response.
625
540
  # @param [String] quota_user
@@ -650,19 +565,9 @@ module Google
650
565
  execute_or_queue_command(command, &block)
651
566
  end
652
567
 
653
- # Deletes the specified entity type. Note: You should always train a flow prior
654
- # to sending it queries. See the [training documentation](https://cloud.google.
655
- # com/dialogflow/cx/docs/concept/training).
568
+ #
656
569
  # @param [String] name
657
- # Required. The name of the entity type to delete. Format: `projects//locations//
658
- # agents//entityTypes/`.
659
570
  # @param [Boolean] force
660
- # This field has no effect for entity type not being used. For entity types that
661
- # are used by intents or pages: * If `force` is set to false, an error will be
662
- # returned with message indicating the referencing resources. * If `force` is
663
- # set to true, Dialogflow will remove the entity type, as well as any references
664
- # to the entity type (i.e. Page parameter of the entity type will be changed to '
665
- # @sys.any' and intent parameter of the entity type will be removed).
666
571
  # @param [String] fields
667
572
  # Selector specifying which fields to include in a partial response.
668
573
  # @param [String] quota_user
@@ -691,10 +596,8 @@ module Google
691
596
  execute_or_queue_command(command, &block)
692
597
  end
693
598
 
694
- # Exports the selected entity types.
599
+ #
695
600
  # @param [String] parent
696
- # Required. The name of the parent agent to export entity types. Format: `
697
- # projects//locations//agents/`.
698
601
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportEntityTypesRequest] google_cloud_dialogflow_cx_v3_export_entity_types_request_object
699
602
  # @param [String] fields
700
603
  # Selector specifying which fields to include in a partial response.
@@ -725,17 +628,9 @@ module Google
725
628
  execute_or_queue_command(command, &block)
726
629
  end
727
630
 
728
- # Retrieves the specified entity type.
631
+ #
729
632
  # @param [String] name
730
- # Required. The name of the entity type. Format: `projects//locations//agents//
731
- # entityTypes/`.
732
633
  # @param [String] language_code
733
- # The language to retrieve the entity type for. The following fields are
734
- # language dependent: * `EntityType.entities.value` * `EntityType.entities.
735
- # synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's
736
- # default language is used. [Many languages](https://cloud.google.com/dialogflow/
737
- # cx/docs/reference/language) are supported. Note: languages must be enabled in
738
- # the agent before they can be used.
739
634
  # @param [String] fields
740
635
  # Selector specifying which fields to include in a partial response.
741
636
  # @param [String] quota_user
@@ -764,10 +659,8 @@ module Google
764
659
  execute_or_queue_command(command, &block)
765
660
  end
766
661
 
767
- # Imports the specified entitytypes into the agent.
662
+ #
768
663
  # @param [String] parent
769
- # Required. The agent to import the entity types into. Format: `projects//
770
- # locations//agents/`.
771
664
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportEntityTypesRequest] google_cloud_dialogflow_cx_v3_import_entity_types_request_object
772
665
  # @param [String] fields
773
666
  # Selector specifying which fields to include in a partial response.
@@ -798,22 +691,11 @@ module Google
798
691
  execute_or_queue_command(command, &block)
799
692
  end
800
693
 
801
- # Returns the list of all entity types in the specified agent.
694
+ #
802
695
  # @param [String] parent
803
- # Required. The agent to list all entity types for. Format: `projects//locations/
804
- # /agents/`.
805
696
  # @param [String] language_code
806
- # The language to list entity types for. The following fields are language
807
- # dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `
808
- # EntityType.excluded_phrases.value` If not specified, the agent's default
809
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
810
- # reference/language) are supported. Note: languages must be enabled in the
811
- # agent before they can be used.
812
697
  # @param [Fixnum] page_size
813
- # The maximum number of items to return in a single page. By default 100 and at
814
- # most 1000.
815
698
  # @param [String] page_token
816
- # The next_page_token value returned from a previous list request.
817
699
  # @param [String] fields
818
700
  # Selector specifying which fields to include in a partial response.
819
701
  # @param [String] quota_user
@@ -844,21 +726,11 @@ module Google
844
726
  execute_or_queue_command(command, &block)
845
727
  end
846
728
 
847
- # Updates the specified entity type. Note: You should always train a flow prior
848
- # to sending it queries. See the [training documentation](https://cloud.google.
849
- # com/dialogflow/cx/docs/concept/training).
729
+ #
850
730
  # @param [String] name
851
- # The unique identifier of the entity type. Required for EntityTypes.
852
- # UpdateEntityType. Format: `projects//locations//agents//entityTypes/`.
853
731
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType] google_cloud_dialogflow_cx_v3_entity_type_object
854
732
  # @param [String] language_code
855
- # The language of the following fields in `entity_type`: * `EntityType.entities.
856
- # value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value`
857
- # If not specified, the agent's default language is used. [Many languages](https:
858
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
859
- # languages must be enabled in the agent before they can be used.
860
733
  # @param [String] update_mask
861
- # The mask to control which fields get updated.
862
734
  # @param [String] fields
863
735
  # Selector specifying which fields to include in a partial response.
864
736
  # @param [String] quota_user
@@ -890,15 +762,8 @@ module Google
890
762
  execute_or_queue_command(command, &block)
891
763
  end
892
764
 
893
- # Creates an Environment in the specified Agent. This method is a [long-running
894
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
895
- # operation). The returned `Operation` type has the following method-specific
896
- # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
897
- # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
898
- # Environment
765
+ #
899
766
  # @param [String] parent
900
- # Required. The Agent to create an Environment for. Format: `projects//locations/
901
- # /agents/`.
902
767
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment] google_cloud_dialogflow_cx_v3_environment_object
903
768
  # @param [String] fields
904
769
  # Selector specifying which fields to include in a partial response.
@@ -929,10 +794,8 @@ module Google
929
794
  execute_or_queue_command(command, &block)
930
795
  end
931
796
 
932
- # Deletes the specified Environment.
797
+ #
933
798
  # @param [String] name
934
- # Required. The name of the Environment to delete. Format: `projects//locations//
935
- # agents//environments/`.
936
799
  # @param [String] fields
937
800
  # Selector specifying which fields to include in a partial response.
938
801
  # @param [String] quota_user
@@ -960,13 +823,8 @@ module Google
960
823
  execute_or_queue_command(command, &block)
961
824
  end
962
825
 
963
- # Deploys a flow to the specified Environment. This method is a [long-running
964
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
965
- # operation). The returned `Operation` type has the following method-specific
966
- # fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse
826
+ #
967
827
  # @param [String] environment
968
- # Required. The environment to deploy the flow to. Format: `projects//locations//
969
- # agents//environments/`.
970
828
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DeployFlowRequest] google_cloud_dialogflow_cx_v3_deploy_flow_request_object
971
829
  # @param [String] fields
972
830
  # Selector specifying which fields to include in a partial response.
@@ -997,10 +855,8 @@ module Google
997
855
  execute_or_queue_command(command, &block)
998
856
  end
999
857
 
1000
- # Retrieves the specified Environment.
858
+ #
1001
859
  # @param [String] name
1002
- # Required. The name of the Environment. Format: `projects//locations//agents//
1003
- # environments/`.
1004
860
  # @param [String] fields
1005
861
  # Selector specifying which fields to include in a partial response.
1006
862
  # @param [String] quota_user
@@ -1028,15 +884,10 @@ module Google
1028
884
  execute_or_queue_command(command, &block)
1029
885
  end
1030
886
 
1031
- # Returns the list of all environments in the specified Agent.
887
+ #
1032
888
  # @param [String] parent
1033
- # Required. The Agent to list all environments for. Format: `projects//locations/
1034
- # /agents/`.
1035
889
  # @param [Fixnum] page_size
1036
- # The maximum number of items to return in a single page. By default 20 and at
1037
- # most 100.
1038
890
  # @param [String] page_token
1039
- # The next_page_token value returned from a previous list request.
1040
891
  # @param [String] fields
1041
892
  # Selector specifying which fields to include in a partial response.
1042
893
  # @param [String] quota_user
@@ -1066,15 +917,10 @@ module Google
1066
917
  execute_or_queue_command(command, &block)
1067
918
  end
1068
919
 
1069
- # Looks up the history of the specified Environment.
920
+ #
1070
921
  # @param [String] name
1071
- # Required. Resource name of the environment to look up the history for. Format:
1072
- # `projects//locations//agents//environments/`.
1073
922
  # @param [Fixnum] page_size
1074
- # The maximum number of items to return in a single page. By default 100 and at
1075
- # most 1000.
1076
923
  # @param [String] page_token
1077
- # The next_page_token value returned from a previous list request.
1078
924
  # @param [String] fields
1079
925
  # Selector specifying which fields to include in a partial response.
1080
926
  # @param [String] quota_user
@@ -1104,17 +950,10 @@ module Google
1104
950
  execute_or_queue_command(command, &block)
1105
951
  end
1106
952
 
1107
- # Updates the specified Environment. This method is a [long-running operation](
1108
- # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
1109
- # returned `Operation` type has the following method-specific fields: - `
1110
- # metadata`: An empty [Struct message](https://developers.google.com/protocol-
1111
- # buffers/docs/reference/google.protobuf#struct) - `response`: Environment
953
+ #
1112
954
  # @param [String] name
1113
- # The name of the environment. Format: `projects//locations//agents//
1114
- # environments/`.
1115
955
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment] google_cloud_dialogflow_cx_v3_environment_object
1116
956
  # @param [String] update_mask
1117
- # Required. The mask to control which fields get updated.
1118
957
  # @param [String] fields
1119
958
  # Selector specifying which fields to include in a partial response.
1120
959
  # @param [String] quota_user
@@ -1145,13 +984,8 @@ module Google
1145
984
  execute_or_queue_command(command, &block)
1146
985
  end
1147
986
 
1148
- # Kicks off a continuous test under the specified Environment. This method is a [
1149
- # long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
1150
- # running-operation). The returned `Operation` type has the following method-
1151
- # specific fields: - `metadata`: RunContinuousTestMetadata - `response`:
1152
- # RunContinuousTestResponse
987
+ #
1153
988
  # @param [String] environment
1154
- # Required. Format: `projects//locations//agents//environments/`.
1155
989
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunContinuousTestRequest] google_cloud_dialogflow_cx_v3_run_continuous_test_request_object
1156
990
  # @param [String] fields
1157
991
  # Selector specifying which fields to include in a partial response.
@@ -1182,15 +1016,10 @@ module Google
1182
1016
  execute_or_queue_command(command, &block)
1183
1017
  end
1184
1018
 
1185
- # Fetches a list of continuous test results for a given environment.
1019
+ #
1186
1020
  # @param [String] parent
1187
- # Required. The environment to list results for. Format: `projects//locations//
1188
- # agents//environments/`.
1189
1021
  # @param [Fixnum] page_size
1190
- # The maximum number of items to return in a single page. By default 100 and at
1191
- # most 1000.
1192
1022
  # @param [String] page_token
1193
- # The next_page_token value returned from a previous list request.
1194
1023
  # @param [String] fields
1195
1024
  # Selector specifying which fields to include in a partial response.
1196
1025
  # @param [String] quota_user
@@ -1220,10 +1049,8 @@ module Google
1220
1049
  execute_or_queue_command(command, &block)
1221
1050
  end
1222
1051
 
1223
- # Retrieves the specified Deployment.
1052
+ #
1224
1053
  # @param [String] name
1225
- # Required. The name of the Deployment. Format: `projects//locations//agents//
1226
- # environments//deployments/`.
1227
1054
  # @param [String] fields
1228
1055
  # Selector specifying which fields to include in a partial response.
1229
1056
  # @param [String] quota_user
@@ -1251,15 +1078,10 @@ module Google
1251
1078
  execute_or_queue_command(command, &block)
1252
1079
  end
1253
1080
 
1254
- # Returns the list of all deployments in the specified Environment.
1081
+ #
1255
1082
  # @param [String] parent
1256
- # Required. The Environment to list all environments for. Format: `projects//
1257
- # locations//agents//environments/`.
1258
1083
  # @param [Fixnum] page_size
1259
- # The maximum number of items to return in a single page. By default 20 and at
1260
- # most 100.
1261
1084
  # @param [String] page_token
1262
- # The next_page_token value returned from a previous list request.
1263
1085
  # @param [String] fields
1264
1086
  # Selector specifying which fields to include in a partial response.
1265
1087
  # @param [String] quota_user
@@ -1289,10 +1111,8 @@ module Google
1289
1111
  execute_or_queue_command(command, &block)
1290
1112
  end
1291
1113
 
1292
- # Creates an Experiment in the specified Environment.
1114
+ #
1293
1115
  # @param [String] parent
1294
- # Required. The Agent to create an Environment for. Format: `projects//locations/
1295
- # /agents//environments/`.
1296
1116
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] google_cloud_dialogflow_cx_v3_experiment_object
1297
1117
  # @param [String] fields
1298
1118
  # Selector specifying which fields to include in a partial response.
@@ -1323,10 +1143,8 @@ module Google
1323
1143
  execute_or_queue_command(command, &block)
1324
1144
  end
1325
1145
 
1326
- # Deletes the specified Experiment.
1146
+ #
1327
1147
  # @param [String] name
1328
- # Required. The name of the Environment to delete. Format: `projects//locations//
1329
- # agents//environments//experiments/`.
1330
1148
  # @param [String] fields
1331
1149
  # Selector specifying which fields to include in a partial response.
1332
1150
  # @param [String] quota_user
@@ -1354,10 +1172,8 @@ module Google
1354
1172
  execute_or_queue_command(command, &block)
1355
1173
  end
1356
1174
 
1357
- # Retrieves the specified Experiment.
1175
+ #
1358
1176
  # @param [String] name
1359
- # Required. The name of the Environment. Format: `projects//locations//agents//
1360
- # environments//experiments/`.
1361
1177
  # @param [String] fields
1362
1178
  # Selector specifying which fields to include in a partial response.
1363
1179
  # @param [String] quota_user
@@ -1385,15 +1201,10 @@ module Google
1385
1201
  execute_or_queue_command(command, &block)
1386
1202
  end
1387
1203
 
1388
- # Returns the list of all experiments in the specified Environment.
1204
+ #
1389
1205
  # @param [String] parent
1390
- # Required. The Environment to list all environments for. Format: `projects//
1391
- # locations//agents//environments/`.
1392
1206
  # @param [Fixnum] page_size
1393
- # The maximum number of items to return in a single page. By default 20 and at
1394
- # most 100.
1395
1207
  # @param [String] page_token
1396
- # The next_page_token value returned from a previous list request.
1397
1208
  # @param [String] fields
1398
1209
  # Selector specifying which fields to include in a partial response.
1399
1210
  # @param [String] quota_user
@@ -1423,13 +1234,10 @@ module Google
1423
1234
  execute_or_queue_command(command, &block)
1424
1235
  end
1425
1236
 
1426
- # Updates the specified Experiment.
1237
+ #
1427
1238
  # @param [String] name
1428
- # The name of the experiment. Format: projects//locations//agents//environments//
1429
- # experiments/.
1430
1239
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] google_cloud_dialogflow_cx_v3_experiment_object
1431
1240
  # @param [String] update_mask
1432
- # Required. The mask to control which fields get updated.
1433
1241
  # @param [String] fields
1434
1242
  # Selector specifying which fields to include in a partial response.
1435
1243
  # @param [String] quota_user
@@ -1460,11 +1268,8 @@ module Google
1460
1268
  execute_or_queue_command(command, &block)
1461
1269
  end
1462
1270
 
1463
- # Starts the specified Experiment. This rpc only changes the state of experiment
1464
- # from PENDING to RUNNING.
1271
+ #
1465
1272
  # @param [String] name
1466
- # Required. Resource name of the experiment to start. Format: `projects//
1467
- # locations//agents//environments//experiments/`.
1468
1273
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StartExperimentRequest] google_cloud_dialogflow_cx_v3_start_experiment_request_object
1469
1274
  # @param [String] fields
1470
1275
  # Selector specifying which fields to include in a partial response.
@@ -1495,11 +1300,8 @@ module Google
1495
1300
  execute_or_queue_command(command, &block)
1496
1301
  end
1497
1302
 
1498
- # Stops the specified Experiment. This rpc only changes the state of experiment
1499
- # from RUNNING to DONE.
1303
+ #
1500
1304
  # @param [String] name
1501
- # Required. Resource name of the experiment to stop. Format: `projects//
1502
- # locations//agents//environments//experiments/`.
1503
1305
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StopExperimentRequest] google_cloud_dialogflow_cx_v3_stop_experiment_request_object
1504
1306
  # @param [String] fields
1505
1307
  # Selector specifying which fields to include in a partial response.
@@ -1530,22 +1332,8 @@ module Google
1530
1332
  execute_or_queue_command(command, &block)
1531
1333
  end
1532
1334
 
1533
- # Processes a natural language query and returns structured, actionable data as
1534
- # a result. This method is not idempotent, because it may cause session entity
1535
- # types to be updated, which in turn might affect results of future queries.
1536
- # Note: Always use agent versions for production traffic. See [Versions and
1537
- # environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
1335
+ #
1538
1336
  # @param [String] session
1539
- # Required. The name of the session this query is sent to. Format: `projects//
1540
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1541
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1542
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
1543
- # It can be a random number or some type of session identifiers (preferably
1544
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
1545
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
1546
- # cx/docs/concept/session). Note: Always use agent versions for production
1547
- # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
1548
- # cx/docs/concept/version).
1549
1337
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest] google_cloud_dialogflow_cx_v3_detect_intent_request_object
1550
1338
  # @param [String] fields
1551
1339
  # Selector specifying which fields to include in a partial response.
@@ -1576,18 +1364,8 @@ module Google
1576
1364
  execute_or_queue_command(command, &block)
1577
1365
  end
1578
1366
 
1579
- # Fulfills a matched intent returned by MatchIntent. Must be called after
1580
- # MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is
1581
- # undefined.
1367
+ #
1582
1368
  # @param [String] session
1583
- # Required. The name of the session this query is sent to. Format: `projects//
1584
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1585
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1586
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
1587
- # It can be a random number or some type of session identifiers (preferably
1588
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
1589
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
1590
- # cx/docs/concept/session).
1591
1369
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest] google_cloud_dialogflow_cx_v3_fulfill_intent_request_object
1592
1370
  # @param [String] fields
1593
1371
  # Selector specifying which fields to include in a partial response.
@@ -1618,16 +1396,8 @@ module Google
1618
1396
  execute_or_queue_command(command, &block)
1619
1397
  end
1620
1398
 
1621
- # Returns preliminary intent match results, doesn't change the session status.
1399
+ #
1622
1400
  # @param [String] session
1623
- # Required. The name of the session this query is sent to. Format: `projects//
1624
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1625
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1626
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
1627
- # It can be a random number or some type of session identifiers (preferably
1628
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
1629
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
1630
- # cx/docs/concept/session).
1631
1401
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest] google_cloud_dialogflow_cx_v3_match_intent_request_object
1632
1402
  # @param [String] fields
1633
1403
  # Selector specifying which fields to include in a partial response.
@@ -1658,21 +1428,8 @@ module Google
1658
1428
  execute_or_queue_command(command, &block)
1659
1429
  end
1660
1430
 
1661
- # Processes a natural language query and returns structured, actionable data as
1662
- # a result through server-side streaming. Server-side streaming allows
1663
- # Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/
1664
- # docs/concept/fulfillment#partial-response) earlier in a single request.
1431
+ #
1665
1432
  # @param [String] session
1666
- # Required. The name of the session this query is sent to. Format: `projects//
1667
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1668
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1669
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
1670
- # It can be a random number or some type of session identifiers (preferably
1671
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
1672
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
1673
- # cx/docs/concept/session). Note: Always use agent versions for production
1674
- # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
1675
- # cx/docs/concept/version).
1676
1433
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest] google_cloud_dialogflow_cx_v3_detect_intent_request_object
1677
1434
  # @param [String] fields
1678
1435
  # Selector specifying which fields to include in a partial response.
@@ -1703,12 +1460,8 @@ module Google
1703
1460
  execute_or_queue_command(command, &block)
1704
1461
  end
1705
1462
 
1706
- # Creates a session entity type.
1463
+ #
1707
1464
  # @param [String] parent
1708
- # Required. The session to create a session entity type for. Format: `projects//
1709
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1710
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1711
- # environment.
1712
1465
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] google_cloud_dialogflow_cx_v3_session_entity_type_object
1713
1466
  # @param [String] fields
1714
1467
  # Selector specifying which fields to include in a partial response.
@@ -1739,12 +1492,8 @@ module Google
1739
1492
  execute_or_queue_command(command, &block)
1740
1493
  end
1741
1494
 
1742
- # Deletes the specified session entity type.
1495
+ #
1743
1496
  # @param [String] name
1744
- # Required. The name of the session entity type to delete. Format: `projects//
1745
- # locations//agents//sessions//entityTypes/` or `projects//locations//agents//
1746
- # environments//sessions//entityTypes/`. If `Environment ID` is not specified,
1747
- # we assume default 'draft' environment.
1748
1497
  # @param [String] fields
1749
1498
  # Selector specifying which fields to include in a partial response.
1750
1499
  # @param [String] quota_user
@@ -1772,12 +1521,8 @@ module Google
1772
1521
  execute_or_queue_command(command, &block)
1773
1522
  end
1774
1523
 
1775
- # Retrieves the specified session entity type.
1524
+ #
1776
1525
  # @param [String] name
1777
- # Required. The name of the session entity type. Format: `projects//locations//
1778
- # agents//sessions//entityTypes/` or `projects//locations//agents//environments//
1779
- # sessions//entityTypes/`. If `Environment ID` is not specified, we assume
1780
- # default 'draft' environment.
1781
1526
  # @param [String] fields
1782
1527
  # Selector specifying which fields to include in a partial response.
1783
1528
  # @param [String] quota_user
@@ -1805,17 +1550,10 @@ module Google
1805
1550
  execute_or_queue_command(command, &block)
1806
1551
  end
1807
1552
 
1808
- # Returns the list of all session entity types in the specified session.
1553
+ #
1809
1554
  # @param [String] parent
1810
- # Required. The session to list all session entity types from. Format: `projects/
1811
- # /locations//agents//sessions/` or `projects//locations//agents//environments//
1812
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1813
- # environment.
1814
1555
  # @param [Fixnum] page_size
1815
- # The maximum number of items to return in a single page. By default 100 and at
1816
- # most 1000.
1817
1556
  # @param [String] page_token
1818
- # The next_page_token value returned from a previous list request.
1819
1557
  # @param [String] fields
1820
1558
  # Selector specifying which fields to include in a partial response.
1821
1559
  # @param [String] quota_user
@@ -1845,15 +1583,10 @@ module Google
1845
1583
  execute_or_queue_command(command, &block)
1846
1584
  end
1847
1585
 
1848
- # Updates the specified session entity type.
1586
+ #
1849
1587
  # @param [String] name
1850
- # Required. The unique identifier of the session entity type. Format: `projects//
1851
- # locations//agents//sessions//entityTypes/` or `projects//locations//agents//
1852
- # environments//sessions//entityTypes/`. If `Environment ID` is not specified,
1853
- # we assume default 'draft' environment.
1854
1588
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] google_cloud_dialogflow_cx_v3_session_entity_type_object
1855
1589
  # @param [String] update_mask
1856
- # The mask to control which fields get updated.
1857
1590
  # @param [String] fields
1858
1591
  # Selector specifying which fields to include in a partial response.
1859
1592
  # @param [String] quota_user
@@ -1884,21 +1617,10 @@ module Google
1884
1617
  execute_or_queue_command(command, &block)
1885
1618
  end
1886
1619
 
1887
- # Creates a flow in the specified agent. Note: You should always train a flow
1888
- # prior to sending it queries. See the [training documentation](https://cloud.
1889
- # google.com/dialogflow/cx/docs/concept/training).
1620
+ #
1890
1621
  # @param [String] parent
1891
- # Required. The agent to create a flow for. Format: `projects//locations//agents/
1892
- # `.
1893
1622
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow] google_cloud_dialogflow_cx_v3_flow_object
1894
1623
  # @param [String] language_code
1895
- # The language of the following fields in `flow`: * `Flow.event_handlers.
1896
- # trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.
1897
- # conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `
1898
- # Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified,
1899
- # the agent's default language is used. [Many languages](https://cloud.google.
1900
- # com/dialogflow/cx/docs/reference/language) are supported. Note: languages must
1901
- # be enabled in the agent before they can be used.
1902
1624
  # @param [String] fields
1903
1625
  # Selector specifying which fields to include in a partial response.
1904
1626
  # @param [String] quota_user
@@ -1929,17 +1651,9 @@ module Google
1929
1651
  execute_or_queue_command(command, &block)
1930
1652
  end
1931
1653
 
1932
- # Deletes a specified flow.
1654
+ #
1933
1655
  # @param [String] name
1934
- # Required. The name of the flow to delete. Format: `projects//locations//agents/
1935
- # /flows/`.
1936
1656
  # @param [Boolean] force
1937
- # This field has no effect for flows with no incoming transitions. For flows
1938
- # with incoming transitions: * If `force` is set to false, an error will be
1939
- # returned with message indicating the incoming transitions. * If `force` is set
1940
- # to true, Dialogflow will remove the flow, as well as any transitions to the
1941
- # flow (i.e. Target flow in event handlers or Target flow in transition routes
1942
- # that point to this flow will be cleared).
1943
1657
  # @param [String] fields
1944
1658
  # Selector specifying which fields to include in a partial response.
1945
1659
  # @param [String] quota_user
@@ -1968,16 +1682,8 @@ module Google
1968
1682
  execute_or_queue_command(command, &block)
1969
1683
  end
1970
1684
 
1971
- # Exports the specified flow to a binary file. This method is a [long-running
1972
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
1973
- # operation). The returned `Operation` type has the following method-specific
1974
- # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
1975
- # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
1976
- # ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that
1977
- # the flow references will also be exported.
1685
+ #
1978
1686
  # @param [String] name
1979
- # Required. The name of the flow to export. Format: `projects//locations//agents/
1980
- # /flows/`.
1981
1687
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportFlowRequest] google_cloud_dialogflow_cx_v3_export_flow_request_object
1982
1688
  # @param [String] fields
1983
1689
  # Selector specifying which fields to include in a partial response.
@@ -2008,19 +1714,9 @@ module Google
2008
1714
  execute_or_queue_command(command, &block)
2009
1715
  end
2010
1716
 
2011
- # Retrieves the specified flow.
1717
+ #
2012
1718
  # @param [String] name
2013
- # Required. The name of the flow to get. Format: `projects//locations//agents//
2014
- # flows/`.
2015
1719
  # @param [String] language_code
2016
- # The language to retrieve the flow for. The following fields are language
2017
- # dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.
2018
- # event_handlers.trigger_fulfillment.conditional_cases` * `Flow.
2019
- # transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.
2020
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2021
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2022
- # reference/language) are supported. Note: languages must be enabled in the
2023
- # agent before they can be used.
2024
1720
  # @param [String] fields
2025
1721
  # Selector specifying which fields to include in a partial response.
2026
1722
  # @param [String] quota_user
@@ -2049,13 +1745,9 @@ module Google
2049
1745
  execute_or_queue_command(command, &block)
2050
1746
  end
2051
1747
 
2052
- # Gets the latest flow validation result. Flow validation is performed when
2053
- # ValidateFlow is called.
1748
+ #
2054
1749
  # @param [String] name
2055
- # Required. The flow name. Format: `projects//locations//agents//flows//
2056
- # validationResult`.
2057
1750
  # @param [String] language_code
2058
- # If not specified, the agent's default language is used.
2059
1751
  # @param [String] fields
2060
1752
  # Selector specifying which fields to include in a partial response.
2061
1753
  # @param [String] quota_user
@@ -2084,17 +1776,8 @@ module Google
2084
1776
  execute_or_queue_command(command, &block)
2085
1777
  end
2086
1778
 
2087
- # Imports the specified flow to the specified agent from a binary file. This
2088
- # method is a [long-running operation](https://cloud.google.com/dialogflow/cx/
2089
- # docs/how/long-running-operation). The returned `Operation` type has the
2090
- # following method-specific fields: - `metadata`: An empty [Struct message](
2091
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
2092
- # struct) - `response`: ImportFlowResponse Note: You should always train a flow
2093
- # prior to sending it queries. See the [training documentation](https://cloud.
2094
- # google.com/dialogflow/cx/docs/concept/training).
1779
+ #
2095
1780
  # @param [String] parent
2096
- # Required. The agent to import the flow into. Format: `projects//locations//
2097
- # agents/`.
2098
1781
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportFlowRequest] google_cloud_dialogflow_cx_v3_import_flow_request_object
2099
1782
  # @param [String] fields
2100
1783
  # Selector specifying which fields to include in a partial response.
@@ -2125,24 +1808,11 @@ module Google
2125
1808
  execute_or_queue_command(command, &block)
2126
1809
  end
2127
1810
 
2128
- # Returns the list of all flows in the specified agent.
1811
+ #
2129
1812
  # @param [String] parent
2130
- # Required. The agent containing the flows. Format: `projects//locations//agents/
2131
- # `.
2132
1813
  # @param [String] language_code
2133
- # The language to list flows for. The following fields are language dependent: *
2134
- # `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.
2135
- # trigger_fulfillment.conditional_cases` * `Flow.transition_routes.
2136
- # trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.
2137
- # conditional_cases` If not specified, the agent's default language is used. [
2138
- # Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
2139
- # are supported. Note: languages must be enabled in the agent before they can
2140
- # be used.
2141
1814
  # @param [Fixnum] page_size
2142
- # The maximum number of items to return in a single page. By default 100 and at
2143
- # most 1000.
2144
1815
  # @param [String] page_token
2145
- # The next_page_token value returned from a previous list request.
2146
1816
  # @param [String] fields
2147
1817
  # Selector specifying which fields to include in a partial response.
2148
1818
  # @param [String] quota_user
@@ -2173,24 +1843,11 @@ module Google
2173
1843
  execute_or_queue_command(command, &block)
2174
1844
  end
2175
1845
 
2176
- # Updates the specified flow. Note: You should always train a flow prior to
2177
- # sending it queries. See the [training documentation](https://cloud.google.com/
2178
- # dialogflow/cx/docs/concept/training).
1846
+ #
2179
1847
  # @param [String] name
2180
- # The unique identifier of the flow. Format: `projects//locations//agents//flows/
2181
- # `.
2182
1848
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow] google_cloud_dialogflow_cx_v3_flow_object
2183
1849
  # @param [String] language_code
2184
- # The language of the following fields in `flow`: * `Flow.event_handlers.
2185
- # trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.
2186
- # conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `
2187
- # Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified,
2188
- # the agent's default language is used. [Many languages](https://cloud.google.
2189
- # com/dialogflow/cx/docs/reference/language) are supported. Note: languages must
2190
- # be enabled in the agent before they can be used.
2191
1850
  # @param [String] update_mask
2192
- # The mask to control which fields get updated. If the mask is not present, all
2193
- # fields will be updated.
2194
1851
  # @param [String] fields
2195
1852
  # Selector specifying which fields to include in a partial response.
2196
1853
  # @param [String] quota_user
@@ -2222,17 +1879,8 @@ module Google
2222
1879
  execute_or_queue_command(command, &block)
2223
1880
  end
2224
1881
 
2225
- # Trains the specified flow. Note that only the flow in 'draft' environment is
2226
- # trained. This method is a [long-running operation](https://cloud.google.com/
2227
- # dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type
2228
- # has the following method-specific fields: - `metadata`: An empty [Struct
2229
- # message](https://developers.google.com/protocol-buffers/docs/reference/google.
2230
- # protobuf#struct) - `response`: An [Empty message](https://developers.google.
2231
- # com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should
2232
- # always train a flow prior to sending it queries. See the [training
2233
- # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
1882
+ #
2234
1883
  # @param [String] name
2235
- # Required. The flow to train. Format: `projects//locations//agents//flows/`.
2236
1884
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TrainFlowRequest] google_cloud_dialogflow_cx_v3_train_flow_request_object
2237
1885
  # @param [String] fields
2238
1886
  # Selector specifying which fields to include in a partial response.
@@ -2263,11 +1911,8 @@ module Google
2263
1911
  execute_or_queue_command(command, &block)
2264
1912
  end
2265
1913
 
2266
- # Validates the specified flow and creates or updates validation results. Please
2267
- # call this API after the training is completed to get the complete validation
2268
- # results.
1914
+ #
2269
1915
  # @param [String] name
2270
- # Required. The flow to validate. Format: `projects//locations//agents//flows/`.
2271
1916
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateFlowRequest] google_cloud_dialogflow_cx_v3_validate_flow_request_object
2272
1917
  # @param [String] fields
2273
1918
  # Selector specifying which fields to include in a partial response.
@@ -2298,27 +1943,10 @@ module Google
2298
1943
  execute_or_queue_command(command, &block)
2299
1944
  end
2300
1945
 
2301
- # Creates a page in the specified flow. Note: You should always train a flow
2302
- # prior to sending it queries. See the [training documentation](https://cloud.
2303
- # google.com/dialogflow/cx/docs/concept/training).
1946
+ #
2304
1947
  # @param [String] parent
2305
- # Required. The flow to create a page for. Format: `projects//locations//agents//
2306
- # flows/`.
2307
1948
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page] google_cloud_dialogflow_cx_v3_page_object
2308
1949
  # @param [String] language_code
2309
- # The language of the following fields in `page`: * `Page.entry_fulfillment.
2310
- # messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.
2311
- # trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.
2312
- # conditional_cases` * `Page.form.parameters.fill_behavior.
2313
- # initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.
2314
- # initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.
2315
- # fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.
2316
- # fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.
2317
- # transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.
2318
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2319
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2320
- # reference/language) are supported. Note: languages must be enabled in the
2321
- # agent before they can be used.
2322
1950
  # @param [String] fields
2323
1951
  # Selector specifying which fields to include in a partial response.
2324
1952
  # @param [String] quota_user
@@ -2349,19 +1977,9 @@ module Google
2349
1977
  execute_or_queue_command(command, &block)
2350
1978
  end
2351
1979
 
2352
- # Deletes the specified page. Note: You should always train a flow prior to
2353
- # sending it queries. See the [training documentation](https://cloud.google.com/
2354
- # dialogflow/cx/docs/concept/training).
1980
+ #
2355
1981
  # @param [String] name
2356
- # Required. The name of the page to delete. Format: `projects//locations//agents/
2357
- # /Flows//pages/`.
2358
1982
  # @param [Boolean] force
2359
- # This field has no effect for pages with no incoming transitions. For pages
2360
- # with incoming transitions: * If `force` is set to false, an error will be
2361
- # returned with message indicating the incoming transitions. * If `force` is set
2362
- # to true, Dialogflow will remove the page, as well as any transitions to the
2363
- # page (i.e. Target page in event handlers or Target page in transition routes
2364
- # that point to this page will be cleared).
2365
1983
  # @param [String] fields
2366
1984
  # Selector specifying which fields to include in a partial response.
2367
1985
  # @param [String] quota_user
@@ -2390,24 +2008,9 @@ module Google
2390
2008
  execute_or_queue_command(command, &block)
2391
2009
  end
2392
2010
 
2393
- # Retrieves the specified page.
2011
+ #
2394
2012
  # @param [String] name
2395
- # Required. The name of the page. Format: `projects//locations//agents//flows//
2396
- # pages/`.
2397
2013
  # @param [String] language_code
2398
- # The language to retrieve the page for. The following fields are language
2399
- # dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.
2400
- # conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `
2401
- # Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.
2402
- # parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.
2403
- # parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.
2404
- # form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.
2405
- # parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.
2406
- # transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.
2407
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2408
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2409
- # reference/language) are supported. Note: languages must be enabled in the
2410
- # agent before they can be used.
2411
2014
  # @param [String] fields
2412
2015
  # Selector specifying which fields to include in a partial response.
2413
2016
  # @param [String] quota_user
@@ -2436,29 +2039,11 @@ module Google
2436
2039
  execute_or_queue_command(command, &block)
2437
2040
  end
2438
2041
 
2439
- # Returns the list of all pages in the specified flow.
2042
+ #
2440
2043
  # @param [String] parent
2441
- # Required. The flow to list all pages for. Format: `projects//locations//agents/
2442
- # /flows/`.
2443
2044
  # @param [String] language_code
2444
- # The language to list pages for. The following fields are language dependent: *
2445
- # `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases`
2446
- # * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.
2447
- # trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.
2448
- # initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.
2449
- # initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.
2450
- # fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.
2451
- # fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.
2452
- # transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.
2453
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2454
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2455
- # reference/language) are supported. Note: languages must be enabled in the
2456
- # agent before they can be used.
2457
2045
  # @param [Fixnum] page_size
2458
- # The maximum number of items to return in a single page. By default 100 and at
2459
- # most 1000.
2460
2046
  # @param [String] page_token
2461
- # The next_page_token value returned from a previous list request.
2462
2047
  # @param [String] fields
2463
2048
  # Selector specifying which fields to include in a partial response.
2464
2049
  # @param [String] quota_user
@@ -2489,31 +2074,11 @@ module Google
2489
2074
  execute_or_queue_command(command, &block)
2490
2075
  end
2491
2076
 
2492
- # Updates the specified page. Note: You should always train a flow prior to
2493
- # sending it queries. See the [training documentation](https://cloud.google.com/
2494
- # dialogflow/cx/docs/concept/training).
2077
+ #
2495
2078
  # @param [String] name
2496
- # The unique identifier of the page. Required for the Pages.UpdatePage method.
2497
- # Pages.CreatePage populates the name automatically. Format: `projects//
2498
- # locations//agents//flows//pages/`.
2499
2079
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page] google_cloud_dialogflow_cx_v3_page_object
2500
2080
  # @param [String] language_code
2501
- # The language of the following fields in `page`: * `Page.entry_fulfillment.
2502
- # messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.
2503
- # trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.
2504
- # conditional_cases` * `Page.form.parameters.fill_behavior.
2505
- # initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.
2506
- # initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.
2507
- # fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.
2508
- # fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.
2509
- # transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.
2510
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2511
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2512
- # reference/language) are supported. Note: languages must be enabled in the
2513
- # agent before they can be used.
2514
2081
  # @param [String] update_mask
2515
- # The mask to control which fields get updated. If the mask is not present, all
2516
- # fields will be updated.
2517
2082
  # @param [String] fields
2518
2083
  # Selector specifying which fields to include in a partial response.
2519
2084
  # @param [String] quota_user
@@ -2545,21 +2110,10 @@ module Google
2545
2110
  execute_or_queue_command(command, &block)
2546
2111
  end
2547
2112
 
2548
- # Creates an TransitionRouteGroup in the specified flow. Note: You should always
2549
- # train a flow prior to sending it queries. See the [training documentation](
2550
- # https://cloud.google.com/dialogflow/cx/docs/concept/training).
2113
+ #
2551
2114
  # @param [String] parent
2552
- # Required. The flow to create an TransitionRouteGroup for. Format: `projects//
2553
- # locations//agents//flows/` or `projects//locations//agents/` for agent-level
2554
- # groups.
2555
2115
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] google_cloud_dialogflow_cx_v3_transition_route_group_object
2556
2116
  # @param [String] language_code
2557
- # The language of the following fields in `TransitionRouteGroup`: * `
2558
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `
2559
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
2560
- # If not specified, the agent's default language is used. [Many languages](https:
2561
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
2562
- # languages must be enabled in the agent before they can be used.
2563
2117
  # @param [String] fields
2564
2118
  # Selector specifying which fields to include in a partial response.
2565
2119
  # @param [String] quota_user
@@ -2590,19 +2144,9 @@ module Google
2590
2144
  execute_or_queue_command(command, &block)
2591
2145
  end
2592
2146
 
2593
- # Deletes the specified TransitionRouteGroup. Note: You should always train a
2594
- # flow prior to sending it queries. See the [training documentation](https://
2595
- # cloud.google.com/dialogflow/cx/docs/concept/training).
2147
+ #
2596
2148
  # @param [String] name
2597
- # Required. The name of the TransitionRouteGroup to delete. Format: `projects//
2598
- # locations//agents//flows//transitionRouteGroups/` or `projects//locations//
2599
- # agents//transitionRouteGroups/`.
2600
2149
  # @param [Boolean] force
2601
- # This field has no effect for transition route group that no page is using. If
2602
- # the transition route group is referenced by any page: * If `force` is set to
2603
- # false, an error will be returned with message indicating pages that reference
2604
- # the transition route group. * If `force` is set to true, Dialogflow will
2605
- # remove the transition route group, as well as any reference to it.
2606
2150
  # @param [String] fields
2607
2151
  # Selector specifying which fields to include in a partial response.
2608
2152
  # @param [String] quota_user
@@ -2631,19 +2175,9 @@ module Google
2631
2175
  execute_or_queue_command(command, &block)
2632
2176
  end
2633
2177
 
2634
- # Retrieves the specified TransitionRouteGroup.
2178
+ #
2635
2179
  # @param [String] name
2636
- # Required. The name of the TransitionRouteGroup. Format: `projects//locations//
2637
- # agents//flows//transitionRouteGroups/` or `projects//locations//agents//
2638
- # transitionRouteGroups/`.
2639
2180
  # @param [String] language_code
2640
- # The language to retrieve the transition route group for. The following fields
2641
- # are language dependent: * `TransitionRouteGroup.transition_routes.
2642
- # trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.
2643
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2644
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2645
- # reference/language) are supported. Note: languages must be enabled in the
2646
- # agent before they can be used.
2647
2181
  # @param [String] fields
2648
2182
  # Selector specifying which fields to include in a partial response.
2649
2183
  # @param [String] quota_user
@@ -2672,23 +2206,11 @@ module Google
2672
2206
  execute_or_queue_command(command, &block)
2673
2207
  end
2674
2208
 
2675
- # Returns the list of all transition route groups in the specified flow.
2209
+ #
2676
2210
  # @param [String] parent
2677
- # Required. The flow to list all transition route groups for. Format: `projects//
2678
- # locations//agents//flows/` or `projects//locations//agents/.
2679
2211
  # @param [String] language_code
2680
- # The language to list transition route groups for. The following fields are
2681
- # language dependent: * `TransitionRouteGroup.transition_routes.
2682
- # trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.
2683
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2684
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2685
- # reference/language) are supported. Note: languages must be enabled in the
2686
- # agent before they can be used.
2687
2212
  # @param [Fixnum] page_size
2688
- # The maximum number of items to return in a single page. By default 100 and at
2689
- # most 1000.
2690
2213
  # @param [String] page_token
2691
- # The next_page_token value returned from a previous list request.
2692
2214
  # @param [String] fields
2693
2215
  # Selector specifying which fields to include in a partial response.
2694
2216
  # @param [String] quota_user
@@ -2719,23 +2241,11 @@ module Google
2719
2241
  execute_or_queue_command(command, &block)
2720
2242
  end
2721
2243
 
2722
- # Updates the specified TransitionRouteGroup. Note: You should always train a
2723
- # flow prior to sending it queries. See the [training documentation](https://
2724
- # cloud.google.com/dialogflow/cx/docs/concept/training).
2244
+ #
2725
2245
  # @param [String] name
2726
- # The unique identifier of the transition route group. TransitionRouteGroups.
2727
- # CreateTransitionRouteGroup populates the name automatically. Format: `projects/
2728
- # /locations//agents//flows//transitionRouteGroups/` .
2729
2246
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] google_cloud_dialogflow_cx_v3_transition_route_group_object
2730
2247
  # @param [String] language_code
2731
- # The language of the following fields in `TransitionRouteGroup`: * `
2732
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `
2733
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
2734
- # If not specified, the agent's default language is used. [Many languages](https:
2735
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
2736
- # languages must be enabled in the agent before they can be used.
2737
2248
  # @param [String] update_mask
2738
- # The mask to control which fields get updated.
2739
2249
  # @param [String] fields
2740
2250
  # Selector specifying which fields to include in a partial response.
2741
2251
  # @param [String] quota_user
@@ -2767,11 +2277,8 @@ module Google
2767
2277
  execute_or_queue_command(command, &block)
2768
2278
  end
2769
2279
 
2770
- # Compares the specified base version with target version.
2280
+ #
2771
2281
  # @param [String] base_version
2772
- # Required. Name of the base flow version to compare with the target version.
2773
- # Use version ID `0` to indicate the draft version of the specified flow. Format:
2774
- # `projects//locations//agents//flows//versions/`.
2775
2282
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsRequest] google_cloud_dialogflow_cx_v3_compare_versions_request_object
2776
2283
  # @param [String] fields
2777
2284
  # Selector specifying which fields to include in a partial response.
@@ -2802,13 +2309,8 @@ module Google
2802
2309
  execute_or_queue_command(command, &block)
2803
2310
  end
2804
2311
 
2805
- # Creates a Version in the specified Flow. This method is a [long-running
2806
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
2807
- # operation). The returned `Operation` type has the following method-specific
2808
- # fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version
2312
+ #
2809
2313
  # @param [String] parent
2810
- # Required. The Flow to create an Version for. Format: `projects//locations//
2811
- # agents//flows/`.
2812
2314
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version] google_cloud_dialogflow_cx_v3_version_object
2813
2315
  # @param [String] fields
2814
2316
  # Selector specifying which fields to include in a partial response.
@@ -2839,10 +2341,8 @@ module Google
2839
2341
  execute_or_queue_command(command, &block)
2840
2342
  end
2841
2343
 
2842
- # Deletes the specified Version.
2344
+ #
2843
2345
  # @param [String] name
2844
- # Required. The name of the Version to delete. Format: `projects//locations//
2845
- # agents//flows//versions/`.
2846
2346
  # @param [String] fields
2847
2347
  # Selector specifying which fields to include in a partial response.
2848
2348
  # @param [String] quota_user
@@ -2870,10 +2370,8 @@ module Google
2870
2370
  execute_or_queue_command(command, &block)
2871
2371
  end
2872
2372
 
2873
- # Retrieves the specified Version.
2373
+ #
2874
2374
  # @param [String] name
2875
- # Required. The name of the Version. Format: `projects//locations//agents//flows/
2876
- # /versions/`.
2877
2375
  # @param [String] fields
2878
2376
  # Selector specifying which fields to include in a partial response.
2879
2377
  # @param [String] quota_user
@@ -2901,15 +2399,10 @@ module Google
2901
2399
  execute_or_queue_command(command, &block)
2902
2400
  end
2903
2401
 
2904
- # Returns the list of all versions in the specified Flow.
2402
+ #
2905
2403
  # @param [String] parent
2906
- # Required. The Flow to list all versions for. Format: `projects//locations//
2907
- # agents//flows/`.
2908
2404
  # @param [Fixnum] page_size
2909
- # The maximum number of items to return in a single page. By default 20 and at
2910
- # most 100.
2911
2405
  # @param [String] page_token
2912
- # The next_page_token value returned from a previous list request.
2913
2406
  # @param [String] fields
2914
2407
  # Selector specifying which fields to include in a partial response.
2915
2408
  # @param [String] quota_user
@@ -2939,16 +2432,8 @@ module Google
2939
2432
  execute_or_queue_command(command, &block)
2940
2433
  end
2941
2434
 
2942
- # Loads resources in the specified version to the draft flow. This method is a [
2943
- # long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
2944
- # running-operation). The returned `Operation` type has the following method-
2945
- # specific fields: - `metadata`: An empty [Struct message](https://developers.
2946
- # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
2947
- # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
2948
- # reference/google.protobuf#empty)
2435
+ #
2949
2436
  # @param [String] name
2950
- # Required. The Version to be loaded to draft flow. Format: `projects//locations/
2951
- # /agents//flows//versions/`.
2952
2437
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LoadVersionRequest] google_cloud_dialogflow_cx_v3_load_version_request_object
2953
2438
  # @param [String] fields
2954
2439
  # Selector specifying which fields to include in a partial response.
@@ -2979,14 +2464,10 @@ module Google
2979
2464
  execute_or_queue_command(command, &block)
2980
2465
  end
2981
2466
 
2982
- # Updates the specified Version.
2467
+ #
2983
2468
  # @param [String] name
2984
- # Format: projects//locations//agents//flows//versions/. Version ID is a self-
2985
- # increasing number generated by Dialogflow upon version creation.
2986
2469
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version] google_cloud_dialogflow_cx_v3_version_object
2987
2470
  # @param [String] update_mask
2988
- # Required. The mask to control which fields get updated. Currently only `
2989
- # description` and `display_name` can be updated.
2990
2471
  # @param [String] fields
2991
2472
  # Selector specifying which fields to include in a partial response.
2992
2473
  # @param [String] quota_user
@@ -3017,14 +2498,10 @@ module Google
3017
2498
  execute_or_queue_command(command, &block)
3018
2499
  end
3019
2500
 
3020
- # Creates a generator in the specified agent.
2501
+ #
3021
2502
  # @param [String] parent
3022
- # Required. The agent to create a generator for. Format: `projects//locations//
3023
- # agents/`.
3024
2503
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator] google_cloud_dialogflow_cx_v3_generator_object
3025
2504
  # @param [String] language_code
3026
- # The language to create generators for the following fields: * `Generator.
3027
- # prompt_text.text` If not specified, the agent's default language is used.
3028
2505
  # @param [String] fields
3029
2506
  # Selector specifying which fields to include in a partial response.
3030
2507
  # @param [String] quota_user
@@ -3055,16 +2532,9 @@ module Google
3055
2532
  execute_or_queue_command(command, &block)
3056
2533
  end
3057
2534
 
3058
- # Deletes the specified generators.
2535
+ #
3059
2536
  # @param [String] name
3060
- # Required. The name of the generator to delete. Format: `projects//locations//
3061
- # agents//generators/`.
3062
2537
  # @param [Boolean] force
3063
- # This field has no effect for generators not being used. For generators that
3064
- # are used by pages/flows/transition route groups: * If `force` is set to false,
3065
- # an error will be returned with message indicating the referenced resources. *
3066
- # If `force` is set to true, Dialogflow will remove the generator, as well as
3067
- # any references to the generator (i.e. Generator) in fulfillments.
3068
2538
  # @param [String] fields
3069
2539
  # Selector specifying which fields to include in a partial response.
3070
2540
  # @param [String] quota_user
@@ -3093,12 +2563,9 @@ module Google
3093
2563
  execute_or_queue_command(command, &block)
3094
2564
  end
3095
2565
 
3096
- # Retrieves the specified generator.
2566
+ #
3097
2567
  # @param [String] name
3098
- # Required. The name of the generator. Format: `projects//locations//agents//
3099
- # generators/`.
3100
2568
  # @param [String] language_code
3101
- # The language to list generators for.
3102
2569
  # @param [String] fields
3103
2570
  # Selector specifying which fields to include in a partial response.
3104
2571
  # @param [String] quota_user
@@ -3127,17 +2594,11 @@ module Google
3127
2594
  execute_or_queue_command(command, &block)
3128
2595
  end
3129
2596
 
3130
- # Returns the list of all generators in the specified agent.
2597
+ #
3131
2598
  # @param [String] parent
3132
- # Required. The agent to list all generators for. Format: `projects//locations//
3133
- # agents/`.
3134
2599
  # @param [String] language_code
3135
- # The language to list generators for.
3136
2600
  # @param [Fixnum] page_size
3137
- # The maximum number of items to return in a single page. By default 100 and at
3138
- # most 1000.
3139
2601
  # @param [String] page_token
3140
- # The next_page_token value returned from a previous list request.
3141
2602
  # @param [String] fields
3142
2603
  # Selector specifying which fields to include in a partial response.
3143
2604
  # @param [String] quota_user
@@ -3168,17 +2629,11 @@ module Google
3168
2629
  execute_or_queue_command(command, &block)
3169
2630
  end
3170
2631
 
3171
- # Update the specified generator.
2632
+ #
3172
2633
  # @param [String] name
3173
- # The unique identifier of the generator. Must be set for the Generators.
3174
- # UpdateGenerator method. Generators.CreateGenerate populates the name
3175
- # automatically. Format: `projects//locations//agents//generators/`.
3176
2634
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator] google_cloud_dialogflow_cx_v3_generator_object
3177
2635
  # @param [String] language_code
3178
- # The language to list generators for.
3179
2636
  # @param [String] update_mask
3180
- # The mask to control which fields get updated. If the mask is not present, all
3181
- # fields will be updated.
3182
2637
  # @param [String] fields
3183
2638
  # Selector specifying which fields to include in a partial response.
3184
2639
  # @param [String] quota_user
@@ -3210,19 +2665,10 @@ module Google
3210
2665
  execute_or_queue_command(command, &block)
3211
2666
  end
3212
2667
 
3213
- # Creates an intent in the specified agent. Note: You should always train a flow
3214
- # prior to sending it queries. See the [training documentation](https://cloud.
3215
- # google.com/dialogflow/cx/docs/concept/training).
2668
+ #
3216
2669
  # @param [String] parent
3217
- # Required. The agent to create an intent for. Format: `projects//locations//
3218
- # agents/`.
3219
2670
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent] google_cloud_dialogflow_cx_v3_intent_object
3220
2671
  # @param [String] language_code
3221
- # The language of the following fields in `intent`: * `Intent.training_phrases.
3222
- # parts.text` If not specified, the agent's default language is used. [Many
3223
- # languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are
3224
- # supported. Note: languages must be enabled in the agent before they can be
3225
- # used.
3226
2672
  # @param [String] fields
3227
2673
  # Selector specifying which fields to include in a partial response.
3228
2674
  # @param [String] quota_user
@@ -3253,12 +2699,8 @@ module Google
3253
2699
  execute_or_queue_command(command, &block)
3254
2700
  end
3255
2701
 
3256
- # Deletes the specified intent. Note: You should always train a flow prior to
3257
- # sending it queries. See the [training documentation](https://cloud.google.com/
3258
- # dialogflow/cx/docs/concept/training).
2702
+ #
3259
2703
  # @param [String] name
3260
- # Required. The name of the intent to delete. Format: `projects//locations//
3261
- # agents//intents/`.
3262
2704
  # @param [String] fields
3263
2705
  # Selector specifying which fields to include in a partial response.
3264
2706
  # @param [String] quota_user
@@ -3286,13 +2728,8 @@ module Google
3286
2728
  execute_or_queue_command(command, &block)
3287
2729
  end
3288
2730
 
3289
- # Exports the selected intents. This method is a [long-running operation](https:/
3290
- # /cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned
3291
- # `Operation` type has the following method-specific fields: - `metadata`:
3292
- # ExportIntentsMetadata - `response`: ExportIntentsResponse
2731
+ #
3293
2732
  # @param [String] parent
3294
- # Required. The name of the parent agent to export intents. Format: `projects//
3295
- # locations//agents/`.
3296
2733
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportIntentsRequest] google_cloud_dialogflow_cx_v3_export_intents_request_object
3297
2734
  # @param [String] fields
3298
2735
  # Selector specifying which fields to include in a partial response.
@@ -3323,16 +2760,9 @@ module Google
3323
2760
  execute_or_queue_command(command, &block)
3324
2761
  end
3325
2762
 
3326
- # Retrieves the specified intent.
2763
+ #
3327
2764
  # @param [String] name
3328
- # Required. The name of the intent. Format: `projects//locations//agents//
3329
- # intents/`.
3330
2765
  # @param [String] language_code
3331
- # The language to retrieve the intent for. The following fields are language
3332
- # dependent: * `Intent.training_phrases.parts.text` If not specified, the agent'
3333
- # s default language is used. [Many languages](https://cloud.google.com/
3334
- # dialogflow/cx/docs/reference/language) are supported. Note: languages must be
3335
- # enabled in the agent before they can be used.
3336
2766
  # @param [String] fields
3337
2767
  # Selector specifying which fields to include in a partial response.
3338
2768
  # @param [String] quota_user
@@ -3361,14 +2791,8 @@ module Google
3361
2791
  execute_or_queue_command(command, &block)
3362
2792
  end
3363
2793
 
3364
- # Imports the specified intents into the agent. This method is a [long-running
3365
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
3366
- # operation). The returned `Operation` type has the following method-specific
3367
- # fields: - `metadata`: ImportIntentsMetadata - `response`:
3368
- # ImportIntentsResponse
2794
+ #
3369
2795
  # @param [String] parent
3370
- # Required. The agent to import the intents into. Format: `projects//locations//
3371
- # agents/`.
3372
2796
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportIntentsRequest] google_cloud_dialogflow_cx_v3_import_intents_request_object
3373
2797
  # @param [String] fields
3374
2798
  # Selector specifying which fields to include in a partial response.
@@ -3399,23 +2823,12 @@ module Google
3399
2823
  execute_or_queue_command(command, &block)
3400
2824
  end
3401
2825
 
3402
- # Returns the list of all intents in the specified agent.
2826
+ #
3403
2827
  # @param [String] parent
3404
- # Required. The agent to list all intents for. Format: `projects//locations//
3405
- # agents/`.
3406
2828
  # @param [String] intent_view
3407
- # The resource view to apply to the returned intent.
3408
2829
  # @param [String] language_code
3409
- # The language to list intents for. The following fields are language dependent:
3410
- # * `Intent.training_phrases.parts.text` If not specified, the agent's default
3411
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
3412
- # reference/language) are supported. Note: languages must be enabled in the
3413
- # agent before they can be used.
3414
2830
  # @param [Fixnum] page_size
3415
- # The maximum number of items to return in a single page. By default 100 and at
3416
- # most 1000.
3417
2831
  # @param [String] page_token
3418
- # The next_page_token value returned from a previous list request.
3419
2832
  # @param [String] fields
3420
2833
  # Selector specifying which fields to include in a partial response.
3421
2834
  # @param [String] quota_user
@@ -3447,23 +2860,11 @@ module Google
3447
2860
  execute_or_queue_command(command, &block)
3448
2861
  end
3449
2862
 
3450
- # Updates the specified intent. Note: You should always train a flow prior to
3451
- # sending it queries. See the [training documentation](https://cloud.google.com/
3452
- # dialogflow/cx/docs/concept/training).
2863
+ #
3453
2864
  # @param [String] name
3454
- # The unique identifier of the intent. Required for the Intents.UpdateIntent
3455
- # method. Intents.CreateIntent populates the name automatically. Format: `
3456
- # projects//locations//agents//intents/`.
3457
2865
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent] google_cloud_dialogflow_cx_v3_intent_object
3458
2866
  # @param [String] language_code
3459
- # The language of the following fields in `intent`: * `Intent.training_phrases.
3460
- # parts.text` If not specified, the agent's default language is used. [Many
3461
- # languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are
3462
- # supported. Note: languages must be enabled in the agent before they can be
3463
- # used.
3464
2867
  # @param [String] update_mask
3465
- # The mask to control which fields get updated. If the mask is not present, all
3466
- # fields will be updated.
3467
2868
  # @param [String] fields
3468
2869
  # Selector specifying which fields to include in a partial response.
3469
2870
  # @param [String] quota_user
@@ -3495,10 +2896,8 @@ module Google
3495
2896
  execute_or_queue_command(command, &block)
3496
2897
  end
3497
2898
 
3498
- # Creates a playbook in a specified agent.
2899
+ #
3499
2900
  # @param [String] parent
3500
- # Required. The agent to create a playbook for. Format: `projects//locations//
3501
- # agents/`.
3502
2901
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Playbook] google_cloud_dialogflow_cx_v3_playbook_object
3503
2902
  # @param [String] fields
3504
2903
  # Selector specifying which fields to include in a partial response.
@@ -3529,10 +2928,8 @@ module Google
3529
2928
  execute_or_queue_command(command, &block)
3530
2929
  end
3531
2930
 
3532
- # Deletes a specified playbook.
2931
+ #
3533
2932
  # @param [String] name
3534
- # Required. The name of the playbook to delete. Format: `projects//locations//
3535
- # agents//playbooks/`.
3536
2933
  # @param [String] fields
3537
2934
  # Selector specifying which fields to include in a partial response.
3538
2935
  # @param [String] quota_user
@@ -3560,11 +2957,8 @@ module Google
3560
2957
  execute_or_queue_command(command, &block)
3561
2958
  end
3562
2959
 
3563
- # Exports the specified playbook to a binary file. Note that resources (e.g.
3564
- # examples, tools) that the playbook references will also be exported.
2960
+ #
3565
2961
  # @param [String] name
3566
- # Required. The name of the playbook to export. Format: `projects//locations//
3567
- # agents//playbooks/`.
3568
2962
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportPlaybookRequest] google_cloud_dialogflow_cx_v3_export_playbook_request_object
3569
2963
  # @param [String] fields
3570
2964
  # Selector specifying which fields to include in a partial response.
@@ -3595,10 +2989,8 @@ module Google
3595
2989
  execute_or_queue_command(command, &block)
3596
2990
  end
3597
2991
 
3598
- # Retrieves the specified Playbook.
2992
+ #
3599
2993
  # @param [String] name
3600
- # Required. The name of the playbook. Format: `projects//locations//agents//
3601
- # playbooks/`.
3602
2994
  # @param [String] fields
3603
2995
  # Selector specifying which fields to include in a partial response.
3604
2996
  # @param [String] quota_user
@@ -3626,10 +3018,8 @@ module Google
3626
3018
  execute_or_queue_command(command, &block)
3627
3019
  end
3628
3020
 
3629
- # Imports the specified playbook to the specified agent from a binary file.
3021
+ #
3630
3022
  # @param [String] parent
3631
- # Required. The agent to import the playbook into. Format: `projects//locations//
3632
- # agents/`.
3633
3023
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportPlaybookRequest] google_cloud_dialogflow_cx_v3_import_playbook_request_object
3634
3024
  # @param [String] fields
3635
3025
  # Selector specifying which fields to include in a partial response.
@@ -3660,15 +3050,10 @@ module Google
3660
3050
  execute_or_queue_command(command, &block)
3661
3051
  end
3662
3052
 
3663
- # Returns a list of playbooks in the specified agent.
3053
+ #
3664
3054
  # @param [String] parent
3665
- # Required. The agent to list playbooks from. Format: `projects//locations//
3666
- # agents/`.
3667
3055
  # @param [Fixnum] page_size
3668
- # The maximum number of items to return in a single page. By default 100 and at
3669
- # most 1000.
3670
3056
  # @param [String] page_token
3671
- # The next_page_token value returned from a previous list request.
3672
3057
  # @param [String] fields
3673
3058
  # Selector specifying which fields to include in a partial response.
3674
3059
  # @param [String] quota_user
@@ -3698,14 +3083,10 @@ module Google
3698
3083
  execute_or_queue_command(command, &block)
3699
3084
  end
3700
3085
 
3701
- # Updates the specified Playbook.
3086
+ #
3702
3087
  # @param [String] name
3703
- # The unique identifier of the playbook. Format: `projects//locations//agents//
3704
- # playbooks/`.
3705
3088
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Playbook] google_cloud_dialogflow_cx_v3_playbook_object
3706
3089
  # @param [String] update_mask
3707
- # The mask to control which fields get updated. If the mask is not present, all
3708
- # fields will be updated.
3709
3090
  # @param [String] fields
3710
3091
  # Selector specifying which fields to include in a partial response.
3711
3092
  # @param [String] quota_user
@@ -3736,10 +3117,8 @@ module Google
3736
3117
  execute_or_queue_command(command, &block)
3737
3118
  end
3738
3119
 
3739
- # Creates an example in the specified playbook.
3120
+ #
3740
3121
  # @param [String] parent
3741
- # Required. The playbook to create an example for. Format: `projects//locations//
3742
- # agents//playbooks/`.
3743
3122
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Example] google_cloud_dialogflow_cx_v3_example_object
3744
3123
  # @param [String] fields
3745
3124
  # Selector specifying which fields to include in a partial response.
@@ -3770,10 +3149,8 @@ module Google
3770
3149
  execute_or_queue_command(command, &block)
3771
3150
  end
3772
3151
 
3773
- # Deletes the specified example.
3152
+ #
3774
3153
  # @param [String] name
3775
- # Required. The name of the example to delete. Format: `projects//locations//
3776
- # agents//playbooks//examples/`.
3777
3154
  # @param [String] fields
3778
3155
  # Selector specifying which fields to include in a partial response.
3779
3156
  # @param [String] quota_user
@@ -3801,10 +3178,8 @@ module Google
3801
3178
  execute_or_queue_command(command, &block)
3802
3179
  end
3803
3180
 
3804
- # Retrieves the specified example.
3181
+ #
3805
3182
  # @param [String] name
3806
- # Required. The name of the example. Format: `projects//locations//agents//
3807
- # playbooks//examples/`.
3808
3183
  # @param [String] fields
3809
3184
  # Selector specifying which fields to include in a partial response.
3810
3185
  # @param [String] quota_user
@@ -3832,19 +3207,11 @@ module Google
3832
3207
  execute_or_queue_command(command, &block)
3833
3208
  end
3834
3209
 
3835
- # Returns a list of examples in the specified playbook.
3210
+ #
3836
3211
  # @param [String] parent
3837
- # Required. The playbook to list the examples from. Format: `projects//locations/
3838
- # /agents//playbooks/`.
3839
3212
  # @param [String] language_code
3840
- # Optional. The language to list examples for. If not specified, list all
3841
- # examples under the playbook. Note: languages must be enabled in the agent
3842
- # before they can be used.
3843
3213
  # @param [Fixnum] page_size
3844
- # Optional. The maximum number of items to return in a single page. By default
3845
- # 100 and at most 1000.
3846
3214
  # @param [String] page_token
3847
- # Optional. The next_page_token value returned from a previous list request.
3848
3215
  # @param [String] fields
3849
3216
  # Selector specifying which fields to include in a partial response.
3850
3217
  # @param [String] quota_user
@@ -3875,14 +3242,10 @@ module Google
3875
3242
  execute_or_queue_command(command, &block)
3876
3243
  end
3877
3244
 
3878
- # Update the specified example.
3245
+ #
3879
3246
  # @param [String] name
3880
- # The unique identifier of the playbook example. Format: `projects//locations//
3881
- # agents//playbooks//examples/`.
3882
3247
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Example] google_cloud_dialogflow_cx_v3_example_object
3883
3248
  # @param [String] update_mask
3884
- # Optional. The mask to control which fields get updated. If the mask is not
3885
- # present, all fields will be updated.
3886
3249
  # @param [String] fields
3887
3250
  # Selector specifying which fields to include in a partial response.
3888
3251
  # @param [String] quota_user
@@ -3913,10 +3276,8 @@ module Google
3913
3276
  execute_or_queue_command(command, &block)
3914
3277
  end
3915
3278
 
3916
- # Creates a version for the specified Playbook.
3279
+ #
3917
3280
  # @param [String] parent
3918
- # Required. The playbook to create a version for. Format: `projects//locations//
3919
- # agents//playbooks/`.
3920
3281
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3PlaybookVersion] google_cloud_dialogflow_cx_v3_playbook_version_object
3921
3282
  # @param [String] fields
3922
3283
  # Selector specifying which fields to include in a partial response.
@@ -3947,10 +3308,8 @@ module Google
3947
3308
  execute_or_queue_command(command, &block)
3948
3309
  end
3949
3310
 
3950
- # Deletes the specified version of the Playbook.
3311
+ #
3951
3312
  # @param [String] name
3952
- # Required. The name of the playbook version to delete. Format: `projects//
3953
- # locations//agents//playbooks//versions/`.
3954
3313
  # @param [String] fields
3955
3314
  # Selector specifying which fields to include in a partial response.
3956
3315
  # @param [String] quota_user
@@ -3978,10 +3337,8 @@ module Google
3978
3337
  execute_or_queue_command(command, &block)
3979
3338
  end
3980
3339
 
3981
- # Retrieves the specified version of the Playbook.
3340
+ #
3982
3341
  # @param [String] name
3983
- # Required. The name of the playbook version. Format: `projects//locations//
3984
- # agents//playbooks//versions/`.
3985
3342
  # @param [String] fields
3986
3343
  # Selector specifying which fields to include in a partial response.
3987
3344
  # @param [String] quota_user
@@ -4009,15 +3366,10 @@ module Google
4009
3366
  execute_or_queue_command(command, &block)
4010
3367
  end
4011
3368
 
4012
- # Lists versions for the specified Playbook.
3369
+ #
4013
3370
  # @param [String] parent
4014
- # Required. The playbook to list versions for. Format: `projects//locations//
4015
- # agents//playbooks/`.
4016
3371
  # @param [Fixnum] page_size
4017
- # Optional. The maximum number of items to return in a single page. By default
4018
- # 100 and at most 1000.
4019
3372
  # @param [String] page_token
4020
- # Optional. The next_page_token value returned from a previous list request.
4021
3373
  # @param [String] fields
4022
3374
  # Selector specifying which fields to include in a partial response.
4023
3375
  # @param [String] quota_user
@@ -4047,11 +3399,8 @@ module Google
4047
3399
  execute_or_queue_command(command, &block)
4048
3400
  end
4049
3401
 
4050
- # Retrieves the specified version of the Playbook and stores it as the current
4051
- # playbook draft, returning the playbook with resources updated.
3402
+ #
4052
3403
  # @param [String] name
4053
- # Required. The name of the playbook version. Format: `projects//locations//
4054
- # agents//playbooks//versions/`.
4055
3404
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest] google_cloud_dialogflow_cx_v3_restore_playbook_version_request_object
4056
3405
  # @param [String] fields
4057
3406
  # Selector specifying which fields to include in a partial response.
@@ -4082,22 +3431,8 @@ module Google
4082
3431
  execute_or_queue_command(command, &block)
4083
3432
  end
4084
3433
 
4085
- # Processes a natural language query and returns structured, actionable data as
4086
- # a result. This method is not idempotent, because it may cause session entity
4087
- # types to be updated, which in turn might affect results of future queries.
4088
- # Note: Always use agent versions for production traffic. See [Versions and
4089
- # environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
3434
+ #
4090
3435
  # @param [String] session
4091
- # Required. The name of the session this query is sent to. Format: `projects//
4092
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4093
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4094
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
4095
- # It can be a random number or some type of session identifiers (preferably
4096
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
4097
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
4098
- # cx/docs/concept/session). Note: Always use agent versions for production
4099
- # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
4100
- # cx/docs/concept/version).
4101
3436
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest] google_cloud_dialogflow_cx_v3_detect_intent_request_object
4102
3437
  # @param [String] fields
4103
3438
  # Selector specifying which fields to include in a partial response.
@@ -4128,18 +3463,8 @@ module Google
4128
3463
  execute_or_queue_command(command, &block)
4129
3464
  end
4130
3465
 
4131
- # Fulfills a matched intent returned by MatchIntent. Must be called after
4132
- # MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is
4133
- # undefined.
3466
+ #
4134
3467
  # @param [String] session
4135
- # Required. The name of the session this query is sent to. Format: `projects//
4136
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4137
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4138
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
4139
- # It can be a random number or some type of session identifiers (preferably
4140
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
4141
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
4142
- # cx/docs/concept/session).
4143
3468
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest] google_cloud_dialogflow_cx_v3_fulfill_intent_request_object
4144
3469
  # @param [String] fields
4145
3470
  # Selector specifying which fields to include in a partial response.
@@ -4170,16 +3495,8 @@ module Google
4170
3495
  execute_or_queue_command(command, &block)
4171
3496
  end
4172
3497
 
4173
- # Returns preliminary intent match results, doesn't change the session status.
3498
+ #
4174
3499
  # @param [String] session
4175
- # Required. The name of the session this query is sent to. Format: `projects//
4176
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4177
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4178
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
4179
- # It can be a random number or some type of session identifiers (preferably
4180
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
4181
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
4182
- # cx/docs/concept/session).
4183
3500
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest] google_cloud_dialogflow_cx_v3_match_intent_request_object
4184
3501
  # @param [String] fields
4185
3502
  # Selector specifying which fields to include in a partial response.
@@ -4210,21 +3527,8 @@ module Google
4210
3527
  execute_or_queue_command(command, &block)
4211
3528
  end
4212
3529
 
4213
- # Processes a natural language query and returns structured, actionable data as
4214
- # a result through server-side streaming. Server-side streaming allows
4215
- # Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/
4216
- # docs/concept/fulfillment#partial-response) earlier in a single request.
3530
+ #
4217
3531
  # @param [String] session
4218
- # Required. The name of the session this query is sent to. Format: `projects//
4219
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4220
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4221
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
4222
- # It can be a random number or some type of session identifiers (preferably
4223
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
4224
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
4225
- # cx/docs/concept/session). Note: Always use agent versions for production
4226
- # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
4227
- # cx/docs/concept/version).
4228
3532
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest] google_cloud_dialogflow_cx_v3_detect_intent_request_object
4229
3533
  # @param [String] fields
4230
3534
  # Selector specifying which fields to include in a partial response.
@@ -4255,10 +3559,8 @@ module Google
4255
3559
  execute_or_queue_command(command, &block)
4256
3560
  end
4257
3561
 
4258
- # Updates the feedback received from the user for a single turn of the bot
4259
- # response.
3562
+ #
4260
3563
  # @param [String] session
4261
- # Required. The name of the session the feedback was sent to.
4262
3564
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest] google_cloud_dialogflow_cx_v3_submit_answer_feedback_request_object
4263
3565
  # @param [String] fields
4264
3566
  # Selector specifying which fields to include in a partial response.
@@ -4289,12 +3591,8 @@ module Google
4289
3591
  execute_or_queue_command(command, &block)
4290
3592
  end
4291
3593
 
4292
- # Creates a session entity type.
3594
+ #
4293
3595
  # @param [String] parent
4294
- # Required. The session to create a session entity type for. Format: `projects//
4295
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4296
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4297
- # environment.
4298
3596
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] google_cloud_dialogflow_cx_v3_session_entity_type_object
4299
3597
  # @param [String] fields
4300
3598
  # Selector specifying which fields to include in a partial response.
@@ -4325,12 +3623,8 @@ module Google
4325
3623
  execute_or_queue_command(command, &block)
4326
3624
  end
4327
3625
 
4328
- # Deletes the specified session entity type.
3626
+ #
4329
3627
  # @param [String] name
4330
- # Required. The name of the session entity type to delete. Format: `projects//
4331
- # locations//agents//sessions//entityTypes/` or `projects//locations//agents//
4332
- # environments//sessions//entityTypes/`. If `Environment ID` is not specified,
4333
- # we assume default 'draft' environment.
4334
3628
  # @param [String] fields
4335
3629
  # Selector specifying which fields to include in a partial response.
4336
3630
  # @param [String] quota_user
@@ -4358,12 +3652,8 @@ module Google
4358
3652
  execute_or_queue_command(command, &block)
4359
3653
  end
4360
3654
 
4361
- # Retrieves the specified session entity type.
3655
+ #
4362
3656
  # @param [String] name
4363
- # Required. The name of the session entity type. Format: `projects//locations//
4364
- # agents//sessions//entityTypes/` or `projects//locations//agents//environments//
4365
- # sessions//entityTypes/`. If `Environment ID` is not specified, we assume
4366
- # default 'draft' environment.
4367
3657
  # @param [String] fields
4368
3658
  # Selector specifying which fields to include in a partial response.
4369
3659
  # @param [String] quota_user
@@ -4391,17 +3681,10 @@ module Google
4391
3681
  execute_or_queue_command(command, &block)
4392
3682
  end
4393
3683
 
4394
- # Returns the list of all session entity types in the specified session.
3684
+ #
4395
3685
  # @param [String] parent
4396
- # Required. The session to list all session entity types from. Format: `projects/
4397
- # /locations//agents//sessions/` or `projects//locations//agents//environments//
4398
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4399
- # environment.
4400
3686
  # @param [Fixnum] page_size
4401
- # The maximum number of items to return in a single page. By default 100 and at
4402
- # most 1000.
4403
3687
  # @param [String] page_token
4404
- # The next_page_token value returned from a previous list request.
4405
3688
  # @param [String] fields
4406
3689
  # Selector specifying which fields to include in a partial response.
4407
3690
  # @param [String] quota_user
@@ -4431,15 +3714,10 @@ module Google
4431
3714
  execute_or_queue_command(command, &block)
4432
3715
  end
4433
3716
 
4434
- # Updates the specified session entity type.
3717
+ #
4435
3718
  # @param [String] name
4436
- # Required. The unique identifier of the session entity type. Format: `projects//
4437
- # locations//agents//sessions//entityTypes/` or `projects//locations//agents//
4438
- # environments//sessions//entityTypes/`. If `Environment ID` is not specified,
4439
- # we assume default 'draft' environment.
4440
3719
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] google_cloud_dialogflow_cx_v3_session_entity_type_object
4441
3720
  # @param [String] update_mask
4442
- # The mask to control which fields get updated.
4443
3721
  # @param [String] fields
4444
3722
  # Selector specifying which fields to include in a partial response.
4445
3723
  # @param [String] quota_user
@@ -4470,10 +3748,8 @@ module Google
4470
3748
  execute_or_queue_command(command, &block)
4471
3749
  end
4472
3750
 
4473
- # Batch deletes test cases.
3751
+ #
4474
3752
  # @param [String] parent
4475
- # Required. The agent to delete test cases from. Format: `projects//locations//
4476
- # agents/`.
4477
3753
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest] google_cloud_dialogflow_cx_v3_batch_delete_test_cases_request_object
4478
3754
  # @param [String] fields
4479
3755
  # Selector specifying which fields to include in a partial response.
@@ -4504,12 +3780,8 @@ module Google
4504
3780
  execute_or_queue_command(command, &block)
4505
3781
  end
4506
3782
 
4507
- # Kicks off a batch run of test cases. This method is a [long-running operation](
4508
- # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
4509
- # returned `Operation` type has the following method-specific fields: - `
4510
- # metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse
3783
+ #
4511
3784
  # @param [String] parent
4512
- # Required. Agent name. Format: `projects//locations//agents/`.
4513
3785
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchRunTestCasesRequest] google_cloud_dialogflow_cx_v3_batch_run_test_cases_request_object
4514
3786
  # @param [String] fields
4515
3787
  # Selector specifying which fields to include in a partial response.
@@ -4540,12 +3812,9 @@ module Google
4540
3812
  execute_or_queue_command(command, &block)
4541
3813
  end
4542
3814
 
4543
- # Calculates the test coverage for an agent.
3815
+ #
4544
3816
  # @param [String] agent
4545
- # Required. The agent to calculate coverage for. Format: `projects//locations//
4546
- # agents/`.
4547
3817
  # @param [String] type
4548
- # Required. The type of coverage requested.
4549
3818
  # @param [String] fields
4550
3819
  # Selector specifying which fields to include in a partial response.
4551
3820
  # @param [String] quota_user
@@ -4574,10 +3843,8 @@ module Google
4574
3843
  execute_or_queue_command(command, &block)
4575
3844
  end
4576
3845
 
4577
- # Creates a test case for the given agent.
3846
+ #
4578
3847
  # @param [String] parent
4579
- # Required. The agent to create the test case for. Format: `projects//locations//
4580
- # agents/`.
4581
3848
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase] google_cloud_dialogflow_cx_v3_test_case_object
4582
3849
  # @param [String] fields
4583
3850
  # Selector specifying which fields to include in a partial response.
@@ -4608,15 +3875,8 @@ module Google
4608
3875
  execute_or_queue_command(command, &block)
4609
3876
  end
4610
3877
 
4611
- # Exports the test cases under the agent to a Cloud Storage bucket or a local
4612
- # file. Filter can be applied to export a subset of test cases. This method is a
4613
- # [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
4614
- # running-operation). The returned `Operation` type has the following method-
4615
- # specific fields: - `metadata`: ExportTestCasesMetadata - `response`:
4616
- # ExportTestCasesResponse
3878
+ #
4617
3879
  # @param [String] parent
4618
- # Required. The agent where to export test cases from. Format: `projects//
4619
- # locations//agents/`.
4620
3880
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportTestCasesRequest] google_cloud_dialogflow_cx_v3_export_test_cases_request_object
4621
3881
  # @param [String] fields
4622
3882
  # Selector specifying which fields to include in a partial response.
@@ -4647,10 +3907,8 @@ module Google
4647
3907
  execute_or_queue_command(command, &block)
4648
3908
  end
4649
3909
 
4650
- # Gets a test case.
3910
+ #
4651
3911
  # @param [String] name
4652
- # Required. The name of the testcase. Format: `projects//locations//agents//
4653
- # testCases/`.
4654
3912
  # @param [String] fields
4655
3913
  # Selector specifying which fields to include in a partial response.
4656
3914
  # @param [String] quota_user
@@ -4678,16 +3936,8 @@ module Google
4678
3936
  execute_or_queue_command(command, &block)
4679
3937
  end
4680
3938
 
4681
- # Imports the test cases from a Cloud Storage bucket or a local file. It always
4682
- # creates new test cases and won't overwrite any existing ones. The provided ID
4683
- # in the imported test case is neglected. This method is a [long-running
4684
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
4685
- # operation). The returned `Operation` type has the following method-specific
4686
- # fields: - `metadata`: ImportTestCasesMetadata - `response`:
4687
- # ImportTestCasesResponse
3939
+ #
4688
3940
  # @param [String] parent
4689
- # Required. The agent to import test cases to. Format: `projects//locations//
4690
- # agents/`.
4691
3941
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportTestCasesRequest] google_cloud_dialogflow_cx_v3_import_test_cases_request_object
4692
3942
  # @param [String] fields
4693
3943
  # Selector specifying which fields to include in a partial response.
@@ -4718,18 +3968,11 @@ module Google
4718
3968
  execute_or_queue_command(command, &block)
4719
3969
  end
4720
3970
 
4721
- # Fetches a list of test cases for a given agent.
3971
+ #
4722
3972
  # @param [String] parent
4723
- # Required. The agent to list all pages for. Format: `projects//locations//
4724
- # agents/`.
4725
3973
  # @param [Fixnum] page_size
4726
- # The maximum number of items to return in a single page. By default 20. Note
4727
- # that when TestCaseView = FULL, the maximum page size allowed is 20. When
4728
- # TestCaseView = BASIC, the maximum page size allowed is 500.
4729
3974
  # @param [String] page_token
4730
- # The next_page_token value returned from a previous list request.
4731
3975
  # @param [String] view
4732
- # Specifies whether response should include all fields or just the metadata.
4733
3976
  # @param [String] fields
4734
3977
  # Selector specifying which fields to include in a partial response.
4735
3978
  # @param [String] quota_user
@@ -4760,15 +4003,10 @@ module Google
4760
4003
  execute_or_queue_command(command, &block)
4761
4004
  end
4762
4005
 
4763
- # Updates the specified test case.
4006
+ #
4764
4007
  # @param [String] name
4765
- # The unique identifier of the test case. TestCases.CreateTestCase will populate
4766
- # the name automatically. Otherwise use format: `projects//locations//agents//
4767
- # testCases/`.
4768
4008
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase] google_cloud_dialogflow_cx_v3_test_case_object
4769
4009
  # @param [String] update_mask
4770
- # Required. The mask to specify which fields should be updated. The `
4771
- # creationTime` and `lastTestResult` cannot be updated.
4772
4010
  # @param [String] fields
4773
4011
  # Selector specifying which fields to include in a partial response.
4774
4012
  # @param [String] quota_user
@@ -4799,13 +4037,8 @@ module Google
4799
4037
  execute_or_queue_command(command, &block)
4800
4038
  end
4801
4039
 
4802
- # Kicks off a test case run. This method is a [long-running operation](https://
4803
- # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
4804
- # Operation` type has the following method-specific fields: - `metadata`:
4805
- # RunTestCaseMetadata - `response`: RunTestCaseResponse
4040
+ #
4806
4041
  # @param [String] name
4807
- # Required. Format of test case name to run: `projects//locations//agents//
4808
- # testCases/`.
4809
4042
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunTestCaseRequest] google_cloud_dialogflow_cx_v3_run_test_case_request_object
4810
4043
  # @param [String] fields
4811
4044
  # Selector specifying which fields to include in a partial response.
@@ -4836,10 +4069,8 @@ module Google
4836
4069
  execute_or_queue_command(command, &block)
4837
4070
  end
4838
4071
 
4839
- # Gets a test case result.
4072
+ #
4840
4073
  # @param [String] name
4841
- # Required. The name of the testcase. Format: `projects//locations//agents//
4842
- # testCases//results/`.
4843
4074
  # @param [String] fields
4844
4075
  # Selector specifying which fields to include in a partial response.
4845
4076
  # @param [String] quota_user
@@ -4867,30 +4098,11 @@ module Google
4867
4098
  execute_or_queue_command(command, &block)
4868
4099
  end
4869
4100
 
4870
- # Fetches the list of run results for the given test case. A maximum of 100
4871
- # results are kept for each test case.
4101
+ #
4872
4102
  # @param [String] parent
4873
- # Required. The test case to list results for. Format: `projects//locations//
4874
- # agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list
4875
- # results across multiple test cases.
4876
4103
  # @param [String] filter
4877
- # The filter expression used to filter test case results. See [API Filtering](
4878
- # https://aip.dev/160). The expression is case insensitive. Only 'AND' is
4879
- # supported for logical operators. The supported syntax is listed below in
4880
- # detail: [AND ] ... [AND latest] The supported fields and operators are: field
4881
- # operator `environment` `=`, `IN` (Use value `draft` for draft environment) `
4882
- # test_time` `>`, `<` `latest` only returns the latest test result in all
4883
- # results for each test case. Examples: * "environment=draft AND latest" matches
4884
- # the latest test result for each test case in the draft environment. * "
4885
- # environment IN (e1,e2)" matches any test case results with an environment
4886
- # resource name of either "e1" or "e2". * "test_time > 1602540713" matches any
4887
- # test case results with test time later than a unix timestamp in seconds
4888
- # 1602540713.
4889
4104
  # @param [Fixnum] page_size
4890
- # The maximum number of items to return in a single page. By default 100 and at
4891
- # most 1000.
4892
4105
  # @param [String] page_token
4893
- # The next_page_token value returned from a previous list request.
4894
4106
  # @param [String] fields
4895
4107
  # Selector specifying which fields to include in a partial response.
4896
4108
  # @param [String] quota_user
@@ -4921,10 +4133,8 @@ module Google
4921
4133
  execute_or_queue_command(command, &block)
4922
4134
  end
4923
4135
 
4924
- # Creates a Tool in the specified agent.
4136
+ #
4925
4137
  # @param [String] parent
4926
- # Required. The agent to create a Tool for. Format: `projects//locations//agents/
4927
- # `.
4928
4138
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Tool] google_cloud_dialogflow_cx_v3_tool_object
4929
4139
  # @param [String] fields
4930
4140
  # Selector specifying which fields to include in a partial response.
@@ -4955,15 +4165,9 @@ module Google
4955
4165
  execute_or_queue_command(command, &block)
4956
4166
  end
4957
4167
 
4958
- # Deletes a specified Tool.
4168
+ #
4959
4169
  # @param [String] name
4960
- # Required. The name of the Tool to be deleted. Format: `projects//locations//
4961
- # agents//tools/`.
4962
4170
  # @param [Boolean] force
4963
- # This field has no effect for Tools not being used. For Tools that are used: *
4964
- # If `force` is set to false, an error will be returned with message indicating
4965
- # the referenced resources. * If `force` is set to true, Dialogflow will remove
4966
- # the tool, as well as any references to the tool.
4967
4171
  # @param [String] fields
4968
4172
  # Selector specifying which fields to include in a partial response.
4969
4173
  # @param [String] quota_user
@@ -4992,9 +4196,8 @@ module Google
4992
4196
  execute_or_queue_command(command, &block)
4993
4197
  end
4994
4198
 
4995
- # Retrieves the specified Tool.
4199
+ #
4996
4200
  # @param [String] name
4997
- # Required. The name of the Tool. Format: `projects//locations//agents//tools/`.
4998
4201
  # @param [String] fields
4999
4202
  # Selector specifying which fields to include in a partial response.
5000
4203
  # @param [String] quota_user
@@ -5022,15 +4225,10 @@ module Google
5022
4225
  execute_or_queue_command(command, &block)
5023
4226
  end
5024
4227
 
5025
- # Returns a list of Tools in the specified agent.
4228
+ #
5026
4229
  # @param [String] parent
5027
- # Required. The agent to list the Tools from. Format: `projects//locations//
5028
- # agents/`.
5029
4230
  # @param [Fixnum] page_size
5030
- # The maximum number of items to return in a single page. By default 100 and at
5031
- # most 1000.
5032
4231
  # @param [String] page_token
5033
- # The next_page_token value returned from a previous list request.
5034
4232
  # @param [String] fields
5035
4233
  # Selector specifying which fields to include in a partial response.
5036
4234
  # @param [String] quota_user
@@ -5060,14 +4258,10 @@ module Google
5060
4258
  execute_or_queue_command(command, &block)
5061
4259
  end
5062
4260
 
5063
- # Update the specified Tool.
4261
+ #
5064
4262
  # @param [String] name
5065
- # The unique identifier of the Tool. Format: `projects//locations//agents//tools/
5066
- # `.
5067
4263
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Tool] google_cloud_dialogflow_cx_v3_tool_object
5068
4264
  # @param [String] update_mask
5069
- # The mask to control which fields get updated. If the mask is not present, all
5070
- # fields will be updated.
5071
4265
  # @param [String] fields
5072
4266
  # Selector specifying which fields to include in a partial response.
5073
4267
  # @param [String] quota_user
@@ -5098,10 +4292,8 @@ module Google
5098
4292
  execute_or_queue_command(command, &block)
5099
4293
  end
5100
4294
 
5101
- # Creates a version for the specified Tool.
4295
+ #
5102
4296
  # @param [String] parent
5103
- # Required. The tool to create a version for. Format: `projects//locations//
5104
- # agents//tools/`.
5105
4297
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ToolVersion] google_cloud_dialogflow_cx_v3_tool_version_object
5106
4298
  # @param [String] fields
5107
4299
  # Selector specifying which fields to include in a partial response.
@@ -5132,15 +4324,9 @@ module Google
5132
4324
  execute_or_queue_command(command, &block)
5133
4325
  end
5134
4326
 
5135
- # Deletes the specified version of the Tool.
4327
+ #
5136
4328
  # @param [String] name
5137
- # Required. The name of the tool version to delete. Format: `projects//locations/
5138
- # /agents//tools//versions/`.
5139
4329
  # @param [Boolean] force
5140
- # Optional. This field has no effect for Tools not being used. For Tools that
5141
- # are used: * If `force` is set to false, an error will be returned with message
5142
- # indicating the referenced resources. * If `force` is set to true, Dialogflow
5143
- # will remove the tool, as well as any references to the tool.
5144
4330
  # @param [String] fields
5145
4331
  # Selector specifying which fields to include in a partial response.
5146
4332
  # @param [String] quota_user
@@ -5169,10 +4355,8 @@ module Google
5169
4355
  execute_or_queue_command(command, &block)
5170
4356
  end
5171
4357
 
5172
- # Retrieves the specified version of the Tool.
4358
+ #
5173
4359
  # @param [String] name
5174
- # Required. The name of the tool version. Format: `projects//locations//agents//
5175
- # tools//versions/`.
5176
4360
  # @param [String] fields
5177
4361
  # Selector specifying which fields to include in a partial response.
5178
4362
  # @param [String] quota_user
@@ -5200,15 +4384,10 @@ module Google
5200
4384
  execute_or_queue_command(command, &block)
5201
4385
  end
5202
4386
 
5203
- # List versions of the specified Tool.
4387
+ #
5204
4388
  # @param [String] parent
5205
- # Required. The parent of the tool versions. Format: `projects//locations//
5206
- # agents//tools/`.
5207
4389
  # @param [Fixnum] page_size
5208
- # Optional. The maximum number of items to return in a single page. By default
5209
- # 100 and at most 1000.
5210
4390
  # @param [String] page_token
5211
- # Optional. The next_page_token value returned from a previous list request.
5212
4391
  # @param [String] fields
5213
4392
  # Selector specifying which fields to include in a partial response.
5214
4393
  # @param [String] quota_user
@@ -5238,11 +4417,8 @@ module Google
5238
4417
  execute_or_queue_command(command, &block)
5239
4418
  end
5240
4419
 
5241
- # Retrieves the specified version of the Tool and stores it as the current tool
5242
- # draft, returning the tool with resources updated.
4420
+ #
5243
4421
  # @param [String] name
5244
- # Required. The name of the tool version. Format: `projects//locations//agents//
5245
- # tools//versions/`.
5246
4422
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RestoreToolVersionRequest] google_cloud_dialogflow_cx_v3_restore_tool_version_request_object
5247
4423
  # @param [String] fields
5248
4424
  # Selector specifying which fields to include in a partial response.
@@ -5273,21 +4449,10 @@ module Google
5273
4449
  execute_or_queue_command(command, &block)
5274
4450
  end
5275
4451
 
5276
- # Creates an TransitionRouteGroup in the specified flow. Note: You should always
5277
- # train a flow prior to sending it queries. See the [training documentation](
5278
- # https://cloud.google.com/dialogflow/cx/docs/concept/training).
4452
+ #
5279
4453
  # @param [String] parent
5280
- # Required. The flow to create an TransitionRouteGroup for. Format: `projects//
5281
- # locations//agents//flows/` or `projects//locations//agents/` for agent-level
5282
- # groups.
5283
4454
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] google_cloud_dialogflow_cx_v3_transition_route_group_object
5284
4455
  # @param [String] language_code
5285
- # The language of the following fields in `TransitionRouteGroup`: * `
5286
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `
5287
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
5288
- # If not specified, the agent's default language is used. [Many languages](https:
5289
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
5290
- # languages must be enabled in the agent before they can be used.
5291
4456
  # @param [String] fields
5292
4457
  # Selector specifying which fields to include in a partial response.
5293
4458
  # @param [String] quota_user
@@ -5318,19 +4483,9 @@ module Google
5318
4483
  execute_or_queue_command(command, &block)
5319
4484
  end
5320
4485
 
5321
- # Deletes the specified TransitionRouteGroup. Note: You should always train a
5322
- # flow prior to sending it queries. See the [training documentation](https://
5323
- # cloud.google.com/dialogflow/cx/docs/concept/training).
4486
+ #
5324
4487
  # @param [String] name
5325
- # Required. The name of the TransitionRouteGroup to delete. Format: `projects//
5326
- # locations//agents//flows//transitionRouteGroups/` or `projects//locations//
5327
- # agents//transitionRouteGroups/`.
5328
4488
  # @param [Boolean] force
5329
- # This field has no effect for transition route group that no page is using. If
5330
- # the transition route group is referenced by any page: * If `force` is set to
5331
- # false, an error will be returned with message indicating pages that reference
5332
- # the transition route group. * If `force` is set to true, Dialogflow will
5333
- # remove the transition route group, as well as any reference to it.
5334
4489
  # @param [String] fields
5335
4490
  # Selector specifying which fields to include in a partial response.
5336
4491
  # @param [String] quota_user
@@ -5359,19 +4514,9 @@ module Google
5359
4514
  execute_or_queue_command(command, &block)
5360
4515
  end
5361
4516
 
5362
- # Retrieves the specified TransitionRouteGroup.
4517
+ #
5363
4518
  # @param [String] name
5364
- # Required. The name of the TransitionRouteGroup. Format: `projects//locations//
5365
- # agents//flows//transitionRouteGroups/` or `projects//locations//agents//
5366
- # transitionRouteGroups/`.
5367
4519
  # @param [String] language_code
5368
- # The language to retrieve the transition route group for. The following fields
5369
- # are language dependent: * `TransitionRouteGroup.transition_routes.
5370
- # trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.
5371
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
5372
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
5373
- # reference/language) are supported. Note: languages must be enabled in the
5374
- # agent before they can be used.
5375
4520
  # @param [String] fields
5376
4521
  # Selector specifying which fields to include in a partial response.
5377
4522
  # @param [String] quota_user
@@ -5400,23 +4545,11 @@ module Google
5400
4545
  execute_or_queue_command(command, &block)
5401
4546
  end
5402
4547
 
5403
- # Returns the list of all transition route groups in the specified flow.
4548
+ #
5404
4549
  # @param [String] parent
5405
- # Required. The flow to list all transition route groups for. Format: `projects//
5406
- # locations//agents//flows/` or `projects//locations//agents/.
5407
4550
  # @param [String] language_code
5408
- # The language to list transition route groups for. The following fields are
5409
- # language dependent: * `TransitionRouteGroup.transition_routes.
5410
- # trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.
5411
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
5412
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
5413
- # reference/language) are supported. Note: languages must be enabled in the
5414
- # agent before they can be used.
5415
4551
  # @param [Fixnum] page_size
5416
- # The maximum number of items to return in a single page. By default 100 and at
5417
- # most 1000.
5418
4552
  # @param [String] page_token
5419
- # The next_page_token value returned from a previous list request.
5420
4553
  # @param [String] fields
5421
4554
  # Selector specifying which fields to include in a partial response.
5422
4555
  # @param [String] quota_user
@@ -5447,23 +4580,11 @@ module Google
5447
4580
  execute_or_queue_command(command, &block)
5448
4581
  end
5449
4582
 
5450
- # Updates the specified TransitionRouteGroup. Note: You should always train a
5451
- # flow prior to sending it queries. See the [training documentation](https://
5452
- # cloud.google.com/dialogflow/cx/docs/concept/training).
4583
+ #
5453
4584
  # @param [String] name
5454
- # The unique identifier of the transition route group. TransitionRouteGroups.
5455
- # CreateTransitionRouteGroup populates the name automatically. Format: `projects/
5456
- # /locations//agents//flows//transitionRouteGroups/` .
5457
4585
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] google_cloud_dialogflow_cx_v3_transition_route_group_object
5458
4586
  # @param [String] language_code
5459
- # The language of the following fields in `TransitionRouteGroup`: * `
5460
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `
5461
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
5462
- # If not specified, the agent's default language is used. [Many languages](https:
5463
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
5464
- # languages must be enabled in the agent before they can be used.
5465
4587
  # @param [String] update_mask
5466
- # The mask to control which fields get updated.
5467
4588
  # @param [String] fields
5468
4589
  # Selector specifying which fields to include in a partial response.
5469
4590
  # @param [String] quota_user
@@ -5495,10 +4616,8 @@ module Google
5495
4616
  execute_or_queue_command(command, &block)
5496
4617
  end
5497
4618
 
5498
- # Creates a webhook in the specified agent.
4619
+ #
5499
4620
  # @param [String] parent
5500
- # Required. The agent to create a webhook for. Format: `projects//locations//
5501
- # agents/`.
5502
4621
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook] google_cloud_dialogflow_cx_v3_webhook_object
5503
4622
  # @param [String] fields
5504
4623
  # Selector specifying which fields to include in a partial response.
@@ -5529,17 +4648,9 @@ module Google
5529
4648
  execute_or_queue_command(command, &block)
5530
4649
  end
5531
4650
 
5532
- # Deletes the specified webhook.
4651
+ #
5533
4652
  # @param [String] name
5534
- # Required. The name of the webhook to delete. Format: `projects//locations//
5535
- # agents//webhooks/`.
5536
4653
  # @param [Boolean] force
5537
- # This field has no effect for webhook not being used. For webhooks that are
5538
- # used by pages/flows/transition route groups: * If `force` is set to false, an
5539
- # error will be returned with message indicating the referenced resources. * If `
5540
- # force` is set to true, Dialogflow will remove the webhook, as well as any
5541
- # references to the webhook (i.e. Webhook and tagin fulfillments that point to
5542
- # this webhook will be removed).
5543
4654
  # @param [String] fields
5544
4655
  # Selector specifying which fields to include in a partial response.
5545
4656
  # @param [String] quota_user
@@ -5568,10 +4679,8 @@ module Google
5568
4679
  execute_or_queue_command(command, &block)
5569
4680
  end
5570
4681
 
5571
- # Retrieves the specified webhook.
4682
+ #
5572
4683
  # @param [String] name
5573
- # Required. The name of the webhook. Format: `projects//locations//agents//
5574
- # webhooks/`.
5575
4684
  # @param [String] fields
5576
4685
  # Selector specifying which fields to include in a partial response.
5577
4686
  # @param [String] quota_user
@@ -5599,15 +4708,10 @@ module Google
5599
4708
  execute_or_queue_command(command, &block)
5600
4709
  end
5601
4710
 
5602
- # Returns the list of all webhooks in the specified agent.
4711
+ #
5603
4712
  # @param [String] parent
5604
- # Required. The agent to list all webhooks for. Format: `projects//locations//
5605
- # agents/`.
5606
4713
  # @param [Fixnum] page_size
5607
- # The maximum number of items to return in a single page. By default 100 and at
5608
- # most 1000.
5609
4714
  # @param [String] page_token
5610
- # The next_page_token value returned from a previous list request.
5611
4715
  # @param [String] fields
5612
4716
  # Selector specifying which fields to include in a partial response.
5613
4717
  # @param [String] quota_user
@@ -5637,15 +4741,10 @@ module Google
5637
4741
  execute_or_queue_command(command, &block)
5638
4742
  end
5639
4743
 
5640
- # Updates the specified webhook.
4744
+ #
5641
4745
  # @param [String] name
5642
- # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook
5643
- # method. Webhooks.CreateWebhook populates the name automatically. Format: `
5644
- # projects//locations//agents//webhooks/`.
5645
4746
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook] google_cloud_dialogflow_cx_v3_webhook_object
5646
4747
  # @param [String] update_mask
5647
- # The mask to control which fields get updated. If the mask is not present, all
5648
- # fields will be updated.
5649
4748
  # @param [String] fields
5650
4749
  # Selector specifying which fields to include in a partial response.
5651
4750
  # @param [String] quota_user
@@ -5676,16 +4775,8 @@ module Google
5676
4775
  execute_or_queue_command(command, &block)
5677
4776
  end
5678
4777
 
5679
- # Starts asynchronous cancellation on a long-running operation. The server makes
5680
- # a best effort to cancel the operation, but success is not guaranteed. If the
5681
- # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
5682
- # Clients can use Operations.GetOperation or other methods to check whether the
5683
- # cancellation succeeded or whether the operation completed despite cancellation.
5684
- # On successful cancellation, the operation is not deleted; instead, it becomes
5685
- # an operation with an Operation.error value with a google.rpc.Status.code of `1`
5686
- # , corresponding to `Code.CANCELLED`.
4778
+ #
5687
4779
  # @param [String] name
5688
- # The name of the operation resource to be cancelled.
5689
4780
  # @param [String] fields
5690
4781
  # Selector specifying which fields to include in a partial response.
5691
4782
  # @param [String] quota_user
@@ -5713,10 +4804,8 @@ module Google
5713
4804
  execute_or_queue_command(command, &block)
5714
4805
  end
5715
4806
 
5716
- # Gets the latest state of a long-running operation. Clients can use this method
5717
- # to poll the operation result at intervals as recommended by the API service.
4807
+ #
5718
4808
  # @param [String] name
5719
- # The name of the operation resource.
5720
4809
  # @param [String] fields
5721
4810
  # Selector specifying which fields to include in a partial response.
5722
4811
  # @param [String] quota_user
@@ -5744,23 +4833,12 @@ module Google
5744
4833
  execute_or_queue_command(command, &block)
5745
4834
  end
5746
4835
 
5747
- # Lists operations that match the specified filter in the request. If the server
5748
- # doesn't support this method, it returns `UNIMPLEMENTED`.
4836
+ #
5749
4837
  # @param [String] name
5750
- # The name of the operation's parent resource.
5751
4838
  # @param [String] filter
5752
- # The standard list filter.
5753
4839
  # @param [Fixnum] page_size
5754
- # The standard list page size.
5755
4840
  # @param [String] page_token
5756
- # The standard list page token.
5757
4841
  # @param [Boolean] return_partial_success
5758
- # When set to `true`, operations that are reachable are returned as normal, and
5759
- # those that are unreachable are returned in the [ListOperationsResponse.
5760
- # unreachable] field. This can only be `true` when reading across collections e.
5761
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
5762
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
5763
- # explicitly documented otherwise in service or product specific documentation.
5764
4842
  # @param [String] fields
5765
4843
  # Selector specifying which fields to include in a partial response.
5766
4844
  # @param [String] quota_user
@@ -5792,10 +4870,8 @@ module Google
5792
4870
  execute_or_queue_command(command, &block)
5793
4871
  end
5794
4872
 
5795
- # Create security settings in the specified location.
4873
+ #
5796
4874
  # @param [String] parent
5797
- # Required. The location to create an SecuritySettings for. Format: `projects//
5798
- # locations/`.
5799
4875
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] google_cloud_dialogflow_cx_v3_security_settings_object
5800
4876
  # @param [String] fields
5801
4877
  # Selector specifying which fields to include in a partial response.
@@ -5826,10 +4902,8 @@ module Google
5826
4902
  execute_or_queue_command(command, &block)
5827
4903
  end
5828
4904
 
5829
- # Deletes the specified SecuritySettings.
4905
+ #
5830
4906
  # @param [String] name
5831
- # Required. The name of the SecuritySettings to delete. Format: `projects//
5832
- # locations//securitySettings/`.
5833
4907
  # @param [String] fields
5834
4908
  # Selector specifying which fields to include in a partial response.
5835
4909
  # @param [String] quota_user
@@ -5857,11 +4931,8 @@ module Google
5857
4931
  execute_or_queue_command(command, &block)
5858
4932
  end
5859
4933
 
5860
- # Retrieves the specified SecuritySettings. The returned settings may be stale
5861
- # by up to 1 minute.
4934
+ #
5862
4935
  # @param [String] name
5863
- # Required. Resource name of the settings. Format: `projects//locations//
5864
- # securitySettings/`.
5865
4936
  # @param [String] fields
5866
4937
  # Selector specifying which fields to include in a partial response.
5867
4938
  # @param [String] quota_user
@@ -5889,15 +4960,10 @@ module Google
5889
4960
  execute_or_queue_command(command, &block)
5890
4961
  end
5891
4962
 
5892
- # Returns the list of all security settings in the specified location.
4963
+ #
5893
4964
  # @param [String] parent
5894
- # Required. The location to list all security settings for. Format: `projects//
5895
- # locations/`.
5896
4965
  # @param [Fixnum] page_size
5897
- # The maximum number of items to return in a single page. By default 20 and at
5898
- # most 100.
5899
4966
  # @param [String] page_token
5900
- # The next_page_token value returned from a previous list request.
5901
4967
  # @param [String] fields
5902
4968
  # Selector specifying which fields to include in a partial response.
5903
4969
  # @param [String] quota_user
@@ -5927,16 +4993,10 @@ module Google
5927
4993
  execute_or_queue_command(command, &block)
5928
4994
  end
5929
4995
 
5930
- # Updates the specified SecuritySettings.
4996
+ #
5931
4997
  # @param [String] name
5932
- # Resource name of the settings. Required for the SecuritySettingsService.
5933
- # UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings
5934
- # populates the name automatically. Format: `projects//locations//
5935
- # securitySettings/`.
5936
4998
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] google_cloud_dialogflow_cx_v3_security_settings_object
5937
4999
  # @param [String] update_mask
5938
- # Required. The mask to control which fields get updated. If the mask is not
5939
- # present, all fields will be updated.
5940
5000
  # @param [String] fields
5941
5001
  # Selector specifying which fields to include in a partial response.
5942
5002
  # @param [String] quota_user
@@ -5967,16 +5027,8 @@ module Google
5967
5027
  execute_or_queue_command(command, &block)
5968
5028
  end
5969
5029
 
5970
- # Starts asynchronous cancellation on a long-running operation. The server makes
5971
- # a best effort to cancel the operation, but success is not guaranteed. If the
5972
- # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
5973
- # Clients can use Operations.GetOperation or other methods to check whether the
5974
- # cancellation succeeded or whether the operation completed despite cancellation.
5975
- # On successful cancellation, the operation is not deleted; instead, it becomes
5976
- # an operation with an Operation.error value with a google.rpc.Status.code of `1`
5977
- # , corresponding to `Code.CANCELLED`.
5030
+ #
5978
5031
  # @param [String] name
5979
- # The name of the operation resource to be cancelled.
5980
5032
  # @param [String] fields
5981
5033
  # Selector specifying which fields to include in a partial response.
5982
5034
  # @param [String] quota_user
@@ -6004,10 +5056,8 @@ module Google
6004
5056
  execute_or_queue_command(command, &block)
6005
5057
  end
6006
5058
 
6007
- # Gets the latest state of a long-running operation. Clients can use this method
6008
- # to poll the operation result at intervals as recommended by the API service.
5059
+ #
6009
5060
  # @param [String] name
6010
- # The name of the operation resource.
6011
5061
  # @param [String] fields
6012
5062
  # Selector specifying which fields to include in a partial response.
6013
5063
  # @param [String] quota_user
@@ -6035,23 +5085,12 @@ module Google
6035
5085
  execute_or_queue_command(command, &block)
6036
5086
  end
6037
5087
 
6038
- # Lists operations that match the specified filter in the request. If the server
6039
- # doesn't support this method, it returns `UNIMPLEMENTED`.
5088
+ #
6040
5089
  # @param [String] name
6041
- # The name of the operation's parent resource.
6042
5090
  # @param [String] filter
6043
- # The standard list filter.
6044
5091
  # @param [Fixnum] page_size
6045
- # The standard list page size.
6046
5092
  # @param [String] page_token
6047
- # The standard list page token.
6048
5093
  # @param [Boolean] return_partial_success
6049
- # When set to `true`, operations that are reachable are returned as normal, and
6050
- # those that are unreachable are returned in the [ListOperationsResponse.
6051
- # unreachable] field. This can only be `true` when reading across collections e.
6052
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
6053
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
6054
- # explicitly documented otherwise in service or product specific documentation.
6055
5094
  # @param [String] fields
6056
5095
  # Selector specifying which fields to include in a partial response.
6057
5096
  # @param [String] quota_user