google-apis-dialogflow_v3beta1 0.113.0 → 0.115.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 a
133
- # flow prior to sending it 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent] google_cloud_dialogflow_cx_v3beta1_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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportAgentRequest] google_cloud_dialogflow_cx_v3beta1_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 a flow prior to
373
- # sending it queries. See the [training documentation](https://cloud.google.com/
374
- # 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent] google_cloud_dialogflow_cx_v3beta1_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 a flow prior to sending it 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestoreAgentRequest] google_cloud_dialogflow_cx_v3beta1_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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings] google_cloud_dialogflow_cx_v3beta1_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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ValidateAgentRequest] google_cloud_dialogflow_cx_v3beta1_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,10 +531,8 @@ module Google
607
531
  execute_or_queue_command(command, &block)
608
532
  end
609
533
 
610
- # Deletes the specified conversation.
534
+ #
611
535
  # @param [String] name
612
- # Required. The name of the conversation. Format: `projects//locations//agents//
613
- # conversations/`.
614
536
  # @param [String] fields
615
537
  # Selector specifying which fields to include in a partial response.
616
538
  # @param [String] quota_user
@@ -638,10 +560,8 @@ module Google
638
560
  execute_or_queue_command(command, &block)
639
561
  end
640
562
 
641
- # Retrieves the specified conversation.
563
+ #
642
564
  # @param [String] name
643
- # Required. The name of the conversation. Format: `projects//locations//agents//
644
- # conversations/`.
645
565
  # @param [String] fields
646
566
  # Selector specifying which fields to include in a partial response.
647
567
  # @param [String] quota_user
@@ -669,23 +589,11 @@ module Google
669
589
  execute_or_queue_command(command, &block)
670
590
  end
671
591
 
672
- # Returns the list of all conversations.
592
+ #
673
593
  # @param [String] parent
674
- # Required. The agent to list all conversations for. Format: `projects//
675
- # locations//agents/`.
676
594
  # @param [String] filter
677
- # Optional. The filter string. Supports filter by create_time, metrics.
678
- # has_end_interaction, metrics.has_live_agent_handoff, intents.display_name,
679
- # pages.display_name and flows.display_name. Timestamps expect an RFC-3339
680
- # formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are supported.
681
- # Some examples: 1. By create time: create_time > "2022-04-21T11:30:00-04:00" 2.
682
- # By intent display name: intents.display_name : "billing" 3. By end interaction
683
- # signal: metrics.has_end_interaction = true
684
595
  # @param [Fixnum] page_size
685
- # Optional. The maximum number of items to return in a single page. By default
686
- # 100 and at most 1000.
687
596
  # @param [String] page_token
688
- # Optional. The next_page_token value returned from a previous list request.
689
597
  # @param [String] fields
690
598
  # Selector specifying which fields to include in a partial response.
691
599
  # @param [String] quota_user
@@ -716,17 +624,10 @@ module Google
716
624
  execute_or_queue_command(command, &block)
717
625
  end
718
626
 
719
- # Creates an entity type in the specified agent.
627
+ #
720
628
  # @param [String] parent
721
- # Required. The agent to create a entity type for. Format: `projects//locations//
722
- # agents/`.
723
629
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType] google_cloud_dialogflow_cx_v3beta1_entity_type_object
724
630
  # @param [String] language_code
725
- # The language of the following fields in `entity_type`: * `EntityType.entities.
726
- # value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value`
727
- # If not specified, the agent's default language is used. [Many languages](https:
728
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
729
- # languages must be enabled in the agent before they can be used.
730
631
  # @param [String] fields
731
632
  # Selector specifying which fields to include in a partial response.
732
633
  # @param [String] quota_user
@@ -757,19 +658,9 @@ module Google
757
658
  execute_or_queue_command(command, &block)
758
659
  end
759
660
 
760
- # Deletes the specified entity type. Note: You should always train a flow prior
761
- # to sending it queries. See the [training documentation](https://cloud.google.
762
- # com/dialogflow/cx/docs/concept/training).
661
+ #
763
662
  # @param [String] name
764
- # Required. The name of the entity type to delete. Format: `projects//locations//
765
- # agents//entityTypes/`.
766
663
  # @param [Boolean] force
767
- # This field has no effect for entity type not being used. For entity types that
768
- # are used by intents or pages: * If `force` is set to false, an error will be
769
- # returned with message indicating the referencing resources. * If `force` is
770
- # set to true, Dialogflow will remove the entity type, as well as any references
771
- # to the entity type (i.e. Page parameter of the entity type will be changed to '
772
- # @sys.any' and intent parameter of the entity type will be removed).
773
664
  # @param [String] fields
774
665
  # Selector specifying which fields to include in a partial response.
775
666
  # @param [String] quota_user
@@ -798,10 +689,8 @@ module Google
798
689
  execute_or_queue_command(command, &block)
799
690
  end
800
691
 
801
- # Exports the selected entity types.
692
+ #
802
693
  # @param [String] parent
803
- # Required. The name of the parent agent to export entity types. Format: `
804
- # projects//locations//agents/`.
805
694
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportEntityTypesRequest] google_cloud_dialogflow_cx_v3beta1_export_entity_types_request_object
806
695
  # @param [String] fields
807
696
  # Selector specifying which fields to include in a partial response.
@@ -832,17 +721,9 @@ module Google
832
721
  execute_or_queue_command(command, &block)
833
722
  end
834
723
 
835
- # Retrieves the specified entity type.
724
+ #
836
725
  # @param [String] name
837
- # Required. The name of the entity type. Format: `projects//locations//agents//
838
- # entityTypes/`.
839
726
  # @param [String] language_code
840
- # The language to retrieve the entity type for. The following fields are
841
- # language dependent: * `EntityType.entities.value` * `EntityType.entities.
842
- # synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's
843
- # default language is used. [Many languages](https://cloud.google.com/dialogflow/
844
- # cx/docs/reference/language) are supported. Note: languages must be enabled in
845
- # the agent before they can be used.
846
727
  # @param [String] fields
847
728
  # Selector specifying which fields to include in a partial response.
848
729
  # @param [String] quota_user
@@ -871,10 +752,8 @@ module Google
871
752
  execute_or_queue_command(command, &block)
872
753
  end
873
754
 
874
- # Imports the specified entitytypes into the agent.
755
+ #
875
756
  # @param [String] parent
876
- # Required. The agent to import the entity types into. Format: `projects//
877
- # locations//agents/`.
878
757
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportEntityTypesRequest] google_cloud_dialogflow_cx_v3beta1_import_entity_types_request_object
879
758
  # @param [String] fields
880
759
  # Selector specifying which fields to include in a partial response.
@@ -905,22 +784,11 @@ module Google
905
784
  execute_or_queue_command(command, &block)
906
785
  end
907
786
 
908
- # Returns the list of all entity types in the specified agent.
787
+ #
909
788
  # @param [String] parent
910
- # Required. The agent to list all entity types for. Format: `projects//locations/
911
- # /agents/`.
912
789
  # @param [String] language_code
913
- # The language to list entity types for. The following fields are language
914
- # dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `
915
- # EntityType.excluded_phrases.value` If not specified, the agent's default
916
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
917
- # reference/language) are supported. Note: languages must be enabled in the
918
- # agent before they can be used.
919
790
  # @param [Fixnum] page_size
920
- # The maximum number of items to return in a single page. By default 100 and at
921
- # most 1000.
922
791
  # @param [String] page_token
923
- # The next_page_token value returned from a previous list request.
924
792
  # @param [String] fields
925
793
  # Selector specifying which fields to include in a partial response.
926
794
  # @param [String] quota_user
@@ -951,21 +819,11 @@ module Google
951
819
  execute_or_queue_command(command, &block)
952
820
  end
953
821
 
954
- # Updates the specified entity type. Note: You should always train a flow prior
955
- # to sending it queries. See the [training documentation](https://cloud.google.
956
- # com/dialogflow/cx/docs/concept/training).
822
+ #
957
823
  # @param [String] name
958
- # The unique identifier of the entity type. Required for EntityTypes.
959
- # UpdateEntityType. Format: `projects//locations//agents//entityTypes/`.
960
824
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType] google_cloud_dialogflow_cx_v3beta1_entity_type_object
961
825
  # @param [String] language_code
962
- # The language of the following fields in `entity_type`: * `EntityType.entities.
963
- # value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value`
964
- # If not specified, the agent's default language is used. [Many languages](https:
965
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
966
- # languages must be enabled in the agent before they can be used.
967
826
  # @param [String] update_mask
968
- # The mask to control which fields get updated.
969
827
  # @param [String] fields
970
828
  # Selector specifying which fields to include in a partial response.
971
829
  # @param [String] quota_user
@@ -997,15 +855,8 @@ module Google
997
855
  execute_or_queue_command(command, &block)
998
856
  end
999
857
 
1000
- # Creates an Environment in the specified Agent. This method is a [long-running
1001
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
1002
- # operation). The returned `Operation` type has the following method-specific
1003
- # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
1004
- # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
1005
- # Environment
858
+ #
1006
859
  # @param [String] parent
1007
- # Required. The Agent to create an Environment for. Format: `projects//locations/
1008
- # /agents/`.
1009
860
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment] google_cloud_dialogflow_cx_v3beta1_environment_object
1010
861
  # @param [String] fields
1011
862
  # Selector specifying which fields to include in a partial response.
@@ -1036,10 +887,8 @@ module Google
1036
887
  execute_or_queue_command(command, &block)
1037
888
  end
1038
889
 
1039
- # Deletes the specified Environment.
890
+ #
1040
891
  # @param [String] name
1041
- # Required. The name of the Environment to delete. Format: `projects//locations//
1042
- # agents//environments/`.
1043
892
  # @param [String] fields
1044
893
  # Selector specifying which fields to include in a partial response.
1045
894
  # @param [String] quota_user
@@ -1067,13 +916,8 @@ module Google
1067
916
  execute_or_queue_command(command, &block)
1068
917
  end
1069
918
 
1070
- # Deploys a flow to the specified Environment. This method is a [long-running
1071
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
1072
- # operation). The returned `Operation` type has the following method-specific
1073
- # fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse
919
+ #
1074
920
  # @param [String] environment
1075
- # Required. The environment to deploy the flow to. Format: `projects//locations//
1076
- # agents//environments/`.
1077
921
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DeployFlowRequest] google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object
1078
922
  # @param [String] fields
1079
923
  # Selector specifying which fields to include in a partial response.
@@ -1104,10 +948,8 @@ module Google
1104
948
  execute_or_queue_command(command, &block)
1105
949
  end
1106
950
 
1107
- # Retrieves the specified Environment.
951
+ #
1108
952
  # @param [String] name
1109
- # Required. The name of the Environment. Format: `projects//locations//agents//
1110
- # environments/`.
1111
953
  # @param [String] fields
1112
954
  # Selector specifying which fields to include in a partial response.
1113
955
  # @param [String] quota_user
@@ -1135,15 +977,10 @@ module Google
1135
977
  execute_or_queue_command(command, &block)
1136
978
  end
1137
979
 
1138
- # Returns the list of all environments in the specified Agent.
980
+ #
1139
981
  # @param [String] parent
1140
- # Required. The Agent to list all environments for. Format: `projects//locations/
1141
- # /agents/`.
1142
982
  # @param [Fixnum] page_size
1143
- # The maximum number of items to return in a single page. By default 20 and at
1144
- # most 100.
1145
983
  # @param [String] page_token
1146
- # The next_page_token value returned from a previous list request.
1147
984
  # @param [String] fields
1148
985
  # Selector specifying which fields to include in a partial response.
1149
986
  # @param [String] quota_user
@@ -1173,15 +1010,10 @@ module Google
1173
1010
  execute_or_queue_command(command, &block)
1174
1011
  end
1175
1012
 
1176
- # Looks up the history of the specified Environment.
1013
+ #
1177
1014
  # @param [String] name
1178
- # Required. Resource name of the environment to look up the history for. Format:
1179
- # `projects//locations//agents//environments/`.
1180
1015
  # @param [Fixnum] page_size
1181
- # The maximum number of items to return in a single page. By default 100 and at
1182
- # most 1000.
1183
1016
  # @param [String] page_token
1184
- # The next_page_token value returned from a previous list request.
1185
1017
  # @param [String] fields
1186
1018
  # Selector specifying which fields to include in a partial response.
1187
1019
  # @param [String] quota_user
@@ -1211,17 +1043,10 @@ module Google
1211
1043
  execute_or_queue_command(command, &block)
1212
1044
  end
1213
1045
 
1214
- # Updates the specified Environment. This method is a [long-running operation](
1215
- # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
1216
- # returned `Operation` type has the following method-specific fields: - `
1217
- # metadata`: An empty [Struct message](https://developers.google.com/protocol-
1218
- # buffers/docs/reference/google.protobuf#struct) - `response`: Environment
1046
+ #
1219
1047
  # @param [String] name
1220
- # The name of the environment. Format: `projects//locations//agents//
1221
- # environments/`.
1222
1048
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment] google_cloud_dialogflow_cx_v3beta1_environment_object
1223
1049
  # @param [String] update_mask
1224
- # Required. The mask to control which fields get updated.
1225
1050
  # @param [String] fields
1226
1051
  # Selector specifying which fields to include in a partial response.
1227
1052
  # @param [String] quota_user
@@ -1252,13 +1077,8 @@ module Google
1252
1077
  execute_or_queue_command(command, &block)
1253
1078
  end
1254
1079
 
1255
- # Kicks off a continuous test under the specified Environment. This method is a [
1256
- # long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
1257
- # running-operation). The returned `Operation` type has the following method-
1258
- # specific fields: - `metadata`: RunContinuousTestMetadata - `response`:
1259
- # RunContinuousTestResponse
1080
+ #
1260
1081
  # @param [String] environment
1261
- # Required. Format: `projects//locations//agents//environments/`.
1262
1082
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RunContinuousTestRequest] google_cloud_dialogflow_cx_v3beta1_run_continuous_test_request_object
1263
1083
  # @param [String] fields
1264
1084
  # Selector specifying which fields to include in a partial response.
@@ -1289,15 +1109,10 @@ module Google
1289
1109
  execute_or_queue_command(command, &block)
1290
1110
  end
1291
1111
 
1292
- # Fetches a list of continuous test results for a given environment.
1112
+ #
1293
1113
  # @param [String] parent
1294
- # Required. The environment to list results for. Format: `projects//locations//
1295
- # agents//environments/`.
1296
1114
  # @param [Fixnum] page_size
1297
- # The maximum number of items to return in a single page. By default 100 and at
1298
- # most 1000.
1299
1115
  # @param [String] page_token
1300
- # The next_page_token value returned from a previous list request.
1301
1116
  # @param [String] fields
1302
1117
  # Selector specifying which fields to include in a partial response.
1303
1118
  # @param [String] quota_user
@@ -1327,10 +1142,8 @@ module Google
1327
1142
  execute_or_queue_command(command, &block)
1328
1143
  end
1329
1144
 
1330
- # Retrieves the specified Deployment.
1145
+ #
1331
1146
  # @param [String] name
1332
- # Required. The name of the Deployment. Format: `projects//locations//agents//
1333
- # environments//deployments/`.
1334
1147
  # @param [String] fields
1335
1148
  # Selector specifying which fields to include in a partial response.
1336
1149
  # @param [String] quota_user
@@ -1358,15 +1171,10 @@ module Google
1358
1171
  execute_or_queue_command(command, &block)
1359
1172
  end
1360
1173
 
1361
- # Returns the list of all deployments in the specified Environment.
1174
+ #
1362
1175
  # @param [String] parent
1363
- # Required. The Environment to list all environments for. Format: `projects//
1364
- # locations//agents//environments/`.
1365
1176
  # @param [Fixnum] page_size
1366
- # The maximum number of items to return in a single page. By default 20 and at
1367
- # most 100.
1368
1177
  # @param [String] page_token
1369
- # The next_page_token value returned from a previous list request.
1370
1178
  # @param [String] fields
1371
1179
  # Selector specifying which fields to include in a partial response.
1372
1180
  # @param [String] quota_user
@@ -1396,10 +1204,8 @@ module Google
1396
1204
  execute_or_queue_command(command, &block)
1397
1205
  end
1398
1206
 
1399
- # Creates an Experiment in the specified Environment.
1207
+ #
1400
1208
  # @param [String] parent
1401
- # Required. The Agent to create an Environment for. Format: `projects//locations/
1402
- # /agents//environments/`.
1403
1209
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment] google_cloud_dialogflow_cx_v3beta1_experiment_object
1404
1210
  # @param [String] fields
1405
1211
  # Selector specifying which fields to include in a partial response.
@@ -1430,10 +1236,8 @@ module Google
1430
1236
  execute_or_queue_command(command, &block)
1431
1237
  end
1432
1238
 
1433
- # Deletes the specified Experiment.
1239
+ #
1434
1240
  # @param [String] name
1435
- # Required. The name of the Environment to delete. Format: `projects//locations//
1436
- # agents//environments//experiments/`.
1437
1241
  # @param [String] fields
1438
1242
  # Selector specifying which fields to include in a partial response.
1439
1243
  # @param [String] quota_user
@@ -1461,10 +1265,8 @@ module Google
1461
1265
  execute_or_queue_command(command, &block)
1462
1266
  end
1463
1267
 
1464
- # Retrieves the specified Experiment.
1268
+ #
1465
1269
  # @param [String] name
1466
- # Required. The name of the Environment. Format: `projects//locations//agents//
1467
- # environments//experiments/`.
1468
1270
  # @param [String] fields
1469
1271
  # Selector specifying which fields to include in a partial response.
1470
1272
  # @param [String] quota_user
@@ -1492,15 +1294,10 @@ module Google
1492
1294
  execute_or_queue_command(command, &block)
1493
1295
  end
1494
1296
 
1495
- # Returns the list of all experiments in the specified Environment.
1297
+ #
1496
1298
  # @param [String] parent
1497
- # Required. The Environment to list all environments for. Format: `projects//
1498
- # locations//agents//environments/`.
1499
1299
  # @param [Fixnum] page_size
1500
- # The maximum number of items to return in a single page. By default 20 and at
1501
- # most 100.
1502
1300
  # @param [String] page_token
1503
- # The next_page_token value returned from a previous list request.
1504
1301
  # @param [String] fields
1505
1302
  # Selector specifying which fields to include in a partial response.
1506
1303
  # @param [String] quota_user
@@ -1530,13 +1327,10 @@ module Google
1530
1327
  execute_or_queue_command(command, &block)
1531
1328
  end
1532
1329
 
1533
- # Updates the specified Experiment.
1330
+ #
1534
1331
  # @param [String] name
1535
- # The name of the experiment. Format: projects//locations//agents//environments//
1536
- # experiments/.
1537
1332
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment] google_cloud_dialogflow_cx_v3beta1_experiment_object
1538
1333
  # @param [String] update_mask
1539
- # Required. The mask to control which fields get updated.
1540
1334
  # @param [String] fields
1541
1335
  # Selector specifying which fields to include in a partial response.
1542
1336
  # @param [String] quota_user
@@ -1567,11 +1361,8 @@ module Google
1567
1361
  execute_or_queue_command(command, &block)
1568
1362
  end
1569
1363
 
1570
- # Starts the specified Experiment. This rpc only changes the state of experiment
1571
- # from PENDING to RUNNING.
1364
+ #
1572
1365
  # @param [String] name
1573
- # Required. Resource name of the experiment to start. Format: `projects//
1574
- # locations//agents//environments//experiments/`.
1575
1366
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1StartExperimentRequest] google_cloud_dialogflow_cx_v3beta1_start_experiment_request_object
1576
1367
  # @param [String] fields
1577
1368
  # Selector specifying which fields to include in a partial response.
@@ -1602,11 +1393,8 @@ module Google
1602
1393
  execute_or_queue_command(command, &block)
1603
1394
  end
1604
1395
 
1605
- # Stops the specified Experiment. This rpc only changes the state of experiment
1606
- # from RUNNING to DONE.
1396
+ #
1607
1397
  # @param [String] name
1608
- # Required. Resource name of the experiment to stop. Format: `projects//
1609
- # locations//agents//environments//experiments/`.
1610
1398
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1StopExperimentRequest] google_cloud_dialogflow_cx_v3beta1_stop_experiment_request_object
1611
1399
  # @param [String] fields
1612
1400
  # Selector specifying which fields to include in a partial response.
@@ -1637,22 +1425,8 @@ module Google
1637
1425
  execute_or_queue_command(command, &block)
1638
1426
  end
1639
1427
 
1640
- # Processes a natural language query and returns structured, actionable data as
1641
- # a result. This method is not idempotent, because it may cause session entity
1642
- # types to be updated, which in turn might affect results of future queries.
1643
- # Note: Always use agent versions for production traffic. See [Versions and
1644
- # environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
1428
+ #
1645
1429
  # @param [String] session
1646
- # Required. The name of the session this query is sent to. Format: `projects//
1647
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1648
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1649
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
1650
- # It can be a random number or some type of session identifiers (preferably
1651
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
1652
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
1653
- # cx/docs/concept/session). Note: Always use agent versions for production
1654
- # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
1655
- # cx/docs/concept/version).
1656
1430
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest] google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object
1657
1431
  # @param [String] fields
1658
1432
  # Selector specifying which fields to include in a partial response.
@@ -1683,18 +1457,8 @@ module Google
1683
1457
  execute_or_queue_command(command, &block)
1684
1458
  end
1685
1459
 
1686
- # Fulfills a matched intent returned by MatchIntent. Must be called after
1687
- # MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is
1688
- # undefined.
1460
+ #
1689
1461
  # @param [String] session
1690
- # Required. The name of the session this query is sent to. Format: `projects//
1691
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1692
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1693
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
1694
- # It can be a random number or some type of session identifiers (preferably
1695
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
1696
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
1697
- # cx/docs/concept/session).
1698
1462
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentRequest] google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object
1699
1463
  # @param [String] fields
1700
1464
  # Selector specifying which fields to include in a partial response.
@@ -1725,16 +1489,8 @@ module Google
1725
1489
  execute_or_queue_command(command, &block)
1726
1490
  end
1727
1491
 
1728
- # Returns preliminary intent match results, doesn't change the session status.
1492
+ #
1729
1493
  # @param [String] session
1730
- # Required. The name of the session this query is sent to. Format: `projects//
1731
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1732
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1733
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
1734
- # It can be a random number or some type of session identifiers (preferably
1735
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
1736
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
1737
- # cx/docs/concept/session).
1738
1494
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentRequest] google_cloud_dialogflow_cx_v3beta1_match_intent_request_object
1739
1495
  # @param [String] fields
1740
1496
  # Selector specifying which fields to include in a partial response.
@@ -1765,21 +1521,8 @@ module Google
1765
1521
  execute_or_queue_command(command, &block)
1766
1522
  end
1767
1523
 
1768
- # Processes a natural language query and returns structured, actionable data as
1769
- # a result through server-side streaming. Server-side streaming allows
1770
- # Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/
1771
- # docs/concept/fulfillment#partial-response) earlier in a single request.
1524
+ #
1772
1525
  # @param [String] session
1773
- # Required. The name of the session this query is sent to. Format: `projects//
1774
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1775
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1776
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
1777
- # It can be a random number or some type of session identifiers (preferably
1778
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
1779
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
1780
- # cx/docs/concept/session). Note: Always use agent versions for production
1781
- # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
1782
- # cx/docs/concept/version).
1783
1526
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest] google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object
1784
1527
  # @param [String] fields
1785
1528
  # Selector specifying which fields to include in a partial response.
@@ -1810,12 +1553,8 @@ module Google
1810
1553
  execute_or_queue_command(command, &block)
1811
1554
  end
1812
1555
 
1813
- # Creates a session entity type.
1556
+ #
1814
1557
  # @param [String] parent
1815
- # Required. The session to create a session entity type for. Format: `projects//
1816
- # locations//agents//sessions/` or `projects//locations//agents//environments//
1817
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1818
- # environment.
1819
1558
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType] google_cloud_dialogflow_cx_v3beta1_session_entity_type_object
1820
1559
  # @param [String] fields
1821
1560
  # Selector specifying which fields to include in a partial response.
@@ -1846,12 +1585,8 @@ module Google
1846
1585
  execute_or_queue_command(command, &block)
1847
1586
  end
1848
1587
 
1849
- # Deletes the specified session entity type.
1588
+ #
1850
1589
  # @param [String] name
1851
- # Required. The name of the session entity type to delete. Format: `projects//
1852
- # locations//agents//sessions//entityTypes/` or `projects//locations//agents//
1853
- # environments//sessions//entityTypes/`. If `Environment ID` is not specified,
1854
- # we assume default 'draft' environment.
1855
1590
  # @param [String] fields
1856
1591
  # Selector specifying which fields to include in a partial response.
1857
1592
  # @param [String] quota_user
@@ -1879,12 +1614,8 @@ module Google
1879
1614
  execute_or_queue_command(command, &block)
1880
1615
  end
1881
1616
 
1882
- # Retrieves the specified session entity type.
1617
+ #
1883
1618
  # @param [String] name
1884
- # Required. The name of the session entity type. Format: `projects//locations//
1885
- # agents//sessions//entityTypes/` or `projects//locations//agents//environments//
1886
- # sessions//entityTypes/`. If `Environment ID` is not specified, we assume
1887
- # default 'draft' environment.
1888
1619
  # @param [String] fields
1889
1620
  # Selector specifying which fields to include in a partial response.
1890
1621
  # @param [String] quota_user
@@ -1912,17 +1643,10 @@ module Google
1912
1643
  execute_or_queue_command(command, &block)
1913
1644
  end
1914
1645
 
1915
- # Returns the list of all session entity types in the specified session.
1646
+ #
1916
1647
  # @param [String] parent
1917
- # Required. The session to list all session entity types from. Format: `projects/
1918
- # /locations//agents//sessions/` or `projects//locations//agents//environments//
1919
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
1920
- # environment.
1921
1648
  # @param [Fixnum] page_size
1922
- # The maximum number of items to return in a single page. By default 100 and at
1923
- # most 1000.
1924
1649
  # @param [String] page_token
1925
- # The next_page_token value returned from a previous list request.
1926
1650
  # @param [String] fields
1927
1651
  # Selector specifying which fields to include in a partial response.
1928
1652
  # @param [String] quota_user
@@ -1952,15 +1676,10 @@ module Google
1952
1676
  execute_or_queue_command(command, &block)
1953
1677
  end
1954
1678
 
1955
- # Updates the specified session entity type.
1679
+ #
1956
1680
  # @param [String] name
1957
- # Required. The unique identifier of the session entity type. Format: `projects//
1958
- # locations//agents//sessions//entityTypes/` or `projects//locations//agents//
1959
- # environments//sessions//entityTypes/`. If `Environment ID` is not specified,
1960
- # we assume default 'draft' environment.
1961
1681
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType] google_cloud_dialogflow_cx_v3beta1_session_entity_type_object
1962
1682
  # @param [String] update_mask
1963
- # The mask to control which fields get updated.
1964
1683
  # @param [String] fields
1965
1684
  # Selector specifying which fields to include in a partial response.
1966
1685
  # @param [String] quota_user
@@ -1991,21 +1710,10 @@ module Google
1991
1710
  execute_or_queue_command(command, &block)
1992
1711
  end
1993
1712
 
1994
- # Creates a flow in the specified agent. Note: You should always train a flow
1995
- # prior to sending it queries. See the [training documentation](https://cloud.
1996
- # google.com/dialogflow/cx/docs/concept/training).
1713
+ #
1997
1714
  # @param [String] parent
1998
- # Required. The agent to create a flow for. Format: `projects//locations//agents/
1999
- # `.
2000
1715
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow] google_cloud_dialogflow_cx_v3beta1_flow_object
2001
1716
  # @param [String] language_code
2002
- # The language of the following fields in `flow`: * `Flow.event_handlers.
2003
- # trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.
2004
- # conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `
2005
- # Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified,
2006
- # the agent's default language is used. [Many languages](https://cloud.google.
2007
- # com/dialogflow/cx/docs/reference/language) are supported. Note: languages must
2008
- # be enabled in the agent before they can be used.
2009
1717
  # @param [String] fields
2010
1718
  # Selector specifying which fields to include in a partial response.
2011
1719
  # @param [String] quota_user
@@ -2036,17 +1744,9 @@ module Google
2036
1744
  execute_or_queue_command(command, &block)
2037
1745
  end
2038
1746
 
2039
- # Deletes a specified flow.
1747
+ #
2040
1748
  # @param [String] name
2041
- # Required. The name of the flow to delete. Format: `projects//locations//agents/
2042
- # /flows/`.
2043
1749
  # @param [Boolean] force
2044
- # This field has no effect for flows with no incoming transitions. For flows
2045
- # with incoming transitions: * If `force` is set to false, an error will be
2046
- # returned with message indicating the incoming transitions. * If `force` is set
2047
- # to true, Dialogflow will remove the flow, as well as any transitions to the
2048
- # flow (i.e. Target flow in event handlers or Target flow in transition routes
2049
- # that point to this flow will be cleared).
2050
1750
  # @param [String] fields
2051
1751
  # Selector specifying which fields to include in a partial response.
2052
1752
  # @param [String] quota_user
@@ -2075,16 +1775,8 @@ module Google
2075
1775
  execute_or_queue_command(command, &block)
2076
1776
  end
2077
1777
 
2078
- # Exports the specified flow to a binary file. This method is a [long-running
2079
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
2080
- # operation). The returned `Operation` type has the following method-specific
2081
- # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
2082
- # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
2083
- # ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that
2084
- # the flow references will also be exported.
1778
+ #
2085
1779
  # @param [String] name
2086
- # Required. The name of the flow to export. Format: `projects//locations//agents/
2087
- # /flows/`.
2088
1780
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportFlowRequest] google_cloud_dialogflow_cx_v3beta1_export_flow_request_object
2089
1781
  # @param [String] fields
2090
1782
  # Selector specifying which fields to include in a partial response.
@@ -2115,19 +1807,9 @@ module Google
2115
1807
  execute_or_queue_command(command, &block)
2116
1808
  end
2117
1809
 
2118
- # Retrieves the specified flow.
1810
+ #
2119
1811
  # @param [String] name
2120
- # Required. The name of the flow to get. Format: `projects//locations//agents//
2121
- # flows/`.
2122
1812
  # @param [String] language_code
2123
- # The language to retrieve the flow for. The following fields are language
2124
- # dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.
2125
- # event_handlers.trigger_fulfillment.conditional_cases` * `Flow.
2126
- # transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.
2127
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2128
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2129
- # reference/language) are supported. Note: languages must be enabled in the
2130
- # agent before they can be used.
2131
1813
  # @param [String] fields
2132
1814
  # Selector specifying which fields to include in a partial response.
2133
1815
  # @param [String] quota_user
@@ -2156,13 +1838,9 @@ module Google
2156
1838
  execute_or_queue_command(command, &block)
2157
1839
  end
2158
1840
 
2159
- # Gets the latest flow validation result. Flow validation is performed when
2160
- # ValidateFlow is called.
1841
+ #
2161
1842
  # @param [String] name
2162
- # Required. The flow name. Format: `projects//locations//agents//flows//
2163
- # validationResult`.
2164
1843
  # @param [String] language_code
2165
- # If not specified, the agent's default language is used.
2166
1844
  # @param [String] fields
2167
1845
  # Selector specifying which fields to include in a partial response.
2168
1846
  # @param [String] quota_user
@@ -2191,17 +1869,8 @@ module Google
2191
1869
  execute_or_queue_command(command, &block)
2192
1870
  end
2193
1871
 
2194
- # Imports the specified flow to the specified agent from a binary file. This
2195
- # method is a [long-running operation](https://cloud.google.com/dialogflow/cx/
2196
- # docs/how/long-running-operation). The returned `Operation` type has the
2197
- # following method-specific fields: - `metadata`: An empty [Struct message](
2198
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
2199
- # struct) - `response`: ImportFlowResponse Note: You should always train a flow
2200
- # prior to sending it queries. See the [training documentation](https://cloud.
2201
- # google.com/dialogflow/cx/docs/concept/training).
1872
+ #
2202
1873
  # @param [String] parent
2203
- # Required. The agent to import the flow into. Format: `projects//locations//
2204
- # agents/`.
2205
1874
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportFlowRequest] google_cloud_dialogflow_cx_v3beta1_import_flow_request_object
2206
1875
  # @param [String] fields
2207
1876
  # Selector specifying which fields to include in a partial response.
@@ -2232,24 +1901,11 @@ module Google
2232
1901
  execute_or_queue_command(command, &block)
2233
1902
  end
2234
1903
 
2235
- # Returns the list of all flows in the specified agent.
1904
+ #
2236
1905
  # @param [String] parent
2237
- # Required. The agent containing the flows. Format: `projects//locations//agents/
2238
- # `.
2239
1906
  # @param [String] language_code
2240
- # The language to list flows for. The following fields are language dependent: *
2241
- # `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.
2242
- # trigger_fulfillment.conditional_cases` * `Flow.transition_routes.
2243
- # trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.
2244
- # conditional_cases` If not specified, the agent's default language is used. [
2245
- # Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
2246
- # are supported. Note: languages must be enabled in the agent before they can
2247
- # be used.
2248
1907
  # @param [Fixnum] page_size
2249
- # The maximum number of items to return in a single page. By default 100 and at
2250
- # most 1000.
2251
1908
  # @param [String] page_token
2252
- # The next_page_token value returned from a previous list request.
2253
1909
  # @param [String] fields
2254
1910
  # Selector specifying which fields to include in a partial response.
2255
1911
  # @param [String] quota_user
@@ -2280,24 +1936,11 @@ module Google
2280
1936
  execute_or_queue_command(command, &block)
2281
1937
  end
2282
1938
 
2283
- # Updates the specified flow. Note: You should always train a flow prior to
2284
- # sending it queries. See the [training documentation](https://cloud.google.com/
2285
- # dialogflow/cx/docs/concept/training).
1939
+ #
2286
1940
  # @param [String] name
2287
- # The unique identifier of the flow. Format: `projects//locations//agents//flows/
2288
- # `.
2289
1941
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow] google_cloud_dialogflow_cx_v3beta1_flow_object
2290
1942
  # @param [String] language_code
2291
- # The language of the following fields in `flow`: * `Flow.event_handlers.
2292
- # trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.
2293
- # conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `
2294
- # Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified,
2295
- # the agent's default language is used. [Many languages](https://cloud.google.
2296
- # com/dialogflow/cx/docs/reference/language) are supported. Note: languages must
2297
- # be enabled in the agent before they can be used.
2298
1943
  # @param [String] update_mask
2299
- # The mask to control which fields get updated. If the mask is not present, all
2300
- # fields will be updated.
2301
1944
  # @param [String] fields
2302
1945
  # Selector specifying which fields to include in a partial response.
2303
1946
  # @param [String] quota_user
@@ -2329,17 +1972,8 @@ module Google
2329
1972
  execute_or_queue_command(command, &block)
2330
1973
  end
2331
1974
 
2332
- # Trains the specified flow. Note that only the flow in 'draft' environment is
2333
- # trained. This method is a [long-running operation](https://cloud.google.com/
2334
- # dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type
2335
- # has the following method-specific fields: - `metadata`: An empty [Struct
2336
- # message](https://developers.google.com/protocol-buffers/docs/reference/google.
2337
- # protobuf#struct) - `response`: An [Empty message](https://developers.google.
2338
- # com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should
2339
- # always train a flow prior to sending it queries. See the [training
2340
- # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
1975
+ #
2341
1976
  # @param [String] name
2342
- # Required. The flow to train. Format: `projects//locations//agents//flows/`.
2343
1977
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TrainFlowRequest] google_cloud_dialogflow_cx_v3beta1_train_flow_request_object
2344
1978
  # @param [String] fields
2345
1979
  # Selector specifying which fields to include in a partial response.
@@ -2370,11 +2004,8 @@ module Google
2370
2004
  execute_or_queue_command(command, &block)
2371
2005
  end
2372
2006
 
2373
- # Validates the specified flow and creates or updates validation results. Please
2374
- # call this API after the training is completed to get the complete validation
2375
- # results.
2007
+ #
2376
2008
  # @param [String] name
2377
- # Required. The flow to validate. Format: `projects//locations//agents//flows/`.
2378
2009
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ValidateFlowRequest] google_cloud_dialogflow_cx_v3beta1_validate_flow_request_object
2379
2010
  # @param [String] fields
2380
2011
  # Selector specifying which fields to include in a partial response.
@@ -2405,25 +2036,10 @@ module Google
2405
2036
  execute_or_queue_command(command, &block)
2406
2037
  end
2407
2038
 
2408
- # Creates a page in the specified flow.
2039
+ #
2409
2040
  # @param [String] parent
2410
- # Required. The flow to create a page for. Format: `projects//locations//agents//
2411
- # flows/`.
2412
2041
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page] google_cloud_dialogflow_cx_v3beta1_page_object
2413
2042
  # @param [String] language_code
2414
- # The language of the following fields in `page`: * `Page.entry_fulfillment.
2415
- # messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.
2416
- # trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.
2417
- # conditional_cases` * `Page.form.parameters.fill_behavior.
2418
- # initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.
2419
- # initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.
2420
- # fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.
2421
- # fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.
2422
- # transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.
2423
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2424
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2425
- # reference/language) are supported. Note: languages must be enabled in the
2426
- # agent before they can be used.
2427
2043
  # @param [String] fields
2428
2044
  # Selector specifying which fields to include in a partial response.
2429
2045
  # @param [String] quota_user
@@ -2454,17 +2070,9 @@ module Google
2454
2070
  execute_or_queue_command(command, &block)
2455
2071
  end
2456
2072
 
2457
- # Deletes the specified page.
2073
+ #
2458
2074
  # @param [String] name
2459
- # Required. The name of the page to delete. Format: `projects//locations//agents/
2460
- # /Flows//pages/`.
2461
2075
  # @param [Boolean] force
2462
- # This field has no effect for pages with no incoming transitions. For pages
2463
- # with incoming transitions: * If `force` is set to false, an error will be
2464
- # returned with message indicating the incoming transitions. * If `force` is set
2465
- # to true, Dialogflow will remove the page, as well as any transitions to the
2466
- # page (i.e. Target page in event handlers or Target page in transition routes
2467
- # that point to this page will be cleared).
2468
2076
  # @param [String] fields
2469
2077
  # Selector specifying which fields to include in a partial response.
2470
2078
  # @param [String] quota_user
@@ -2493,24 +2101,9 @@ module Google
2493
2101
  execute_or_queue_command(command, &block)
2494
2102
  end
2495
2103
 
2496
- # Retrieves the specified page.
2104
+ #
2497
2105
  # @param [String] name
2498
- # Required. The name of the page. Format: `projects//locations//agents//flows//
2499
- # pages/`.
2500
2106
  # @param [String] language_code
2501
- # The language to retrieve the page for. The following fields are language
2502
- # dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.
2503
- # conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `
2504
- # Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.
2505
- # parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.
2506
- # parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.
2507
- # form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.
2508
- # parameters.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
2107
  # @param [String] fields
2515
2108
  # Selector specifying which fields to include in a partial response.
2516
2109
  # @param [String] quota_user
@@ -2539,29 +2132,11 @@ module Google
2539
2132
  execute_or_queue_command(command, &block)
2540
2133
  end
2541
2134
 
2542
- # Returns the list of all pages in the specified flow.
2135
+ #
2543
2136
  # @param [String] parent
2544
- # Required. The flow to list all pages for. Format: `projects//locations//agents/
2545
- # /flows/`.
2546
2137
  # @param [String] language_code
2547
- # The language to list pages for. The following fields are language dependent: *
2548
- # `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases`
2549
- # * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.
2550
- # trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.
2551
- # initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.
2552
- # initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.
2553
- # fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.
2554
- # fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.
2555
- # transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.
2556
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2557
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2558
- # reference/language) are supported. Note: languages must be enabled in the
2559
- # agent before they can be used.
2560
2138
  # @param [Fixnum] page_size
2561
- # The maximum number of items to return in a single page. By default 100 and at
2562
- # most 1000.
2563
2139
  # @param [String] page_token
2564
- # The next_page_token value returned from a previous list request.
2565
2140
  # @param [String] fields
2566
2141
  # Selector specifying which fields to include in a partial response.
2567
2142
  # @param [String] quota_user
@@ -2592,29 +2167,11 @@ module Google
2592
2167
  execute_or_queue_command(command, &block)
2593
2168
  end
2594
2169
 
2595
- # Updates the specified page.
2170
+ #
2596
2171
  # @param [String] name
2597
- # The unique identifier of the page. Required for the Pages.UpdatePage method.
2598
- # Pages.CreatePage populates the name automatically. Format: `projects//
2599
- # locations//agents//flows//pages/`.
2600
2172
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page] google_cloud_dialogflow_cx_v3beta1_page_object
2601
2173
  # @param [String] language_code
2602
- # The language of the following fields in `page`: * `Page.entry_fulfillment.
2603
- # messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.
2604
- # trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.
2605
- # conditional_cases` * `Page.form.parameters.fill_behavior.
2606
- # initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.
2607
- # initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.
2608
- # fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.
2609
- # fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.
2610
- # transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.
2611
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2612
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2613
- # reference/language) are supported. Note: languages must be enabled in the
2614
- # agent before they can be used.
2615
2174
  # @param [String] update_mask
2616
- # The mask to control which fields get updated. If the mask is not present, all
2617
- # fields will be updated.
2618
2175
  # @param [String] fields
2619
2176
  # Selector specifying which fields to include in a partial response.
2620
2177
  # @param [String] quota_user
@@ -2646,21 +2203,10 @@ module Google
2646
2203
  execute_or_queue_command(command, &block)
2647
2204
  end
2648
2205
 
2649
- # Creates an TransitionRouteGroup in the specified flow. Note: You should always
2650
- # train a flow prior to sending it queries. See the [training documentation](
2651
- # https://cloud.google.com/dialogflow/cx/docs/concept/training).
2206
+ #
2652
2207
  # @param [String] parent
2653
- # Required. The flow to create an TransitionRouteGroup for. Format: `projects//
2654
- # locations//agents//flows/` or `projects//locations//agents/` for agent-level
2655
- # groups.
2656
2208
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup] google_cloud_dialogflow_cx_v3beta1_transition_route_group_object
2657
2209
  # @param [String] language_code
2658
- # The language of the following fields in `TransitionRouteGroup`: * `
2659
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `
2660
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
2661
- # If not specified, the agent's default language is used. [Many languages](https:
2662
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
2663
- # languages must be enabled in the agent before they can be used.
2664
2210
  # @param [String] fields
2665
2211
  # Selector specifying which fields to include in a partial response.
2666
2212
  # @param [String] quota_user
@@ -2691,19 +2237,9 @@ module Google
2691
2237
  execute_or_queue_command(command, &block)
2692
2238
  end
2693
2239
 
2694
- # Deletes the specified TransitionRouteGroup. Note: You should always train a
2695
- # flow prior to sending it queries. See the [training documentation](https://
2696
- # cloud.google.com/dialogflow/cx/docs/concept/training).
2240
+ #
2697
2241
  # @param [String] name
2698
- # Required. The name of the TransitionRouteGroup to delete. Format: `projects//
2699
- # locations//agents//flows//transitionRouteGroups/` or `projects//locations//
2700
- # agents//transitionRouteGroups/`.
2701
2242
  # @param [Boolean] force
2702
- # This field has no effect for transition route group that no page is using. If
2703
- # the transition route group is referenced by any page: * If `force` is set to
2704
- # false, an error will be returned with message indicating pages that reference
2705
- # the transition route group. * If `force` is set to true, Dialogflow will
2706
- # remove the transition route group, as well as any reference to it.
2707
2243
  # @param [String] fields
2708
2244
  # Selector specifying which fields to include in a partial response.
2709
2245
  # @param [String] quota_user
@@ -2732,19 +2268,9 @@ module Google
2732
2268
  execute_or_queue_command(command, &block)
2733
2269
  end
2734
2270
 
2735
- # Retrieves the specified TransitionRouteGroup.
2271
+ #
2736
2272
  # @param [String] name
2737
- # Required. The name of the TransitionRouteGroup. Format: `projects//locations//
2738
- # agents//flows//transitionRouteGroups/` or `projects//locations//agents//
2739
- # transitionRouteGroups/`.
2740
2273
  # @param [String] language_code
2741
- # The language to retrieve the transition route group for. The following fields
2742
- # are language dependent: * `TransitionRouteGroup.transition_routes.
2743
- # trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.
2744
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2745
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2746
- # reference/language) are supported. Note: languages must be enabled in the
2747
- # agent before they can be used.
2748
2274
  # @param [String] fields
2749
2275
  # Selector specifying which fields to include in a partial response.
2750
2276
  # @param [String] quota_user
@@ -2773,23 +2299,11 @@ module Google
2773
2299
  execute_or_queue_command(command, &block)
2774
2300
  end
2775
2301
 
2776
- # Returns the list of all transition route groups in the specified flow.
2302
+ #
2777
2303
  # @param [String] parent
2778
- # Required. The flow to list all transition route groups for. Format: `projects//
2779
- # locations//agents//flows/` or `projects//locations//agents/.
2780
2304
  # @param [String] language_code
2781
- # The language to list transition route groups for. The following fields are
2782
- # language dependent: * `TransitionRouteGroup.transition_routes.
2783
- # trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.
2784
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
2785
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
2786
- # reference/language) are supported. Note: languages must be enabled in the
2787
- # agent before they can be used.
2788
2305
  # @param [Fixnum] page_size
2789
- # The maximum number of items to return in a single page. By default 100 and at
2790
- # most 1000.
2791
2306
  # @param [String] page_token
2792
- # The next_page_token value returned from a previous list request.
2793
2307
  # @param [String] fields
2794
2308
  # Selector specifying which fields to include in a partial response.
2795
2309
  # @param [String] quota_user
@@ -2820,24 +2334,11 @@ module Google
2820
2334
  execute_or_queue_command(command, &block)
2821
2335
  end
2822
2336
 
2823
- # Updates the specified TransitionRouteGroup. Note: You should always train a
2824
- # flow prior to sending it queries. See the [training documentation](https://
2825
- # cloud.google.com/dialogflow/cx/docs/concept/training).
2337
+ #
2826
2338
  # @param [String] name
2827
- # The unique identifier of the transition route group. TransitionRouteGroups.
2828
- # CreateTransitionRouteGroup populates the name automatically. Format: `projects/
2829
- # /locations//agents//flows//transitionRouteGroups/` or `projects//locations//
2830
- # agents//transitionRouteGroups/` for agent-level groups.
2831
2339
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup] google_cloud_dialogflow_cx_v3beta1_transition_route_group_object
2832
2340
  # @param [String] language_code
2833
- # The language of the following fields in `TransitionRouteGroup`: * `
2834
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `
2835
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
2836
- # If not specified, the agent's default language is used. [Many languages](https:
2837
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
2838
- # languages must be enabled in the agent before they can be used.
2839
2341
  # @param [String] update_mask
2840
- # The mask to control which fields get updated.
2841
2342
  # @param [String] fields
2842
2343
  # Selector specifying which fields to include in a partial response.
2843
2344
  # @param [String] quota_user
@@ -2869,11 +2370,8 @@ module Google
2869
2370
  execute_or_queue_command(command, &block)
2870
2371
  end
2871
2372
 
2872
- # Compares the specified base version with target version.
2373
+ #
2873
2374
  # @param [String] base_version
2874
- # Required. Name of the base flow version to compare with the target version.
2875
- # Use version ID `0` to indicate the draft version of the specified flow. Format:
2876
- # `projects//locations//agents//flows//versions/`.
2877
2375
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsRequest] google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object
2878
2376
  # @param [String] fields
2879
2377
  # Selector specifying which fields to include in a partial response.
@@ -2904,13 +2402,8 @@ module Google
2904
2402
  execute_or_queue_command(command, &block)
2905
2403
  end
2906
2404
 
2907
- # Creates a Version in the specified Flow. This method is a [long-running
2908
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
2909
- # operation). The returned `Operation` type has the following method-specific
2910
- # fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version
2405
+ #
2911
2406
  # @param [String] parent
2912
- # Required. The Flow to create an Version for. Format: `projects//locations//
2913
- # agents//flows/`.
2914
2407
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version] google_cloud_dialogflow_cx_v3beta1_version_object
2915
2408
  # @param [String] fields
2916
2409
  # Selector specifying which fields to include in a partial response.
@@ -2941,10 +2434,8 @@ module Google
2941
2434
  execute_or_queue_command(command, &block)
2942
2435
  end
2943
2436
 
2944
- # Deletes the specified Version.
2437
+ #
2945
2438
  # @param [String] name
2946
- # Required. The name of the Version to delete. Format: `projects//locations//
2947
- # agents//flows//versions/`.
2948
2439
  # @param [String] fields
2949
2440
  # Selector specifying which fields to include in a partial response.
2950
2441
  # @param [String] quota_user
@@ -2972,10 +2463,8 @@ module Google
2972
2463
  execute_or_queue_command(command, &block)
2973
2464
  end
2974
2465
 
2975
- # Retrieves the specified Version.
2466
+ #
2976
2467
  # @param [String] name
2977
- # Required. The name of the Version. Format: `projects//locations//agents//flows/
2978
- # /versions/`.
2979
2468
  # @param [String] fields
2980
2469
  # Selector specifying which fields to include in a partial response.
2981
2470
  # @param [String] quota_user
@@ -3003,15 +2492,10 @@ module Google
3003
2492
  execute_or_queue_command(command, &block)
3004
2493
  end
3005
2494
 
3006
- # Returns the list of all versions in the specified Flow.
2495
+ #
3007
2496
  # @param [String] parent
3008
- # Required. The Flow to list all versions for. Format: `projects//locations//
3009
- # agents//flows/`.
3010
2497
  # @param [Fixnum] page_size
3011
- # The maximum number of items to return in a single page. By default 20 and at
3012
- # most 100.
3013
2498
  # @param [String] page_token
3014
- # The next_page_token value returned from a previous list request.
3015
2499
  # @param [String] fields
3016
2500
  # Selector specifying which fields to include in a partial response.
3017
2501
  # @param [String] quota_user
@@ -3041,16 +2525,8 @@ module Google
3041
2525
  execute_or_queue_command(command, &block)
3042
2526
  end
3043
2527
 
3044
- # Loads resources in the specified version to the draft flow. This method is a [
3045
- # long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
3046
- # running-operation). The returned `Operation` type has the following method-
3047
- # specific fields: - `metadata`: An empty [Struct message](https://developers.
3048
- # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
3049
- # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
3050
- # reference/google.protobuf#empty)
2528
+ #
3051
2529
  # @param [String] name
3052
- # Required. The Version to be loaded to draft flow. Format: `projects//locations/
3053
- # /agents//flows//versions/`.
3054
2530
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LoadVersionRequest] google_cloud_dialogflow_cx_v3beta1_load_version_request_object
3055
2531
  # @param [String] fields
3056
2532
  # Selector specifying which fields to include in a partial response.
@@ -3081,14 +2557,10 @@ module Google
3081
2557
  execute_or_queue_command(command, &block)
3082
2558
  end
3083
2559
 
3084
- # Updates the specified Version.
2560
+ #
3085
2561
  # @param [String] name
3086
- # Format: projects//locations//agents//flows//versions/. Version ID is a self-
3087
- # increasing number generated by Dialogflow upon version creation.
3088
2562
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version] google_cloud_dialogflow_cx_v3beta1_version_object
3089
2563
  # @param [String] update_mask
3090
- # Required. The mask to control which fields get updated. Currently only `
3091
- # description` and `display_name` can be updated.
3092
2564
  # @param [String] fields
3093
2565
  # Selector specifying which fields to include in a partial response.
3094
2566
  # @param [String] quota_user
@@ -3119,14 +2591,10 @@ module Google
3119
2591
  execute_or_queue_command(command, &block)
3120
2592
  end
3121
2593
 
3122
- # Creates a generator in the specified agent.
2594
+ #
3123
2595
  # @param [String] parent
3124
- # Required. The agent to create a generator for. Format: `projects//locations//
3125
- # agents/`.
3126
2596
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator] google_cloud_dialogflow_cx_v3beta1_generator_object
3127
2597
  # @param [String] language_code
3128
- # The language to create generators for the following fields: * `Generator.
3129
- # prompt_text.text` If not specified, the agent's default language is used.
3130
2598
  # @param [String] fields
3131
2599
  # Selector specifying which fields to include in a partial response.
3132
2600
  # @param [String] quota_user
@@ -3157,16 +2625,9 @@ module Google
3157
2625
  execute_or_queue_command(command, &block)
3158
2626
  end
3159
2627
 
3160
- # Deletes the specified generators.
2628
+ #
3161
2629
  # @param [String] name
3162
- # Required. The name of the generator to delete. Format: `projects//locations//
3163
- # agents//generators/`.
3164
2630
  # @param [Boolean] force
3165
- # This field has no effect for generators not being used. For generators that
3166
- # are used by pages/flows/transition route groups: * If `force` is set to false,
3167
- # an error will be returned with message indicating the referenced resources. *
3168
- # If `force` is set to true, Dialogflow will remove the generator, as well as
3169
- # any references to the generator (i.e. Generator) in fulfillments.
3170
2631
  # @param [String] fields
3171
2632
  # Selector specifying which fields to include in a partial response.
3172
2633
  # @param [String] quota_user
@@ -3195,12 +2656,9 @@ module Google
3195
2656
  execute_or_queue_command(command, &block)
3196
2657
  end
3197
2658
 
3198
- # Retrieves the specified generator.
2659
+ #
3199
2660
  # @param [String] name
3200
- # Required. The name of the generator. Format: `projects//locations//agents//
3201
- # generators/`.
3202
2661
  # @param [String] language_code
3203
- # The language to list generators for.
3204
2662
  # @param [String] fields
3205
2663
  # Selector specifying which fields to include in a partial response.
3206
2664
  # @param [String] quota_user
@@ -3229,17 +2687,11 @@ module Google
3229
2687
  execute_or_queue_command(command, &block)
3230
2688
  end
3231
2689
 
3232
- # Returns the list of all generators in the specified agent.
2690
+ #
3233
2691
  # @param [String] parent
3234
- # Required. The agent to list all generators for. Format: `projects//locations//
3235
- # agents/`.
3236
2692
  # @param [String] language_code
3237
- # The language to list generators for.
3238
2693
  # @param [Fixnum] page_size
3239
- # The maximum number of items to return in a single page. By default 100 and at
3240
- # most 1000.
3241
2694
  # @param [String] page_token
3242
- # The next_page_token value returned from a previous list request.
3243
2695
  # @param [String] fields
3244
2696
  # Selector specifying which fields to include in a partial response.
3245
2697
  # @param [String] quota_user
@@ -3270,17 +2722,11 @@ module Google
3270
2722
  execute_or_queue_command(command, &block)
3271
2723
  end
3272
2724
 
3273
- # Update the specified generator.
2725
+ #
3274
2726
  # @param [String] name
3275
- # The unique identifier of the generator. Must be set for the Generators.
3276
- # UpdateGenerator method. Generators.CreateGenerate populates the name
3277
- # automatically. Format: `projects//locations//agents//generators/`.
3278
2727
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator] google_cloud_dialogflow_cx_v3beta1_generator_object
3279
2728
  # @param [String] language_code
3280
- # The language to list generators for.
3281
2729
  # @param [String] update_mask
3282
- # The mask to control which fields get updated. If the mask is not present, all
3283
- # fields will be updated.
3284
2730
  # @param [String] fields
3285
2731
  # Selector specifying which fields to include in a partial response.
3286
2732
  # @param [String] quota_user
@@ -3312,19 +2758,10 @@ module Google
3312
2758
  execute_or_queue_command(command, &block)
3313
2759
  end
3314
2760
 
3315
- # Creates an intent in the specified agent. Note: You should always train a flow
3316
- # prior to sending it queries. See the [training documentation](https://cloud.
3317
- # google.com/dialogflow/cx/docs/concept/training).
2761
+ #
3318
2762
  # @param [String] parent
3319
- # Required. The agent to create an intent for. Format: `projects//locations//
3320
- # agents/`.
3321
2763
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent] google_cloud_dialogflow_cx_v3beta1_intent_object
3322
2764
  # @param [String] language_code
3323
- # The language of the following fields in `intent`: * `Intent.training_phrases.
3324
- # parts.text` If not specified, the agent's default language is used. [Many
3325
- # languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are
3326
- # supported. Note: languages must be enabled in the agent before they can be
3327
- # used.
3328
2765
  # @param [String] fields
3329
2766
  # Selector specifying which fields to include in a partial response.
3330
2767
  # @param [String] quota_user
@@ -3355,12 +2792,8 @@ module Google
3355
2792
  execute_or_queue_command(command, &block)
3356
2793
  end
3357
2794
 
3358
- # Deletes the specified intent. Note: You should always train a flow prior to
3359
- # sending it queries. See the [training documentation](https://cloud.google.com/
3360
- # dialogflow/cx/docs/concept/training).
2795
+ #
3361
2796
  # @param [String] name
3362
- # Required. The name of the intent to delete. Format: `projects//locations//
3363
- # agents//intents/`.
3364
2797
  # @param [String] fields
3365
2798
  # Selector specifying which fields to include in a partial response.
3366
2799
  # @param [String] quota_user
@@ -3388,13 +2821,8 @@ module Google
3388
2821
  execute_or_queue_command(command, &block)
3389
2822
  end
3390
2823
 
3391
- # Exports the selected intents. This method is a [long-running operation](https:/
3392
- # /cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned
3393
- # `Operation` type has the following method-specific fields: - `metadata`:
3394
- # ExportIntentsMetadata - `response`: ExportIntentsResponse
2824
+ #
3395
2825
  # @param [String] parent
3396
- # Required. The name of the parent agent to export intents. Format: `projects//
3397
- # locations//agents/`.
3398
2826
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportIntentsRequest] google_cloud_dialogflow_cx_v3beta1_export_intents_request_object
3399
2827
  # @param [String] fields
3400
2828
  # Selector specifying which fields to include in a partial response.
@@ -3425,16 +2853,9 @@ module Google
3425
2853
  execute_or_queue_command(command, &block)
3426
2854
  end
3427
2855
 
3428
- # Retrieves the specified intent.
2856
+ #
3429
2857
  # @param [String] name
3430
- # Required. The name of the intent. Format: `projects//locations//agents//
3431
- # intents/`.
3432
2858
  # @param [String] language_code
3433
- # The language to retrieve the intent for. The following fields are language
3434
- # dependent: * `Intent.training_phrases.parts.text` If not specified, the agent'
3435
- # s default language is used. [Many languages](https://cloud.google.com/
3436
- # dialogflow/cx/docs/reference/language) are supported. Note: languages must be
3437
- # enabled in the agent before they can be used.
3438
2859
  # @param [String] fields
3439
2860
  # Selector specifying which fields to include in a partial response.
3440
2861
  # @param [String] quota_user
@@ -3463,14 +2884,8 @@ module Google
3463
2884
  execute_or_queue_command(command, &block)
3464
2885
  end
3465
2886
 
3466
- # Imports the specified intents into the agent. This method is a [long-running
3467
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
3468
- # operation). The returned `Operation` type has the following method-specific
3469
- # fields: - `metadata`: ImportIntentsMetadata - `response`:
3470
- # ImportIntentsResponse
2887
+ #
3471
2888
  # @param [String] parent
3472
- # Required. The agent to import the intents into. Format: `projects//locations//
3473
- # agents/`.
3474
2889
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportIntentsRequest] google_cloud_dialogflow_cx_v3beta1_import_intents_request_object
3475
2890
  # @param [String] fields
3476
2891
  # Selector specifying which fields to include in a partial response.
@@ -3501,23 +2916,12 @@ module Google
3501
2916
  execute_or_queue_command(command, &block)
3502
2917
  end
3503
2918
 
3504
- # Returns the list of all intents in the specified agent.
2919
+ #
3505
2920
  # @param [String] parent
3506
- # Required. The agent to list all intents for. Format: `projects//locations//
3507
- # agents/`.
3508
2921
  # @param [String] intent_view
3509
- # The resource view to apply to the returned intent.
3510
2922
  # @param [String] language_code
3511
- # The language to list intents for. The following fields are language dependent:
3512
- # * `Intent.training_phrases.parts.text` If not specified, the agent's default
3513
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
3514
- # reference/language) are supported. Note: languages must be enabled in the
3515
- # agent before they can be used.
3516
2923
  # @param [Fixnum] page_size
3517
- # The maximum number of items to return in a single page. By default 100 and at
3518
- # most 1000.
3519
2924
  # @param [String] page_token
3520
- # The next_page_token value returned from a previous list request.
3521
2925
  # @param [String] fields
3522
2926
  # Selector specifying which fields to include in a partial response.
3523
2927
  # @param [String] quota_user
@@ -3549,23 +2953,11 @@ module Google
3549
2953
  execute_or_queue_command(command, &block)
3550
2954
  end
3551
2955
 
3552
- # Updates the specified intent. Note: You should always train a flow prior to
3553
- # sending it queries. See the [training documentation](https://cloud.google.com/
3554
- # dialogflow/cx/docs/concept/training).
2956
+ #
3555
2957
  # @param [String] name
3556
- # The unique identifier of the intent. Required for the Intents.UpdateIntent
3557
- # method. Intents.CreateIntent populates the name automatically. Format: `
3558
- # projects//locations//agents//intents/`.
3559
2958
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent] google_cloud_dialogflow_cx_v3beta1_intent_object
3560
2959
  # @param [String] language_code
3561
- # The language of the following fields in `intent`: * `Intent.training_phrases.
3562
- # parts.text` If not specified, the agent's default language is used. [Many
3563
- # languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are
3564
- # supported. Note: languages must be enabled in the agent before they can be
3565
- # used.
3566
2960
  # @param [String] update_mask
3567
- # The mask to control which fields get updated. If the mask is not present, all
3568
- # fields will be updated.
3569
2961
  # @param [String] fields
3570
2962
  # Selector specifying which fields to include in a partial response.
3571
2963
  # @param [String] quota_user
@@ -3597,10 +2989,8 @@ module Google
3597
2989
  execute_or_queue_command(command, &block)
3598
2990
  end
3599
2991
 
3600
- # Creates a playbook in a specified agent.
2992
+ #
3601
2993
  # @param [String] parent
3602
- # Required. The agent to create a playbook for. Format: `projects//locations//
3603
- # agents/`.
3604
2994
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] google_cloud_dialogflow_cx_v3beta1_playbook_object
3605
2995
  # @param [String] fields
3606
2996
  # Selector specifying which fields to include in a partial response.
@@ -3631,10 +3021,8 @@ module Google
3631
3021
  execute_or_queue_command(command, &block)
3632
3022
  end
3633
3023
 
3634
- # Deletes a specified playbook.
3024
+ #
3635
3025
  # @param [String] name
3636
- # Required. The name of the playbook to delete. Format: `projects//locations//
3637
- # agents//playbooks/`.
3638
3026
  # @param [String] fields
3639
3027
  # Selector specifying which fields to include in a partial response.
3640
3028
  # @param [String] quota_user
@@ -3662,11 +3050,8 @@ module Google
3662
3050
  execute_or_queue_command(command, &block)
3663
3051
  end
3664
3052
 
3665
- # Exports the specified playbook to a binary file. Note that resources (e.g.
3666
- # examples, tools) that the playbook references will also be exported.
3053
+ #
3667
3054
  # @param [String] name
3668
- # Required. The name of the playbook to export. Format: `projects//locations//
3669
- # agents//playbooks/`.
3670
3055
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest] google_cloud_dialogflow_cx_v3beta1_export_playbook_request_object
3671
3056
  # @param [String] fields
3672
3057
  # Selector specifying which fields to include in a partial response.
@@ -3697,10 +3082,8 @@ module Google
3697
3082
  execute_or_queue_command(command, &block)
3698
3083
  end
3699
3084
 
3700
- # Retrieves the specified Playbook.
3085
+ #
3701
3086
  # @param [String] name
3702
- # Required. The name of the playbook. Format: `projects//locations//agents//
3703
- # playbooks/`.
3704
3087
  # @param [String] fields
3705
3088
  # Selector specifying which fields to include in a partial response.
3706
3089
  # @param [String] quota_user
@@ -3728,10 +3111,8 @@ module Google
3728
3111
  execute_or_queue_command(command, &block)
3729
3112
  end
3730
3113
 
3731
- # Imports the specified playbook to the specified agent from a binary file.
3114
+ #
3732
3115
  # @param [String] parent
3733
- # Required. The agent to import the playbook into. Format: `projects//locations//
3734
- # agents/`.
3735
3116
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest] google_cloud_dialogflow_cx_v3beta1_import_playbook_request_object
3736
3117
  # @param [String] fields
3737
3118
  # Selector specifying which fields to include in a partial response.
@@ -3762,15 +3143,10 @@ module Google
3762
3143
  execute_or_queue_command(command, &block)
3763
3144
  end
3764
3145
 
3765
- # Returns a list of playbooks in the specified agent.
3146
+ #
3766
3147
  # @param [String] parent
3767
- # Required. The agent to list playbooks from. Format: `projects//locations//
3768
- # agents/`.
3769
3148
  # @param [Fixnum] page_size
3770
- # The maximum number of items to return in a single page. By default 100 and at
3771
- # most 1000.
3772
3149
  # @param [String] page_token
3773
- # The next_page_token value returned from a previous list request.
3774
3150
  # @param [String] fields
3775
3151
  # Selector specifying which fields to include in a partial response.
3776
3152
  # @param [String] quota_user
@@ -3800,14 +3176,10 @@ module Google
3800
3176
  execute_or_queue_command(command, &block)
3801
3177
  end
3802
3178
 
3803
- # Updates the specified Playbook.
3179
+ #
3804
3180
  # @param [String] name
3805
- # The unique identifier of the playbook. Format: `projects//locations//agents//
3806
- # playbooks/`.
3807
3181
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] google_cloud_dialogflow_cx_v3beta1_playbook_object
3808
3182
  # @param [String] update_mask
3809
- # The mask to control which fields get updated. If the mask is not present, all
3810
- # fields will be updated.
3811
3183
  # @param [String] fields
3812
3184
  # Selector specifying which fields to include in a partial response.
3813
3185
  # @param [String] quota_user
@@ -3838,10 +3210,8 @@ module Google
3838
3210
  execute_or_queue_command(command, &block)
3839
3211
  end
3840
3212
 
3841
- # Creates an example in the specified playbook.
3213
+ #
3842
3214
  # @param [String] parent
3843
- # Required. The playbook to create an example for. Format: `projects//locations//
3844
- # agents//playbooks/`.
3845
3215
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] google_cloud_dialogflow_cx_v3beta1_example_object
3846
3216
  # @param [String] fields
3847
3217
  # Selector specifying which fields to include in a partial response.
@@ -3872,10 +3242,8 @@ module Google
3872
3242
  execute_or_queue_command(command, &block)
3873
3243
  end
3874
3244
 
3875
- # Deletes the specified example.
3245
+ #
3876
3246
  # @param [String] name
3877
- # Required. The name of the example to delete. Format: `projects//locations//
3878
- # agents//playbooks//examples/`.
3879
3247
  # @param [String] fields
3880
3248
  # Selector specifying which fields to include in a partial response.
3881
3249
  # @param [String] quota_user
@@ -3903,10 +3271,8 @@ module Google
3903
3271
  execute_or_queue_command(command, &block)
3904
3272
  end
3905
3273
 
3906
- # Retrieves the specified example.
3274
+ #
3907
3275
  # @param [String] name
3908
- # Required. The name of the example. Format: `projects//locations//agents//
3909
- # playbooks//examples/`.
3910
3276
  # @param [String] fields
3911
3277
  # Selector specifying which fields to include in a partial response.
3912
3278
  # @param [String] quota_user
@@ -3934,19 +3300,11 @@ module Google
3934
3300
  execute_or_queue_command(command, &block)
3935
3301
  end
3936
3302
 
3937
- # Returns a list of examples in the specified playbook.
3303
+ #
3938
3304
  # @param [String] parent
3939
- # Required. The playbook to list the examples from. Format: `projects//locations/
3940
- # /agents//playbooks/`.
3941
3305
  # @param [String] language_code
3942
- # Optional. The language to list examples for. If not specified, list all
3943
- # examples under the playbook. Note: languages must be enabled in the agent
3944
- # before they can be used.
3945
3306
  # @param [Fixnum] page_size
3946
- # Optional. The maximum number of items to return in a single page. By default
3947
- # 100 and at most 1000.
3948
3307
  # @param [String] page_token
3949
- # Optional. The next_page_token value returned from a previous list request.
3950
3308
  # @param [String] fields
3951
3309
  # Selector specifying which fields to include in a partial response.
3952
3310
  # @param [String] quota_user
@@ -3977,14 +3335,10 @@ module Google
3977
3335
  execute_or_queue_command(command, &block)
3978
3336
  end
3979
3337
 
3980
- # Update the specified example.
3338
+ #
3981
3339
  # @param [String] name
3982
- # The unique identifier of the playbook example. Format: `projects//locations//
3983
- # agents//playbooks//examples/`.
3984
3340
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] google_cloud_dialogflow_cx_v3beta1_example_object
3985
3341
  # @param [String] update_mask
3986
- # Optional. The mask to control which fields get updated. If the mask is not
3987
- # present, all fields will be updated.
3988
3342
  # @param [String] fields
3989
3343
  # Selector specifying which fields to include in a partial response.
3990
3344
  # @param [String] quota_user
@@ -4015,10 +3369,8 @@ module Google
4015
3369
  execute_or_queue_command(command, &block)
4016
3370
  end
4017
3371
 
4018
- # Creates a version for the specified Playbook.
3372
+ #
4019
3373
  # @param [String] parent
4020
- # Required. The playbook to create a version for. Format: `projects//locations//
4021
- # agents//playbooks/`.
4022
3374
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion] google_cloud_dialogflow_cx_v3beta1_playbook_version_object
4023
3375
  # @param [String] fields
4024
3376
  # Selector specifying which fields to include in a partial response.
@@ -4049,10 +3401,8 @@ module Google
4049
3401
  execute_or_queue_command(command, &block)
4050
3402
  end
4051
3403
 
4052
- # Deletes the specified version of the Playbook.
3404
+ #
4053
3405
  # @param [String] name
4054
- # Required. The name of the playbook version to delete. Format: `projects//
4055
- # locations//agents//playbooks//versions/`.
4056
3406
  # @param [String] fields
4057
3407
  # Selector specifying which fields to include in a partial response.
4058
3408
  # @param [String] quota_user
@@ -4080,10 +3430,8 @@ module Google
4080
3430
  execute_or_queue_command(command, &block)
4081
3431
  end
4082
3432
 
4083
- # Retrieves the specified version of the Playbook.
3433
+ #
4084
3434
  # @param [String] name
4085
- # Required. The name of the playbook version. Format: `projects//locations//
4086
- # agents//playbooks//versions/`.
4087
3435
  # @param [String] fields
4088
3436
  # Selector specifying which fields to include in a partial response.
4089
3437
  # @param [String] quota_user
@@ -4111,15 +3459,10 @@ module Google
4111
3459
  execute_or_queue_command(command, &block)
4112
3460
  end
4113
3461
 
4114
- # Lists versions for the specified Playbook.
3462
+ #
4115
3463
  # @param [String] parent
4116
- # Required. The playbook to list versions for. Format: `projects//locations//
4117
- # agents//playbooks/`.
4118
3464
  # @param [Fixnum] page_size
4119
- # Optional. The maximum number of items to return in a single page. By default
4120
- # 100 and at most 1000.
4121
3465
  # @param [String] page_token
4122
- # Optional. The next_page_token value returned from a previous list request.
4123
3466
  # @param [String] fields
4124
3467
  # Selector specifying which fields to include in a partial response.
4125
3468
  # @param [String] quota_user
@@ -4149,11 +3492,8 @@ module Google
4149
3492
  execute_or_queue_command(command, &block)
4150
3493
  end
4151
3494
 
4152
- # Retrieves the specified version of the Playbook and stores it as the current
4153
- # playbook draft, returning the playbook with resources updated.
3495
+ #
4154
3496
  # @param [String] name
4155
- # Required. The name of the playbook version. Format: `projects//locations//
4156
- # agents//playbooks//versions/`.
4157
3497
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest] google_cloud_dialogflow_cx_v3beta1_restore_playbook_version_request_object
4158
3498
  # @param [String] fields
4159
3499
  # Selector specifying which fields to include in a partial response.
@@ -4184,22 +3524,8 @@ module Google
4184
3524
  execute_or_queue_command(command, &block)
4185
3525
  end
4186
3526
 
4187
- # Processes a natural language query and returns structured, actionable data as
4188
- # a result. This method is not idempotent, because it may cause session entity
4189
- # types to be updated, which in turn might affect results of future queries.
4190
- # Note: Always use agent versions for production traffic. See [Versions and
4191
- # environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
3527
+ #
4192
3528
  # @param [String] session
4193
- # Required. The name of the session this query is sent to. Format: `projects//
4194
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4195
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4196
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
4197
- # It can be a random number or some type of session identifiers (preferably
4198
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
4199
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
4200
- # cx/docs/concept/session). Note: Always use agent versions for production
4201
- # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
4202
- # cx/docs/concept/version).
4203
3529
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest] google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object
4204
3530
  # @param [String] fields
4205
3531
  # Selector specifying which fields to include in a partial response.
@@ -4230,18 +3556,8 @@ module Google
4230
3556
  execute_or_queue_command(command, &block)
4231
3557
  end
4232
3558
 
4233
- # Fulfills a matched intent returned by MatchIntent. Must be called after
4234
- # MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is
4235
- # undefined.
3559
+ #
4236
3560
  # @param [String] session
4237
- # Required. The name of the session this query is sent to. Format: `projects//
4238
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4239
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4240
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
4241
- # It can be a random number or some type of session identifiers (preferably
4242
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
4243
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
4244
- # cx/docs/concept/session).
4245
3561
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentRequest] google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object
4246
3562
  # @param [String] fields
4247
3563
  # Selector specifying which fields to include in a partial response.
@@ -4272,16 +3588,8 @@ module Google
4272
3588
  execute_or_queue_command(command, &block)
4273
3589
  end
4274
3590
 
4275
- # Returns preliminary intent match results, doesn't change the session status.
3591
+ #
4276
3592
  # @param [String] session
4277
- # Required. The name of the session this query is sent to. Format: `projects//
4278
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4279
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4280
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
4281
- # It can be a random number or some type of session identifiers (preferably
4282
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
4283
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
4284
- # cx/docs/concept/session).
4285
3593
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentRequest] google_cloud_dialogflow_cx_v3beta1_match_intent_request_object
4286
3594
  # @param [String] fields
4287
3595
  # Selector specifying which fields to include in a partial response.
@@ -4312,21 +3620,8 @@ module Google
4312
3620
  execute_or_queue_command(command, &block)
4313
3621
  end
4314
3622
 
4315
- # Processes a natural language query and returns structured, actionable data as
4316
- # a result through server-side streaming. Server-side streaming allows
4317
- # Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/
4318
- # docs/concept/fulfillment#partial-response) earlier in a single request.
3623
+ #
4319
3624
  # @param [String] session
4320
- # Required. The name of the session this query is sent to. Format: `projects//
4321
- # locations//agents//sessions/` or `projects//locations//agents//environments//
4322
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4323
- # environment. It's up to the API caller to choose an appropriate `Session ID`.
4324
- # It can be a random number or some type of session identifiers (preferably
4325
- # hashed). The length of the `Session ID` must not exceed 36 characters. For
4326
- # more information, see the [sessions guide](https://cloud.google.com/dialogflow/
4327
- # cx/docs/concept/session). Note: Always use agent versions for production
4328
- # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
4329
- # cx/docs/concept/version).
4330
3625
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest] google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object
4331
3626
  # @param [String] fields
4332
3627
  # Selector specifying which fields to include in a partial response.
@@ -4357,10 +3652,8 @@ module Google
4357
3652
  execute_or_queue_command(command, &block)
4358
3653
  end
4359
3654
 
4360
- # Updates the feedback received from the user for a single turn of the bot
4361
- # response.
3655
+ #
4362
3656
  # @param [String] session
4363
- # Required. The name of the session the feedback was sent to.
4364
3657
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SubmitAnswerFeedbackRequest] google_cloud_dialogflow_cx_v3beta1_submit_answer_feedback_request_object
4365
3658
  # @param [String] fields
4366
3659
  # Selector specifying which fields to include in a partial response.
@@ -4391,12 +3684,8 @@ module Google
4391
3684
  execute_or_queue_command(command, &block)
4392
3685
  end
4393
3686
 
4394
- # Creates a session entity type.
3687
+ #
4395
3688
  # @param [String] parent
4396
- # Required. The session to create a session entity type for. 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
3689
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType] google_cloud_dialogflow_cx_v3beta1_session_entity_type_object
4401
3690
  # @param [String] fields
4402
3691
  # Selector specifying which fields to include in a partial response.
@@ -4427,12 +3716,8 @@ module Google
4427
3716
  execute_or_queue_command(command, &block)
4428
3717
  end
4429
3718
 
4430
- # Deletes the specified session entity type.
3719
+ #
4431
3720
  # @param [String] name
4432
- # Required. The name of the session entity type to delete. Format: `projects//
4433
- # locations//agents//sessions//entityTypes/` or `projects//locations//agents//
4434
- # environments//sessions//entityTypes/`. If `Environment ID` is not specified,
4435
- # we assume default 'draft' environment.
4436
3721
  # @param [String] fields
4437
3722
  # Selector specifying which fields to include in a partial response.
4438
3723
  # @param [String] quota_user
@@ -4460,12 +3745,8 @@ module Google
4460
3745
  execute_or_queue_command(command, &block)
4461
3746
  end
4462
3747
 
4463
- # Retrieves the specified session entity type.
3748
+ #
4464
3749
  # @param [String] name
4465
- # Required. The name of the session entity type. Format: `projects//locations//
4466
- # agents//sessions//entityTypes/` or `projects//locations//agents//environments//
4467
- # sessions//entityTypes/`. If `Environment ID` is not specified, we assume
4468
- # default 'draft' environment.
4469
3750
  # @param [String] fields
4470
3751
  # Selector specifying which fields to include in a partial response.
4471
3752
  # @param [String] quota_user
@@ -4493,17 +3774,10 @@ module Google
4493
3774
  execute_or_queue_command(command, &block)
4494
3775
  end
4495
3776
 
4496
- # Returns the list of all session entity types in the specified session.
3777
+ #
4497
3778
  # @param [String] parent
4498
- # Required. The session to list all session entity types from. Format: `projects/
4499
- # /locations//agents//sessions/` or `projects//locations//agents//environments//
4500
- # sessions/`. If `Environment ID` is not specified, we assume default 'draft'
4501
- # environment.
4502
3779
  # @param [Fixnum] page_size
4503
- # The maximum number of items to return in a single page. By default 100 and at
4504
- # most 1000.
4505
3780
  # @param [String] page_token
4506
- # The next_page_token value returned from a previous list request.
4507
3781
  # @param [String] fields
4508
3782
  # Selector specifying which fields to include in a partial response.
4509
3783
  # @param [String] quota_user
@@ -4533,15 +3807,10 @@ module Google
4533
3807
  execute_or_queue_command(command, &block)
4534
3808
  end
4535
3809
 
4536
- # Updates the specified session entity type.
3810
+ #
4537
3811
  # @param [String] name
4538
- # Required. The unique identifier of the session entity type. Format: `projects//
4539
- # locations//agents//sessions//entityTypes/` or `projects//locations//agents//
4540
- # environments//sessions//entityTypes/`. If `Environment ID` is not specified,
4541
- # we assume default 'draft' environment.
4542
3812
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType] google_cloud_dialogflow_cx_v3beta1_session_entity_type_object
4543
3813
  # @param [String] update_mask
4544
- # The mask to control which fields get updated.
4545
3814
  # @param [String] fields
4546
3815
  # Selector specifying which fields to include in a partial response.
4547
3816
  # @param [String] quota_user
@@ -4572,10 +3841,8 @@ module Google
4572
3841
  execute_or_queue_command(command, &block)
4573
3842
  end
4574
3843
 
4575
- # Batch deletes test cases.
3844
+ #
4576
3845
  # @param [String] parent
4577
- # Required. The agent to delete test cases from. Format: `projects//locations//
4578
- # agents/`.
4579
3846
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BatchDeleteTestCasesRequest] google_cloud_dialogflow_cx_v3beta1_batch_delete_test_cases_request_object
4580
3847
  # @param [String] fields
4581
3848
  # Selector specifying which fields to include in a partial response.
@@ -4606,12 +3873,8 @@ module Google
4606
3873
  execute_or_queue_command(command, &block)
4607
3874
  end
4608
3875
 
4609
- # Kicks off a batch run of test cases. This method is a [long-running operation](
4610
- # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
4611
- # returned `Operation` type has the following method-specific fields: - `
4612
- # metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse
3876
+ #
4613
3877
  # @param [String] parent
4614
- # Required. Agent name. Format: `projects//locations//agents/`.
4615
3878
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BatchRunTestCasesRequest] google_cloud_dialogflow_cx_v3beta1_batch_run_test_cases_request_object
4616
3879
  # @param [String] fields
4617
3880
  # Selector specifying which fields to include in a partial response.
@@ -4642,12 +3905,9 @@ module Google
4642
3905
  execute_or_queue_command(command, &block)
4643
3906
  end
4644
3907
 
4645
- # Calculates the test coverage for an agent.
3908
+ #
4646
3909
  # @param [String] agent
4647
- # Required. The agent to calculate coverage for. Format: `projects//locations//
4648
- # agents/`.
4649
3910
  # @param [String] type
4650
- # Required. The type of coverage requested.
4651
3911
  # @param [String] fields
4652
3912
  # Selector specifying which fields to include in a partial response.
4653
3913
  # @param [String] quota_user
@@ -4676,10 +3936,8 @@ module Google
4676
3936
  execute_or_queue_command(command, &block)
4677
3937
  end
4678
3938
 
4679
- # Creates a test case for the given agent.
3939
+ #
4680
3940
  # @param [String] parent
4681
- # Required. The agent to create the test case for. Format: `projects//locations//
4682
- # agents/`.
4683
3941
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase] google_cloud_dialogflow_cx_v3beta1_test_case_object
4684
3942
  # @param [String] fields
4685
3943
  # Selector specifying which fields to include in a partial response.
@@ -4710,15 +3968,8 @@ module Google
4710
3968
  execute_or_queue_command(command, &block)
4711
3969
  end
4712
3970
 
4713
- # Exports the test cases under the agent to a Cloud Storage bucket or a local
4714
- # file. Filter can be applied to export a subset of test cases. This method is a
4715
- # [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
4716
- # running-operation). The returned `Operation` type has the following method-
4717
- # specific fields: - `metadata`: ExportTestCasesMetadata - `response`:
4718
- # ExportTestCasesResponse
3971
+ #
4719
3972
  # @param [String] parent
4720
- # Required. The agent where to export test cases from. Format: `projects//
4721
- # locations//agents/`.
4722
3973
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportTestCasesRequest] google_cloud_dialogflow_cx_v3beta1_export_test_cases_request_object
4723
3974
  # @param [String] fields
4724
3975
  # Selector specifying which fields to include in a partial response.
@@ -4749,10 +4000,8 @@ module Google
4749
4000
  execute_or_queue_command(command, &block)
4750
4001
  end
4751
4002
 
4752
- # Gets a test case.
4003
+ #
4753
4004
  # @param [String] name
4754
- # Required. The name of the testcase. Format: `projects//locations//agents//
4755
- # testCases/`.
4756
4005
  # @param [String] fields
4757
4006
  # Selector specifying which fields to include in a partial response.
4758
4007
  # @param [String] quota_user
@@ -4780,16 +4029,8 @@ module Google
4780
4029
  execute_or_queue_command(command, &block)
4781
4030
  end
4782
4031
 
4783
- # Imports the test cases from a Cloud Storage bucket or a local file. It always
4784
- # creates new test cases and won't overwrite any existing ones. The provided ID
4785
- # in the imported test case is neglected. This method is a [long-running
4786
- # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
4787
- # operation). The returned `Operation` type has the following method-specific
4788
- # fields: - `metadata`: ImportTestCasesMetadata - `response`:
4789
- # ImportTestCasesResponse
4032
+ #
4790
4033
  # @param [String] parent
4791
- # Required. The agent to import test cases to. Format: `projects//locations//
4792
- # agents/`.
4793
4034
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportTestCasesRequest] google_cloud_dialogflow_cx_v3beta1_import_test_cases_request_object
4794
4035
  # @param [String] fields
4795
4036
  # Selector specifying which fields to include in a partial response.
@@ -4820,18 +4061,11 @@ module Google
4820
4061
  execute_or_queue_command(command, &block)
4821
4062
  end
4822
4063
 
4823
- # Fetches a list of test cases for a given agent.
4064
+ #
4824
4065
  # @param [String] parent
4825
- # Required. The agent to list all pages for. Format: `projects//locations//
4826
- # agents/`.
4827
4066
  # @param [Fixnum] page_size
4828
- # The maximum number of items to return in a single page. By default 20. Note
4829
- # that when TestCaseView = FULL, the maximum page size allowed is 20. When
4830
- # TestCaseView = BASIC, the maximum page size allowed is 500.
4831
4067
  # @param [String] page_token
4832
- # The next_page_token value returned from a previous list request.
4833
4068
  # @param [String] view
4834
- # Specifies whether response should include all fields or just the metadata.
4835
4069
  # @param [String] fields
4836
4070
  # Selector specifying which fields to include in a partial response.
4837
4071
  # @param [String] quota_user
@@ -4862,15 +4096,10 @@ module Google
4862
4096
  execute_or_queue_command(command, &block)
4863
4097
  end
4864
4098
 
4865
- # Updates the specified test case.
4099
+ #
4866
4100
  # @param [String] name
4867
- # The unique identifier of the test case. TestCases.CreateTestCase will populate
4868
- # the name automatically. Otherwise use format: `projects//locations//agents//
4869
- # testCases/`.
4870
4101
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase] google_cloud_dialogflow_cx_v3beta1_test_case_object
4871
4102
  # @param [String] update_mask
4872
- # Required. The mask to specify which fields should be updated. The `
4873
- # creationTime` and `lastTestResult` cannot be updated.
4874
4103
  # @param [String] fields
4875
4104
  # Selector specifying which fields to include in a partial response.
4876
4105
  # @param [String] quota_user
@@ -4901,13 +4130,8 @@ module Google
4901
4130
  execute_or_queue_command(command, &block)
4902
4131
  end
4903
4132
 
4904
- # Kicks off a test case run. This method is a [long-running operation](https://
4905
- # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
4906
- # Operation` type has the following method-specific fields: - `metadata`:
4907
- # RunTestCaseMetadata - `response`: RunTestCaseResponse
4133
+ #
4908
4134
  # @param [String] name
4909
- # Required. Format of test case name to run: `projects//locations//agents//
4910
- # testCases/`.
4911
4135
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RunTestCaseRequest] google_cloud_dialogflow_cx_v3beta1_run_test_case_request_object
4912
4136
  # @param [String] fields
4913
4137
  # Selector specifying which fields to include in a partial response.
@@ -4938,10 +4162,8 @@ module Google
4938
4162
  execute_or_queue_command(command, &block)
4939
4163
  end
4940
4164
 
4941
- # Gets a test case result.
4165
+ #
4942
4166
  # @param [String] name
4943
- # Required. The name of the testcase. Format: `projects//locations//agents//
4944
- # testCases//results/`.
4945
4167
  # @param [String] fields
4946
4168
  # Selector specifying which fields to include in a partial response.
4947
4169
  # @param [String] quota_user
@@ -4969,30 +4191,11 @@ module Google
4969
4191
  execute_or_queue_command(command, &block)
4970
4192
  end
4971
4193
 
4972
- # Fetches the list of run results for the given test case. A maximum of 100
4973
- # results are kept for each test case.
4194
+ #
4974
4195
  # @param [String] parent
4975
- # Required. The test case to list results for. Format: `projects//locations//
4976
- # agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list
4977
- # results across multiple test cases.
4978
4196
  # @param [String] filter
4979
- # The filter expression used to filter test case results. See [API Filtering](
4980
- # https://aip.dev/160). The expression is case insensitive. Only 'AND' is
4981
- # supported for logical operators. The supported syntax is listed below in
4982
- # detail: [AND ] ... [AND latest] The supported fields and operators are: field
4983
- # operator `environment` `=`, `IN` (Use value `draft` for draft environment) `
4984
- # test_time` `>`, `<` `latest` only returns the latest test result in all
4985
- # results for each test case. Examples: * "environment=draft AND latest" matches
4986
- # the latest test result for each test case in the draft environment. * "
4987
- # environment IN (e1,e2)" matches any test case results with an environment
4988
- # resource name of either "e1" or "e2". * "test_time > 1602540713" matches any
4989
- # test case results with test time later than a unix timestamp in seconds
4990
- # 1602540713.
4991
4197
  # @param [Fixnum] page_size
4992
- # The maximum number of items to return in a single page. By default 100 and at
4993
- # most 1000.
4994
4198
  # @param [String] page_token
4995
- # The next_page_token value returned from a previous list request.
4996
4199
  # @param [String] fields
4997
4200
  # Selector specifying which fields to include in a partial response.
4998
4201
  # @param [String] quota_user
@@ -5023,10 +4226,8 @@ module Google
5023
4226
  execute_or_queue_command(command, &block)
5024
4227
  end
5025
4228
 
5026
- # Creates a Tool in the specified agent.
4229
+ #
5027
4230
  # @param [String] parent
5028
- # Required. The agent to create a Tool for. Format: `projects//locations//agents/
5029
- # `.
5030
4231
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] google_cloud_dialogflow_cx_v3beta1_tool_object
5031
4232
  # @param [String] fields
5032
4233
  # Selector specifying which fields to include in a partial response.
@@ -5057,15 +4258,9 @@ module Google
5057
4258
  execute_or_queue_command(command, &block)
5058
4259
  end
5059
4260
 
5060
- # Deletes a specified Tool.
4261
+ #
5061
4262
  # @param [String] name
5062
- # Required. The name of the Tool to be deleted. Format: `projects//locations//
5063
- # agents//tools/`.
5064
4263
  # @param [Boolean] force
5065
- # This field has no effect for Tools not being used. For Tools that are used: *
5066
- # If `force` is set to false, an error will be returned with message indicating
5067
- # the referenced resources. * If `force` is set to true, Dialogflow will remove
5068
- # the tool, as well as any references to the tool.
5069
4264
  # @param [String] fields
5070
4265
  # Selector specifying which fields to include in a partial response.
5071
4266
  # @param [String] quota_user
@@ -5094,10 +4289,8 @@ module Google
5094
4289
  execute_or_queue_command(command, &block)
5095
4290
  end
5096
4291
 
5097
- # Exports the selected tools.
4292
+ #
5098
4293
  # @param [String] parent
5099
- # Required. The agent to export tools from. Format: `projects//locations//agents/
5100
- # `.
5101
4294
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportToolsRequest] google_cloud_dialogflow_cx_v3beta1_export_tools_request_object
5102
4295
  # @param [String] fields
5103
4296
  # Selector specifying which fields to include in a partial response.
@@ -5128,9 +4321,8 @@ module Google
5128
4321
  execute_or_queue_command(command, &block)
5129
4322
  end
5130
4323
 
5131
- # Retrieves the specified Tool.
4324
+ #
5132
4325
  # @param [String] name
5133
- # Required. The name of the Tool. Format: `projects//locations//agents//tools/`.
5134
4326
  # @param [String] fields
5135
4327
  # Selector specifying which fields to include in a partial response.
5136
4328
  # @param [String] quota_user
@@ -5158,15 +4350,10 @@ module Google
5158
4350
  execute_or_queue_command(command, &block)
5159
4351
  end
5160
4352
 
5161
- # Returns a list of Tools in the specified agent.
4353
+ #
5162
4354
  # @param [String] parent
5163
- # Required. The agent to list the Tools from. Format: `projects//locations//
5164
- # agents/`.
5165
4355
  # @param [Fixnum] page_size
5166
- # The maximum number of items to return in a single page. By default 100 and at
5167
- # most 1000.
5168
4356
  # @param [String] page_token
5169
- # The next_page_token value returned from a previous list request.
5170
4357
  # @param [String] fields
5171
4358
  # Selector specifying which fields to include in a partial response.
5172
4359
  # @param [String] quota_user
@@ -5196,14 +4383,10 @@ module Google
5196
4383
  execute_or_queue_command(command, &block)
5197
4384
  end
5198
4385
 
5199
- # Update the specified Tool.
4386
+ #
5200
4387
  # @param [String] name
5201
- # The unique identifier of the Tool. Format: `projects//locations//agents//tools/
5202
- # `.
5203
4388
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] google_cloud_dialogflow_cx_v3beta1_tool_object
5204
4389
  # @param [String] update_mask
5205
- # The mask to control which fields get updated. If the mask is not present, all
5206
- # fields will be updated.
5207
4390
  # @param [String] fields
5208
4391
  # Selector specifying which fields to include in a partial response.
5209
4392
  # @param [String] quota_user
@@ -5234,10 +4417,8 @@ module Google
5234
4417
  execute_or_queue_command(command, &block)
5235
4418
  end
5236
4419
 
5237
- # Creates a version for the specified Tool.
4420
+ #
5238
4421
  # @param [String] parent
5239
- # Required. The tool to create a version for. Format: `projects//locations//
5240
- # agents//tools/`.
5241
4422
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolVersion] google_cloud_dialogflow_cx_v3beta1_tool_version_object
5242
4423
  # @param [String] fields
5243
4424
  # Selector specifying which fields to include in a partial response.
@@ -5268,15 +4449,9 @@ module Google
5268
4449
  execute_or_queue_command(command, &block)
5269
4450
  end
5270
4451
 
5271
- # Deletes the specified version of the Tool.
4452
+ #
5272
4453
  # @param [String] name
5273
- # Required. The name of the tool version to delete. Format: `projects//locations/
5274
- # /agents//tools//versions/`.
5275
4454
  # @param [Boolean] force
5276
- # Optional. This field has no effect for Tools not being used. For Tools that
5277
- # are used: * If `force` is set to false, an error will be returned with message
5278
- # indicating the referenced resources. * If `force` is set to true, Dialogflow
5279
- # will remove the tool, as well as any references to the tool.
5280
4455
  # @param [String] fields
5281
4456
  # Selector specifying which fields to include in a partial response.
5282
4457
  # @param [String] quota_user
@@ -5305,10 +4480,8 @@ module Google
5305
4480
  execute_or_queue_command(command, &block)
5306
4481
  end
5307
4482
 
5308
- # Retrieves the specified version of the Tool.
4483
+ #
5309
4484
  # @param [String] name
5310
- # Required. The name of the tool version. Format: `projects//locations//agents//
5311
- # tools//versions/`.
5312
4485
  # @param [String] fields
5313
4486
  # Selector specifying which fields to include in a partial response.
5314
4487
  # @param [String] quota_user
@@ -5336,15 +4509,10 @@ module Google
5336
4509
  execute_or_queue_command(command, &block)
5337
4510
  end
5338
4511
 
5339
- # List versions of the specified Tool.
4512
+ #
5340
4513
  # @param [String] parent
5341
- # Required. The parent of the tool versions. Format: `projects//locations//
5342
- # agents//tools/`.
5343
4514
  # @param [Fixnum] page_size
5344
- # Optional. The maximum number of items to return in a single page. By default
5345
- # 100 and at most 1000.
5346
4515
  # @param [String] page_token
5347
- # Optional. The next_page_token value returned from a previous list request.
5348
4516
  # @param [String] fields
5349
4517
  # Selector specifying which fields to include in a partial response.
5350
4518
  # @param [String] quota_user
@@ -5374,11 +4542,8 @@ module Google
5374
4542
  execute_or_queue_command(command, &block)
5375
4543
  end
5376
4544
 
5377
- # Retrieves the specified version of the Tool and stores it as the current tool
5378
- # draft, returning the tool with resources updated.
4545
+ #
5379
4546
  # @param [String] name
5380
- # Required. The name of the tool version. Format: `projects//locations//agents//
5381
- # tools//versions/`.
5382
4547
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest] google_cloud_dialogflow_cx_v3beta1_restore_tool_version_request_object
5383
4548
  # @param [String] fields
5384
4549
  # Selector specifying which fields to include in a partial response.
@@ -5409,21 +4574,10 @@ module Google
5409
4574
  execute_or_queue_command(command, &block)
5410
4575
  end
5411
4576
 
5412
- # Creates an TransitionRouteGroup in the specified flow. Note: You should always
5413
- # train a flow prior to sending it queries. See the [training documentation](
5414
- # https://cloud.google.com/dialogflow/cx/docs/concept/training).
4577
+ #
5415
4578
  # @param [String] parent
5416
- # Required. The flow to create an TransitionRouteGroup for. Format: `projects//
5417
- # locations//agents//flows/` or `projects//locations//agents/` for agent-level
5418
- # groups.
5419
4579
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup] google_cloud_dialogflow_cx_v3beta1_transition_route_group_object
5420
4580
  # @param [String] language_code
5421
- # The language of the following fields in `TransitionRouteGroup`: * `
5422
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `
5423
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
5424
- # If not specified, the agent's default language is used. [Many languages](https:
5425
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
5426
- # languages must be enabled in the agent before they can be used.
5427
4581
  # @param [String] fields
5428
4582
  # Selector specifying which fields to include in a partial response.
5429
4583
  # @param [String] quota_user
@@ -5454,19 +4608,9 @@ module Google
5454
4608
  execute_or_queue_command(command, &block)
5455
4609
  end
5456
4610
 
5457
- # Deletes the specified TransitionRouteGroup. Note: You should always train a
5458
- # flow prior to sending it queries. See the [training documentation](https://
5459
- # cloud.google.com/dialogflow/cx/docs/concept/training).
4611
+ #
5460
4612
  # @param [String] name
5461
- # Required. The name of the TransitionRouteGroup to delete. Format: `projects//
5462
- # locations//agents//flows//transitionRouteGroups/` or `projects//locations//
5463
- # agents//transitionRouteGroups/`.
5464
4613
  # @param [Boolean] force
5465
- # This field has no effect for transition route group that no page is using. If
5466
- # the transition route group is referenced by any page: * If `force` is set to
5467
- # false, an error will be returned with message indicating pages that reference
5468
- # the transition route group. * If `force` is set to true, Dialogflow will
5469
- # remove the transition route group, as well as any reference to it.
5470
4614
  # @param [String] fields
5471
4615
  # Selector specifying which fields to include in a partial response.
5472
4616
  # @param [String] quota_user
@@ -5495,19 +4639,9 @@ module Google
5495
4639
  execute_or_queue_command(command, &block)
5496
4640
  end
5497
4641
 
5498
- # Retrieves the specified TransitionRouteGroup.
4642
+ #
5499
4643
  # @param [String] name
5500
- # Required. The name of the TransitionRouteGroup. Format: `projects//locations//
5501
- # agents//flows//transitionRouteGroups/` or `projects//locations//agents//
5502
- # transitionRouteGroups/`.
5503
4644
  # @param [String] language_code
5504
- # The language to retrieve the transition route group for. The following fields
5505
- # are language dependent: * `TransitionRouteGroup.transition_routes.
5506
- # trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.
5507
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
5508
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
5509
- # reference/language) are supported. Note: languages must be enabled in the
5510
- # agent before they can be used.
5511
4645
  # @param [String] fields
5512
4646
  # Selector specifying which fields to include in a partial response.
5513
4647
  # @param [String] quota_user
@@ -5536,23 +4670,11 @@ module Google
5536
4670
  execute_or_queue_command(command, &block)
5537
4671
  end
5538
4672
 
5539
- # Returns the list of all transition route groups in the specified flow.
4673
+ #
5540
4674
  # @param [String] parent
5541
- # Required. The flow to list all transition route groups for. Format: `projects//
5542
- # locations//agents//flows/` or `projects//locations//agents/.
5543
4675
  # @param [String] language_code
5544
- # The language to list transition route groups for. The following fields are
5545
- # language dependent: * `TransitionRouteGroup.transition_routes.
5546
- # trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.
5547
- # trigger_fulfillment.conditional_cases` If not specified, the agent's default
5548
- # language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/
5549
- # reference/language) are supported. Note: languages must be enabled in the
5550
- # agent before they can be used.
5551
4676
  # @param [Fixnum] page_size
5552
- # The maximum number of items to return in a single page. By default 100 and at
5553
- # most 1000.
5554
4677
  # @param [String] page_token
5555
- # The next_page_token value returned from a previous list request.
5556
4678
  # @param [String] fields
5557
4679
  # Selector specifying which fields to include in a partial response.
5558
4680
  # @param [String] quota_user
@@ -5583,24 +4705,11 @@ module Google
5583
4705
  execute_or_queue_command(command, &block)
5584
4706
  end
5585
4707
 
5586
- # Updates the specified TransitionRouteGroup. Note: You should always train a
5587
- # flow prior to sending it queries. See the [training documentation](https://
5588
- # cloud.google.com/dialogflow/cx/docs/concept/training).
4708
+ #
5589
4709
  # @param [String] name
5590
- # The unique identifier of the transition route group. TransitionRouteGroups.
5591
- # CreateTransitionRouteGroup populates the name automatically. Format: `projects/
5592
- # /locations//agents//flows//transitionRouteGroups/` or `projects//locations//
5593
- # agents//transitionRouteGroups/` for agent-level groups.
5594
4710
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup] google_cloud_dialogflow_cx_v3beta1_transition_route_group_object
5595
4711
  # @param [String] language_code
5596
- # The language of the following fields in `TransitionRouteGroup`: * `
5597
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `
5598
- # TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
5599
- # If not specified, the agent's default language is used. [Many languages](https:
5600
- # //cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note:
5601
- # languages must be enabled in the agent before they can be used.
5602
4712
  # @param [String] update_mask
5603
- # The mask to control which fields get updated.
5604
4713
  # @param [String] fields
5605
4714
  # Selector specifying which fields to include in a partial response.
5606
4715
  # @param [String] quota_user
@@ -5632,10 +4741,8 @@ module Google
5632
4741
  execute_or_queue_command(command, &block)
5633
4742
  end
5634
4743
 
5635
- # Creates a webhook in the specified agent.
4744
+ #
5636
4745
  # @param [String] parent
5637
- # Required. The agent to create a webhook for. Format: `projects//locations//
5638
- # agents/`.
5639
4746
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook] google_cloud_dialogflow_cx_v3beta1_webhook_object
5640
4747
  # @param [String] fields
5641
4748
  # Selector specifying which fields to include in a partial response.
@@ -5666,17 +4773,9 @@ module Google
5666
4773
  execute_or_queue_command(command, &block)
5667
4774
  end
5668
4775
 
5669
- # Deletes the specified webhook.
4776
+ #
5670
4777
  # @param [String] name
5671
- # Required. The name of the webhook to delete. Format: `projects//locations//
5672
- # agents//webhooks/`.
5673
4778
  # @param [Boolean] force
5674
- # This field has no effect for webhook not being used. For webhooks that are
5675
- # used by pages/flows/transition route groups: * If `force` is set to false, an
5676
- # error will be returned with message indicating the referenced resources. * If `
5677
- # force` is set to true, Dialogflow will remove the webhook, as well as any
5678
- # references to the webhook (i.e. Webhook and tagin fulfillments that point to
5679
- # this webhook will be removed).
5680
4779
  # @param [String] fields
5681
4780
  # Selector specifying which fields to include in a partial response.
5682
4781
  # @param [String] quota_user
@@ -5705,10 +4804,8 @@ module Google
5705
4804
  execute_or_queue_command(command, &block)
5706
4805
  end
5707
4806
 
5708
- # Retrieves the specified webhook.
4807
+ #
5709
4808
  # @param [String] name
5710
- # Required. The name of the webhook. Format: `projects//locations//agents//
5711
- # webhooks/`.
5712
4809
  # @param [String] fields
5713
4810
  # Selector specifying which fields to include in a partial response.
5714
4811
  # @param [String] quota_user
@@ -5736,15 +4833,10 @@ module Google
5736
4833
  execute_or_queue_command(command, &block)
5737
4834
  end
5738
4835
 
5739
- # Returns the list of all webhooks in the specified agent.
4836
+ #
5740
4837
  # @param [String] parent
5741
- # Required. The agent to list all webhooks for. Format: `projects//locations//
5742
- # agents/`.
5743
4838
  # @param [Fixnum] page_size
5744
- # The maximum number of items to return in a single page. By default 100 and at
5745
- # most 1000.
5746
4839
  # @param [String] page_token
5747
- # The next_page_token value returned from a previous list request.
5748
4840
  # @param [String] fields
5749
4841
  # Selector specifying which fields to include in a partial response.
5750
4842
  # @param [String] quota_user
@@ -5774,15 +4866,10 @@ module Google
5774
4866
  execute_or_queue_command(command, &block)
5775
4867
  end
5776
4868
 
5777
- # Updates the specified webhook.
4869
+ #
5778
4870
  # @param [String] name
5779
- # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook
5780
- # method. Webhooks.CreateWebhook populates the name automatically. Format: `
5781
- # projects//locations//agents//webhooks/`.
5782
4871
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook] google_cloud_dialogflow_cx_v3beta1_webhook_object
5783
4872
  # @param [String] update_mask
5784
- # The mask to control which fields get updated. If the mask is not present, all
5785
- # fields will be updated.
5786
4873
  # @param [String] fields
5787
4874
  # Selector specifying which fields to include in a partial response.
5788
4875
  # @param [String] quota_user
@@ -5813,16 +4900,8 @@ module Google
5813
4900
  execute_or_queue_command(command, &block)
5814
4901
  end
5815
4902
 
5816
- # Starts asynchronous cancellation on a long-running operation. The server makes
5817
- # a best effort to cancel the operation, but success is not guaranteed. If the
5818
- # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
5819
- # Clients can use Operations.GetOperation or other methods to check whether the
5820
- # cancellation succeeded or whether the operation completed despite cancellation.
5821
- # On successful cancellation, the operation is not deleted; instead, it becomes
5822
- # an operation with an Operation.error value with a google.rpc.Status.code of `1`
5823
- # , corresponding to `Code.CANCELLED`.
4903
+ #
5824
4904
  # @param [String] name
5825
- # The name of the operation resource to be cancelled.
5826
4905
  # @param [String] fields
5827
4906
  # Selector specifying which fields to include in a partial response.
5828
4907
  # @param [String] quota_user
@@ -5850,10 +4929,8 @@ module Google
5850
4929
  execute_or_queue_command(command, &block)
5851
4930
  end
5852
4931
 
5853
- # Gets the latest state of a long-running operation. Clients can use this method
5854
- # to poll the operation result at intervals as recommended by the API service.
4932
+ #
5855
4933
  # @param [String] name
5856
- # The name of the operation resource.
5857
4934
  # @param [String] fields
5858
4935
  # Selector specifying which fields to include in a partial response.
5859
4936
  # @param [String] quota_user
@@ -5881,23 +4958,12 @@ module Google
5881
4958
  execute_or_queue_command(command, &block)
5882
4959
  end
5883
4960
 
5884
- # Lists operations that match the specified filter in the request. If the server
5885
- # doesn't support this method, it returns `UNIMPLEMENTED`.
4961
+ #
5886
4962
  # @param [String] name
5887
- # The name of the operation's parent resource.
5888
4963
  # @param [String] filter
5889
- # The standard list filter.
5890
4964
  # @param [Fixnum] page_size
5891
- # The standard list page size.
5892
4965
  # @param [String] page_token
5893
- # The standard list page token.
5894
4966
  # @param [Boolean] return_partial_success
5895
- # When set to `true`, operations that are reachable are returned as normal, and
5896
- # those that are unreachable are returned in the [ListOperationsResponse.
5897
- # unreachable] field. This can only be `true` when reading across collections e.
5898
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
5899
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
5900
- # explicitly documented otherwise in service or product specific documentation.
5901
4967
  # @param [String] fields
5902
4968
  # Selector specifying which fields to include in a partial response.
5903
4969
  # @param [String] quota_user
@@ -5929,10 +4995,8 @@ module Google
5929
4995
  execute_or_queue_command(command, &block)
5930
4996
  end
5931
4997
 
5932
- # Create security settings in the specified location.
4998
+ #
5933
4999
  # @param [String] parent
5934
- # Required. The location to create an SecuritySettings for. Format: `projects//
5935
- # locations/`.
5936
5000
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings] google_cloud_dialogflow_cx_v3beta1_security_settings_object
5937
5001
  # @param [String] fields
5938
5002
  # Selector specifying which fields to include in a partial response.
@@ -5963,10 +5027,8 @@ module Google
5963
5027
  execute_or_queue_command(command, &block)
5964
5028
  end
5965
5029
 
5966
- # Deletes the specified SecuritySettings.
5030
+ #
5967
5031
  # @param [String] name
5968
- # Required. The name of the SecuritySettings to delete. Format: `projects//
5969
- # locations//securitySettings/`.
5970
5032
  # @param [String] fields
5971
5033
  # Selector specifying which fields to include in a partial response.
5972
5034
  # @param [String] quota_user
@@ -5994,11 +5056,8 @@ module Google
5994
5056
  execute_or_queue_command(command, &block)
5995
5057
  end
5996
5058
 
5997
- # Retrieves the specified SecuritySettings. The returned settings may be stale
5998
- # by up to 1 minute.
5059
+ #
5999
5060
  # @param [String] name
6000
- # Required. Resource name of the settings. Format: `projects//locations//
6001
- # securitySettings/`.
6002
5061
  # @param [String] fields
6003
5062
  # Selector specifying which fields to include in a partial response.
6004
5063
  # @param [String] quota_user
@@ -6026,15 +5085,10 @@ module Google
6026
5085
  execute_or_queue_command(command, &block)
6027
5086
  end
6028
5087
 
6029
- # Returns the list of all security settings in the specified location.
5088
+ #
6030
5089
  # @param [String] parent
6031
- # Required. The location to list all security settings for. Format: `projects//
6032
- # locations/`.
6033
5090
  # @param [Fixnum] page_size
6034
- # The maximum number of items to return in a single page. By default 20 and at
6035
- # most 100.
6036
5091
  # @param [String] page_token
6037
- # The next_page_token value returned from a previous list request.
6038
5092
  # @param [String] fields
6039
5093
  # Selector specifying which fields to include in a partial response.
6040
5094
  # @param [String] quota_user
@@ -6064,16 +5118,10 @@ module Google
6064
5118
  execute_or_queue_command(command, &block)
6065
5119
  end
6066
5120
 
6067
- # Updates the specified SecuritySettings.
5121
+ #
6068
5122
  # @param [String] name
6069
- # Resource name of the settings. Required for the SecuritySettingsService.
6070
- # UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings
6071
- # populates the name automatically. Format: `projects//locations//
6072
- # securitySettings/`.
6073
5123
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings] google_cloud_dialogflow_cx_v3beta1_security_settings_object
6074
5124
  # @param [String] update_mask
6075
- # Required. The mask to control which fields get updated. If the mask is not
6076
- # present, all fields will be updated.
6077
5125
  # @param [String] fields
6078
5126
  # Selector specifying which fields to include in a partial response.
6079
5127
  # @param [String] quota_user
@@ -6104,16 +5152,8 @@ module Google
6104
5152
  execute_or_queue_command(command, &block)
6105
5153
  end
6106
5154
 
6107
- # Starts asynchronous cancellation on a long-running operation. The server makes
6108
- # a best effort to cancel the operation, but success is not guaranteed. If the
6109
- # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
6110
- # Clients can use Operations.GetOperation or other methods to check whether the
6111
- # cancellation succeeded or whether the operation completed despite cancellation.
6112
- # On successful cancellation, the operation is not deleted; instead, it becomes
6113
- # an operation with an Operation.error value with a google.rpc.Status.code of `1`
6114
- # , corresponding to `Code.CANCELLED`.
5155
+ #
6115
5156
  # @param [String] name
6116
- # The name of the operation resource to be cancelled.
6117
5157
  # @param [String] fields
6118
5158
  # Selector specifying which fields to include in a partial response.
6119
5159
  # @param [String] quota_user
@@ -6141,10 +5181,8 @@ module Google
6141
5181
  execute_or_queue_command(command, &block)
6142
5182
  end
6143
5183
 
6144
- # Gets the latest state of a long-running operation. Clients can use this method
6145
- # to poll the operation result at intervals as recommended by the API service.
5184
+ #
6146
5185
  # @param [String] name
6147
- # The name of the operation resource.
6148
5186
  # @param [String] fields
6149
5187
  # Selector specifying which fields to include in a partial response.
6150
5188
  # @param [String] quota_user
@@ -6172,23 +5210,12 @@ module Google
6172
5210
  execute_or_queue_command(command, &block)
6173
5211
  end
6174
5212
 
6175
- # Lists operations that match the specified filter in the request. If the server
6176
- # doesn't support this method, it returns `UNIMPLEMENTED`.
5213
+ #
6177
5214
  # @param [String] name
6178
- # The name of the operation's parent resource.
6179
5215
  # @param [String] filter
6180
- # The standard list filter.
6181
5216
  # @param [Fixnum] page_size
6182
- # The standard list page size.
6183
5217
  # @param [String] page_token
6184
- # The standard list page token.
6185
5218
  # @param [Boolean] return_partial_success
6186
- # When set to `true`, operations that are reachable are returned as normal, and
6187
- # those that are unreachable are returned in the [ListOperationsResponse.
6188
- # unreachable] field. This can only be `true` when reading across collections e.
6189
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
6190
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
6191
- # explicitly documented otherwise in service or product specific documentation.
6192
5219
  # @param [String] fields
6193
5220
  # Selector specifying which fields to include in a partial response.
6194
5221
  # @param [String] quota_user