google-apis-dialogflow_v3 0.19.0 → 0.23.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.
@@ -367,6 +367,123 @@ module Google
367
367
  end
368
368
  end
369
369
 
370
+ # Changelogs represents a change made to a given agent.
371
+ class GoogleCloudDialogflowCxV3Changelog
372
+ include Google::Apis::Core::Hashable
373
+
374
+ # The action of the change.
375
+ # Corresponds to the JSON property `action`
376
+ # @return [String]
377
+ attr_accessor :action
378
+
379
+ # The timestamp of the change.
380
+ # Corresponds to the JSON property `createTime`
381
+ # @return [String]
382
+ attr_accessor :create_time
383
+
384
+ # The affected resource display name of the change.
385
+ # Corresponds to the JSON property `displayName`
386
+ # @return [String]
387
+ attr_accessor :display_name
388
+
389
+ # The unique identifier of the changelog. Format: `projects//locations//agents//
390
+ # changelogs/`.
391
+ # Corresponds to the JSON property `name`
392
+ # @return [String]
393
+ attr_accessor :name
394
+
395
+ # The affected resource name of the change.
396
+ # Corresponds to the JSON property `resource`
397
+ # @return [String]
398
+ attr_accessor :resource
399
+
400
+ # The affected resource type.
401
+ # Corresponds to the JSON property `type`
402
+ # @return [String]
403
+ attr_accessor :type
404
+
405
+ # Email address of the authenticated user.
406
+ # Corresponds to the JSON property `userEmail`
407
+ # @return [String]
408
+ attr_accessor :user_email
409
+
410
+ def initialize(**args)
411
+ update!(**args)
412
+ end
413
+
414
+ # Update properties of this object
415
+ def update!(**args)
416
+ @action = args[:action] if args.key?(:action)
417
+ @create_time = args[:create_time] if args.key?(:create_time)
418
+ @display_name = args[:display_name] if args.key?(:display_name)
419
+ @name = args[:name] if args.key?(:name)
420
+ @resource = args[:resource] if args.key?(:resource)
421
+ @type = args[:type] if args.key?(:type)
422
+ @user_email = args[:user_email] if args.key?(:user_email)
423
+ end
424
+ end
425
+
426
+ # The request message for Versions.CompareVersions.
427
+ class GoogleCloudDialogflowCxV3CompareVersionsRequest
428
+ include Google::Apis::Core::Hashable
429
+
430
+ # The language to compare the flow versions for. If not specified, the agent's
431
+ # default language is used. [Many languages](https://cloud.google.com/dialogflow/
432
+ # docs/reference/language) are supported. Note: languages must be enabled in the
433
+ # agent before they can be used.
434
+ # Corresponds to the JSON property `languageCode`
435
+ # @return [String]
436
+ attr_accessor :language_code
437
+
438
+ # Required. Name of the target flow version to compare with the base version.
439
+ # Use version ID `0` to indicate the draft version of the specified flow. Format:
440
+ # `projects//locations//agents//flows//versions/`.
441
+ # Corresponds to the JSON property `targetVersion`
442
+ # @return [String]
443
+ attr_accessor :target_version
444
+
445
+ def initialize(**args)
446
+ update!(**args)
447
+ end
448
+
449
+ # Update properties of this object
450
+ def update!(**args)
451
+ @language_code = args[:language_code] if args.key?(:language_code)
452
+ @target_version = args[:target_version] if args.key?(:target_version)
453
+ end
454
+ end
455
+
456
+ # The response message for Versions.CompareVersions.
457
+ class GoogleCloudDialogflowCxV3CompareVersionsResponse
458
+ include Google::Apis::Core::Hashable
459
+
460
+ # JSON representation of the base version content.
461
+ # Corresponds to the JSON property `baseVersionContentJson`
462
+ # @return [String]
463
+ attr_accessor :base_version_content_json
464
+
465
+ # The timestamp when the two version compares.
466
+ # Corresponds to the JSON property `compareTime`
467
+ # @return [String]
468
+ attr_accessor :compare_time
469
+
470
+ # JSON representation of the target version content.
471
+ # Corresponds to the JSON property `targetVersionContentJson`
472
+ # @return [String]
473
+ attr_accessor :target_version_content_json
474
+
475
+ def initialize(**args)
476
+ update!(**args)
477
+ end
478
+
479
+ # Update properties of this object
480
+ def update!(**args)
481
+ @base_version_content_json = args[:base_version_content_json] if args.key?(:base_version_content_json)
482
+ @compare_time = args[:compare_time] if args.key?(:compare_time)
483
+ @target_version_content_json = args[:target_version_content_json] if args.key?(:target_version_content_json)
484
+ end
485
+ end
486
+
370
487
  # Represents a result from running a test case in an agent environment.
371
488
  class GoogleCloudDialogflowCxV3ContinuousTestResult
372
489
  include Google::Apis::Core::Hashable
@@ -496,7 +613,8 @@ module Google
496
613
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page]
497
614
  attr_accessor :current_page
498
615
 
499
- # Required. Input only. The diagnostic info output for the turn.
616
+ # Required. Input only. The diagnostic info output for the turn. Required to
617
+ # calculate the testing coverage.
500
618
  # Corresponds to the JSON property `diagnosticInfo`
501
619
  # @return [Hash<String,Object>]
502
620
  attr_accessor :diagnostic_info
@@ -609,6 +727,158 @@ module Google
609
727
  end
610
728
  end
611
729
 
730
+ # Metadata returned for the Environments.DeployFlow long running operation.
731
+ class GoogleCloudDialogflowCxV3DeployFlowMetadata
732
+ include Google::Apis::Core::Hashable
733
+
734
+ # Errors of running deployment tests.
735
+ # Corresponds to the JSON property `testErrors`
736
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestError>]
737
+ attr_accessor :test_errors
738
+
739
+ def initialize(**args)
740
+ update!(**args)
741
+ end
742
+
743
+ # Update properties of this object
744
+ def update!(**args)
745
+ @test_errors = args[:test_errors] if args.key?(:test_errors)
746
+ end
747
+ end
748
+
749
+ # The request message for Environments.DeployFlow.
750
+ class GoogleCloudDialogflowCxV3DeployFlowRequest
751
+ include Google::Apis::Core::Hashable
752
+
753
+ # Required. The flow version to deploy. Format: `projects//locations//agents//
754
+ # flows//versions/`.
755
+ # Corresponds to the JSON property `flowVersion`
756
+ # @return [String]
757
+ attr_accessor :flow_version
758
+
759
+ def initialize(**args)
760
+ update!(**args)
761
+ end
762
+
763
+ # Update properties of this object
764
+ def update!(**args)
765
+ @flow_version = args[:flow_version] if args.key?(:flow_version)
766
+ end
767
+ end
768
+
769
+ # The response message for Environments.DeployFlow.
770
+ class GoogleCloudDialogflowCxV3DeployFlowResponse
771
+ include Google::Apis::Core::Hashable
772
+
773
+ # The name of the flow version Deployment. Format: `projects//locations//agents//
774
+ # environments//deployments/`.
775
+ # Corresponds to the JSON property `deployment`
776
+ # @return [String]
777
+ attr_accessor :deployment
778
+
779
+ # Represents an environment for an agent. You can create multiple versions of
780
+ # your agent and publish them to separate environments. When you edit an agent,
781
+ # you are editing the draft agent. At any point, you can save the draft agent as
782
+ # an agent version, which is an immutable snapshot of your agent. When you save
783
+ # the draft agent, it is published to the default environment. When you create
784
+ # agent versions, you can publish them to custom environments. You can create a
785
+ # variety of custom environments for testing, development, production, etc.
786
+ # Corresponds to the JSON property `environment`
787
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment]
788
+ attr_accessor :environment
789
+
790
+ def initialize(**args)
791
+ update!(**args)
792
+ end
793
+
794
+ # Update properties of this object
795
+ def update!(**args)
796
+ @deployment = args[:deployment] if args.key?(:deployment)
797
+ @environment = args[:environment] if args.key?(:environment)
798
+ end
799
+ end
800
+
801
+ # Represents an deployment in an environment. A deployment happens when a flow
802
+ # version configured to be active in the environment. You can configure running
803
+ # pre-deployment steps, e.g. running validation test cases, experiment auto-
804
+ # rollout, etc.
805
+ class GoogleCloudDialogflowCxV3Deployment
806
+ include Google::Apis::Core::Hashable
807
+
808
+ # End time of this deployment.
809
+ # Corresponds to the JSON property `endTime`
810
+ # @return [String]
811
+ attr_accessor :end_time
812
+
813
+ # The name of the flow version for this deployment. Format: projects//locations//
814
+ # agents//flows//versions/.
815
+ # Corresponds to the JSON property `flowVersion`
816
+ # @return [String]
817
+ attr_accessor :flow_version
818
+
819
+ # The name of the deployment. Format: projects//locations//agents//environments//
820
+ # deployments/.
821
+ # Corresponds to the JSON property `name`
822
+ # @return [String]
823
+ attr_accessor :name
824
+
825
+ # Result of the deployment.
826
+ # Corresponds to the JSON property `result`
827
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DeploymentResult]
828
+ attr_accessor :result
829
+
830
+ # Start time of this deployment.
831
+ # Corresponds to the JSON property `startTime`
832
+ # @return [String]
833
+ attr_accessor :start_time
834
+
835
+ # The current state of the deployment.
836
+ # Corresponds to the JSON property `state`
837
+ # @return [String]
838
+ attr_accessor :state
839
+
840
+ def initialize(**args)
841
+ update!(**args)
842
+ end
843
+
844
+ # Update properties of this object
845
+ def update!(**args)
846
+ @end_time = args[:end_time] if args.key?(:end_time)
847
+ @flow_version = args[:flow_version] if args.key?(:flow_version)
848
+ @name = args[:name] if args.key?(:name)
849
+ @result = args[:result] if args.key?(:result)
850
+ @start_time = args[:start_time] if args.key?(:start_time)
851
+ @state = args[:state] if args.key?(:state)
852
+ end
853
+ end
854
+
855
+ # Result of the deployment.
856
+ class GoogleCloudDialogflowCxV3DeploymentResult
857
+ include Google::Apis::Core::Hashable
858
+
859
+ # Results of test cases running before the deployment. Format: `projects//
860
+ # locations//agents//testCases//results/`.
861
+ # Corresponds to the JSON property `deploymentTestResults`
862
+ # @return [Array<String>]
863
+ attr_accessor :deployment_test_results
864
+
865
+ # The name of the experiment triggered by this deployment. Format: projects//
866
+ # locations//agents//environments//experiments/.
867
+ # Corresponds to the JSON property `experiment`
868
+ # @return [String]
869
+ attr_accessor :experiment
870
+
871
+ def initialize(**args)
872
+ update!(**args)
873
+ end
874
+
875
+ # Update properties of this object
876
+ def update!(**args)
877
+ @deployment_test_results = args[:deployment_test_results] if args.key?(:deployment_test_results)
878
+ @experiment = args[:experiment] if args.key?(:experiment)
879
+ end
880
+ end
881
+
612
882
  # The request to detect user's intent.
613
883
  class GoogleCloudDialogflowCxV3DetectIntentRequest
614
884
  include Google::Apis::Core::Hashable
@@ -895,6 +1165,11 @@ module Google
895
1165
  # @return [String]
896
1166
  attr_accessor :name
897
1167
 
1168
+ # The configuration for continuous tests.
1169
+ # Corresponds to the JSON property `testCasesConfig`
1170
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig]
1171
+ attr_accessor :test_cases_config
1172
+
898
1173
  # Output only. Update time of this environment.
899
1174
  # Corresponds to the JSON property `updateTime`
900
1175
  # @return [String]
@@ -916,11 +1191,48 @@ module Google
916
1191
  @description = args[:description] if args.key?(:description)
917
1192
  @display_name = args[:display_name] if args.key?(:display_name)
918
1193
  @name = args[:name] if args.key?(:name)
1194
+ @test_cases_config = args[:test_cases_config] if args.key?(:test_cases_config)
919
1195
  @update_time = args[:update_time] if args.key?(:update_time)
920
1196
  @version_configs = args[:version_configs] if args.key?(:version_configs)
921
1197
  end
922
1198
  end
923
1199
 
1200
+ # The configuration for continuous tests.
1201
+ class GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig
1202
+ include Google::Apis::Core::Hashable
1203
+
1204
+ # Whether to run test cases in TestCasesConfig.test_cases periodically. Default
1205
+ # false. If set to ture, run once a day.
1206
+ # Corresponds to the JSON property `enableContinuousRun`
1207
+ # @return [Boolean]
1208
+ attr_accessor :enable_continuous_run
1209
+ alias_method :enable_continuous_run?, :enable_continuous_run
1210
+
1211
+ # Whether to run test cases in TestCasesConfig.test_cases before deploying a
1212
+ # flow version to the environment. Default false.
1213
+ # Corresponds to the JSON property `enablePredeploymentRun`
1214
+ # @return [Boolean]
1215
+ attr_accessor :enable_predeployment_run
1216
+ alias_method :enable_predeployment_run?, :enable_predeployment_run
1217
+
1218
+ # A list of test case names to run. They should be under the same agent. Format
1219
+ # of each test case name: `projects//locations/ /agents//testCases/`
1220
+ # Corresponds to the JSON property `testCases`
1221
+ # @return [Array<String>]
1222
+ attr_accessor :test_cases
1223
+
1224
+ def initialize(**args)
1225
+ update!(**args)
1226
+ end
1227
+
1228
+ # Update properties of this object
1229
+ def update!(**args)
1230
+ @enable_continuous_run = args[:enable_continuous_run] if args.key?(:enable_continuous_run)
1231
+ @enable_predeployment_run = args[:enable_predeployment_run] if args.key?(:enable_predeployment_run)
1232
+ @test_cases = args[:test_cases] if args.key?(:test_cases)
1233
+ end
1234
+ end
1235
+
924
1236
  # Configuration for the version.
925
1237
  class GoogleCloudDialogflowCxV3EnvironmentVersionConfig
926
1238
  include Google::Apis::Core::Hashable
@@ -1045,11 +1357,9 @@ module Google
1045
1357
  # @return [String]
1046
1358
  attr_accessor :end_time
1047
1359
 
1048
- # LINT.IfChange(default_experiment_length) Maximum number of days to run the
1049
- # experiment/rollout. If auto-rollout is not enabled, default value and maximum
1050
- # will be 30 days. If auto-rollout is enabled, default value and maximum will be
1051
- # 6 days. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/
1052
- # compute.cc:default_experiment_length)
1360
+ # Maximum number of days to run the experiment/rollout. If auto-rollout is not
1361
+ # enabled, default value and maximum will be 30 days. If auto-rollout is enabled,
1362
+ # default value and maximum will be 6 days.
1053
1363
  # Corresponds to the JSON property `experimentLength`
1054
1364
  # @return [String]
1055
1365
  attr_accessor :experiment_length
@@ -1071,6 +1381,22 @@ module Google
1071
1381
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExperimentResult]
1072
1382
  attr_accessor :result
1073
1383
 
1384
+ # The configuration for auto rollout.
1385
+ # Corresponds to the JSON property `rolloutConfig`
1386
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RolloutConfig]
1387
+ attr_accessor :rollout_config
1388
+
1389
+ # The reason why rollout has failed. Should only be set when state is
1390
+ # ROLLOUT_FAILED.
1391
+ # Corresponds to the JSON property `rolloutFailureReason`
1392
+ # @return [String]
1393
+ attr_accessor :rollout_failure_reason
1394
+
1395
+ # State of the auto-rollout process.
1396
+ # Corresponds to the JSON property `rolloutState`
1397
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RolloutState]
1398
+ attr_accessor :rollout_state
1399
+
1074
1400
  # Start time of this experiment.
1075
1401
  # Corresponds to the JSON property `startTime`
1076
1402
  # @return [String]
@@ -1103,6 +1429,9 @@ module Google
1103
1429
  @last_update_time = args[:last_update_time] if args.key?(:last_update_time)
1104
1430
  @name = args[:name] if args.key?(:name)
1105
1431
  @result = args[:result] if args.key?(:result)
1432
+ @rollout_config = args[:rollout_config] if args.key?(:rollout_config)
1433
+ @rollout_failure_reason = args[:rollout_failure_reason] if args.key?(:rollout_failure_reason)
1434
+ @rollout_state = args[:rollout_state] if args.key?(:rollout_state)
1106
1435
  @start_time = args[:start_time] if args.key?(:start_time)
1107
1436
  @state = args[:state] if args.key?(:state)
1108
1437
  @variants_history = args[:variants_history] if args.key?(:variants_history)
@@ -1393,6 +1722,7 @@ module Google
1393
1722
  end
1394
1723
 
1395
1724
  # Metadata returned for the TestCases.ExportTestCases long running operation.
1725
+ # This message currently has no fields.
1396
1726
  class GoogleCloudDialogflowCxV3ExportTestCasesMetadata
1397
1727
  include Google::Apis::Core::Hashable
1398
1728
 
@@ -2527,6 +2857,34 @@ module Google
2527
2857
  end
2528
2858
  end
2529
2859
 
2860
+ # The response message for Changelogs.ListChangelogs.
2861
+ class GoogleCloudDialogflowCxV3ListChangelogsResponse
2862
+ include Google::Apis::Core::Hashable
2863
+
2864
+ # The list of changelogs. There will be a maximum number of items returned based
2865
+ # on the page_size field in the request. The changelogs will be ordered by
2866
+ # timestamp.
2867
+ # Corresponds to the JSON property `changelogs`
2868
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog>]
2869
+ attr_accessor :changelogs
2870
+
2871
+ # Token to retrieve the next page of results, or empty if there are no more
2872
+ # results in the list.
2873
+ # Corresponds to the JSON property `nextPageToken`
2874
+ # @return [String]
2875
+ attr_accessor :next_page_token
2876
+
2877
+ def initialize(**args)
2878
+ update!(**args)
2879
+ end
2880
+
2881
+ # Update properties of this object
2882
+ def update!(**args)
2883
+ @changelogs = args[:changelogs] if args.key?(:changelogs)
2884
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2885
+ end
2886
+ end
2887
+
2530
2888
  # The response message for Environments.ListTestCaseResults.
2531
2889
  class GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse
2532
2890
  include Google::Apis::Core::Hashable
@@ -2553,6 +2911,34 @@ module Google
2553
2911
  end
2554
2912
  end
2555
2913
 
2914
+ # The response message for Deployments.ListDeployments.
2915
+ class GoogleCloudDialogflowCxV3ListDeploymentsResponse
2916
+ include Google::Apis::Core::Hashable
2917
+
2918
+ # The list of deployments. There will be a maximum number of items returned
2919
+ # based on the page_size field in the request. The list may in some cases be
2920
+ # empty or contain fewer entries than page_size even if this isn't the last page.
2921
+ # Corresponds to the JSON property `deployments`
2922
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment>]
2923
+ attr_accessor :deployments
2924
+
2925
+ # Token to retrieve the next page of results, or empty if there are no more
2926
+ # results in the list.
2927
+ # Corresponds to the JSON property `nextPageToken`
2928
+ # @return [String]
2929
+ attr_accessor :next_page_token
2930
+
2931
+ def initialize(**args)
2932
+ update!(**args)
2933
+ end
2934
+
2935
+ # Update properties of this object
2936
+ def update!(**args)
2937
+ @deployments = args[:deployments] if args.key?(:deployments)
2938
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2939
+ end
2940
+ end
2941
+
2556
2942
  # The response message for EntityTypes.ListEntityTypes.
2557
2943
  class GoogleCloudDialogflowCxV3ListEntityTypesResponse
2558
2944
  include Google::Apis::Core::Hashable
@@ -3578,6 +3964,11 @@ module Google
3578
3964
  # @return [Hash<String,Object>]
3579
3965
  attr_accessor :diagnostic_info
3580
3966
 
3967
+ # Represents the input for dtmf event.
3968
+ # Corresponds to the JSON property `dtmf`
3969
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DtmfInput]
3970
+ attr_accessor :dtmf
3971
+
3581
3972
  # An intent represents a user's intent to interact with a conversational agent.
3582
3973
  # You can provide information for the Dialogflow API to use to match user input
3583
3974
  # to an intent by adding training phrases (i.e., examples of user input) to your
@@ -3678,6 +4069,7 @@ module Google
3678
4069
  def update!(**args)
3679
4070
  @current_page = args[:current_page] if args.key?(:current_page)
3680
4071
  @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info)
4072
+ @dtmf = args[:dtmf] if args.key?(:dtmf)
3681
4073
  @intent = args[:intent] if args.key?(:intent)
3682
4074
  @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence)
3683
4075
  @language_code = args[:language_code] if args.key?(:language_code)
@@ -4077,6 +4469,109 @@ module Google
4077
4469
  end
4078
4470
  end
4079
4471
 
4472
+ # The configuration for auto rollout.
4473
+ class GoogleCloudDialogflowCxV3RolloutConfig
4474
+ include Google::Apis::Core::Hashable
4475
+
4476
+ # The conditions that are used to evaluate the failure of a rollout step. If not
4477
+ # specified, no rollout steps will fail. E.g. "containment_rate < 10% OR
4478
+ # average_turn_count < 3". See the [conditions reference](https://cloud.google.
4479
+ # com/dialogflow/cx/docs/reference/condition).
4480
+ # Corresponds to the JSON property `failureCondition`
4481
+ # @return [String]
4482
+ attr_accessor :failure_condition
4483
+
4484
+ # The conditions that are used to evaluate the success of a rollout step. If not
4485
+ # specified, all rollout steps will proceed to the next one unless failure
4486
+ # conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See
4487
+ # the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/
4488
+ # reference/condition).
4489
+ # Corresponds to the JSON property `rolloutCondition`
4490
+ # @return [String]
4491
+ attr_accessor :rollout_condition
4492
+
4493
+ # Steps to roll out a flow version. Steps should be sorted by percentage in
4494
+ # ascending order.
4495
+ # Corresponds to the JSON property `rolloutSteps`
4496
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RolloutConfigRolloutStep>]
4497
+ attr_accessor :rollout_steps
4498
+
4499
+ def initialize(**args)
4500
+ update!(**args)
4501
+ end
4502
+
4503
+ # Update properties of this object
4504
+ def update!(**args)
4505
+ @failure_condition = args[:failure_condition] if args.key?(:failure_condition)
4506
+ @rollout_condition = args[:rollout_condition] if args.key?(:rollout_condition)
4507
+ @rollout_steps = args[:rollout_steps] if args.key?(:rollout_steps)
4508
+ end
4509
+ end
4510
+
4511
+ # A single rollout step with specified traffic allocation.
4512
+ class GoogleCloudDialogflowCxV3RolloutConfigRolloutStep
4513
+ include Google::Apis::Core::Hashable
4514
+
4515
+ # The name of the rollout step;
4516
+ # Corresponds to the JSON property `displayName`
4517
+ # @return [String]
4518
+ attr_accessor :display_name
4519
+
4520
+ # The minimum time that this step should last. Should be longer than 1 hour. If
4521
+ # not set, the default minimum duration for each step will be 1 hour.
4522
+ # Corresponds to the JSON property `minDuration`
4523
+ # @return [String]
4524
+ attr_accessor :min_duration
4525
+
4526
+ # The percentage of traffic allocated to the flow version of this rollout step. (
4527
+ # 0%, 100%].
4528
+ # Corresponds to the JSON property `trafficPercent`
4529
+ # @return [Fixnum]
4530
+ attr_accessor :traffic_percent
4531
+
4532
+ def initialize(**args)
4533
+ update!(**args)
4534
+ end
4535
+
4536
+ # Update properties of this object
4537
+ def update!(**args)
4538
+ @display_name = args[:display_name] if args.key?(:display_name)
4539
+ @min_duration = args[:min_duration] if args.key?(:min_duration)
4540
+ @traffic_percent = args[:traffic_percent] if args.key?(:traffic_percent)
4541
+ end
4542
+ end
4543
+
4544
+ # State of the auto-rollout process.
4545
+ class GoogleCloudDialogflowCxV3RolloutState
4546
+ include Google::Apis::Core::Hashable
4547
+
4548
+ # Start time of the current step.
4549
+ # Corresponds to the JSON property `startTime`
4550
+ # @return [String]
4551
+ attr_accessor :start_time
4552
+
4553
+ # Display name of the current auto rollout step.
4554
+ # Corresponds to the JSON property `step`
4555
+ # @return [String]
4556
+ attr_accessor :step
4557
+
4558
+ # Index of the current step in the auto rollout steps list.
4559
+ # Corresponds to the JSON property `stepIndex`
4560
+ # @return [Fixnum]
4561
+ attr_accessor :step_index
4562
+
4563
+ def initialize(**args)
4564
+ update!(**args)
4565
+ end
4566
+
4567
+ # Update properties of this object
4568
+ def update!(**args)
4569
+ @start_time = args[:start_time] if args.key?(:start_time)
4570
+ @step = args[:step] if args.key?(:step)
4571
+ @step_index = args[:step_index] if args.key?(:step_index)
4572
+ end
4573
+ end
4574
+
4080
4575
  # Metadata returned for the Environments.RunContinuousTest long running
4081
4576
  # operation.
4082
4577
  class GoogleCloudDialogflowCxV3RunContinuousTestMetadata
@@ -4129,7 +4624,8 @@ module Google
4129
4624
  end
4130
4625
  end
4131
4626
 
4132
- # Metadata returned for the TestCases.RunTestCase long running operation.
4627
+ # Metadata returned for the TestCases.RunTestCase long running operation. This
4628
+ # message currently has no fields.
4133
4629
  class GoogleCloudDialogflowCxV3RunTestCaseMetadata
4134
4630
  include Google::Apis::Core::Hashable
4135
4631
 
@@ -4187,6 +4683,20 @@ module Google
4187
4683
  class GoogleCloudDialogflowCxV3SecuritySettings
4188
4684
  include Google::Apis::Core::Hashable
4189
4685
 
4686
+ # [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this
4687
+ # template to define de-identification configuration for the content. The `DLP
4688
+ # De-identify Templates Reader` role is needed on the Dialogflow service
4689
+ # identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-
4690
+ # dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty,
4691
+ # Dialogflow replaces sensitive info with `[redacted]` text. The template name
4692
+ # will have one of the following formats: `projects//locations//
4693
+ # deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note:
4694
+ # `deidentify_template` must be located in the same region as the `
4695
+ # SecuritySettings`.
4696
+ # Corresponds to the JSON property `deidentifyTemplate`
4697
+ # @return [String]
4698
+ attr_accessor :deidentify_template
4699
+
4190
4700
  # Required. The human-readable name of the security settings, unique within the
4191
4701
  # location.
4192
4702
  # Corresponds to the JSON property `displayName`
@@ -4200,15 +4710,20 @@ module Google
4200
4710
  attr_accessor :insights_export_settings
4201
4711
 
4202
4712
  # [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this
4203
- # template to define inspect base settings. If empty, we use the default DLP
4204
- # inspect config. The template name will have one of the following formats: `
4205
- # projects//inspectTemplates/` OR `projects//locations//inspectTemplates/` OR `
4206
- # organizations//inspectTemplates/`
4713
+ # template to define inspect base settings. The `DLP Inspect Templates Reader`
4714
+ # role is needed on the Dialogflow service identity service account (has the
4715
+ # form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for
4716
+ # your agent's project. If empty, we use the default DLP inspect config. The
4717
+ # template name will have one of the following formats: `projects//locations//
4718
+ # inspectTemplates/` OR `organizations//locations//inspectTemplates/` Note: `
4719
+ # inspect_template` must be located in the same region as the `SecuritySettings`.
4207
4720
  # Corresponds to the JSON property `inspectTemplate`
4208
4721
  # @return [String]
4209
4722
  attr_accessor :inspect_template
4210
4723
 
4211
- # Required. Resource name of the settings. Format: `projects//locations//
4724
+ # Resource name of the settings. Required for the SecuritySettingsService.
4725
+ # UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings
4726
+ # populates the name automatically. Format: `projects//locations//
4212
4727
  # securitySettings/`.
4213
4728
  # Corresponds to the JSON property `name`
4214
4729
  # @return [String]
@@ -4232,10 +4747,11 @@ module Google
4232
4747
 
4233
4748
  # Retains data in interaction logging for the specified number of days. This
4234
4749
  # does not apply to Cloud logging, which is owned by the user - not Dialogflow.
4235
- # User must Set a value lower than Dialogflow's default 30d TTL. Setting a value
4236
- # higher than that has no effect. A missing value or setting to 0 also means we
4237
- # use Dialogflow's default TTL. Note: Interaction logging is a limited access
4238
- # feature. Talk to your Google representative to check availability for you.
4750
+ # User must set a value lower than Dialogflow's default 365d TTL. Setting a
4751
+ # value higher than that has no effect. A missing value or setting to 0 also
4752
+ # means we use Dialogflow's default TTL. Note: Interaction logging is a limited
4753
+ # access feature. Talk to your Google representative to check availability for
4754
+ # you.
4239
4755
  # Corresponds to the JSON property `retentionWindowDays`
4240
4756
  # @return [Fixnum]
4241
4757
  attr_accessor :retention_window_days
@@ -4246,6 +4762,7 @@ module Google
4246
4762
 
4247
4763
  # Update properties of this object
4248
4764
  def update!(**args)
4765
+ @deidentify_template = args[:deidentify_template] if args.key?(:deidentify_template)
4249
4766
  @display_name = args[:display_name] if args.key?(:display_name)
4250
4767
  @insights_export_settings = args[:insights_export_settings] if args.key?(:insights_export_settings)
4251
4768
  @inspect_template = args[:inspect_template] if args.key?(:inspect_template)
@@ -5957,7 +6474,8 @@ module Google
5957
6474
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1Page]
5958
6475
  attr_accessor :current_page
5959
6476
 
5960
- # Required. Input only. The diagnostic info output for the turn.
6477
+ # Required. Input only. The diagnostic info output for the turn. Required to
6478
+ # calculate the testing coverage.
5961
6479
  # Corresponds to the JSON property `diagnosticInfo`
5962
6480
  # @return [Hash<String,Object>]
5963
6481
  attr_accessor :diagnostic_info
@@ -6070,6 +6588,57 @@ module Google
6070
6588
  end
6071
6589
  end
6072
6590
 
6591
+ # Metadata returned for the Environments.DeployFlow long running operation.
6592
+ class GoogleCloudDialogflowCxV3beta1DeployFlowMetadata
6593
+ include Google::Apis::Core::Hashable
6594
+
6595
+ # Errors of running deployment tests.
6596
+ # Corresponds to the JSON property `testErrors`
6597
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1TestError>]
6598
+ attr_accessor :test_errors
6599
+
6600
+ def initialize(**args)
6601
+ update!(**args)
6602
+ end
6603
+
6604
+ # Update properties of this object
6605
+ def update!(**args)
6606
+ @test_errors = args[:test_errors] if args.key?(:test_errors)
6607
+ end
6608
+ end
6609
+
6610
+ # The response message for Environments.DeployFlow.
6611
+ class GoogleCloudDialogflowCxV3beta1DeployFlowResponse
6612
+ include Google::Apis::Core::Hashable
6613
+
6614
+ # The name of the flow version deployment. Format: `projects//locations//agents//
6615
+ # environments//deployments/`.
6616
+ # Corresponds to the JSON property `deployment`
6617
+ # @return [String]
6618
+ attr_accessor :deployment
6619
+
6620
+ # Represents an environment for an agent. You can create multiple versions of
6621
+ # your agent and publish them to separate environments. When you edit an agent,
6622
+ # you are editing the draft agent. At any point, you can save the draft agent as
6623
+ # an agent version, which is an immutable snapshot of your agent. When you save
6624
+ # the draft agent, it is published to the default environment. When you create
6625
+ # agent versions, you can publish them to custom environments. You can create a
6626
+ # variety of custom environments for testing, development, production, etc.
6627
+ # Corresponds to the JSON property `environment`
6628
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1Environment]
6629
+ attr_accessor :environment
6630
+
6631
+ def initialize(**args)
6632
+ update!(**args)
6633
+ end
6634
+
6635
+ # Update properties of this object
6636
+ def update!(**args)
6637
+ @deployment = args[:deployment] if args.key?(:deployment)
6638
+ @environment = args[:environment] if args.key?(:environment)
6639
+ end
6640
+ end
6641
+
6073
6642
  # Represents the input for dtmf event.
6074
6643
  class GoogleCloudDialogflowCxV3beta1DtmfInput
6075
6644
  include Google::Apis::Core::Hashable
@@ -6095,6 +6664,121 @@ module Google
6095
6664
  end
6096
6665
  end
6097
6666
 
6667
+ # Represents an environment for an agent. You can create multiple versions of
6668
+ # your agent and publish them to separate environments. When you edit an agent,
6669
+ # you are editing the draft agent. At any point, you can save the draft agent as
6670
+ # an agent version, which is an immutable snapshot of your agent. When you save
6671
+ # the draft agent, it is published to the default environment. When you create
6672
+ # agent versions, you can publish them to custom environments. You can create a
6673
+ # variety of custom environments for testing, development, production, etc.
6674
+ class GoogleCloudDialogflowCxV3beta1Environment
6675
+ include Google::Apis::Core::Hashable
6676
+
6677
+ # The human-readable description of the environment. The maximum length is 500
6678
+ # characters. If exceeded, the request is rejected.
6679
+ # Corresponds to the JSON property `description`
6680
+ # @return [String]
6681
+ attr_accessor :description
6682
+
6683
+ # Required. The human-readable name of the environment (unique in an agent).
6684
+ # Limit of 64 characters.
6685
+ # Corresponds to the JSON property `displayName`
6686
+ # @return [String]
6687
+ attr_accessor :display_name
6688
+
6689
+ # The name of the environment. Format: `projects//locations//agents//
6690
+ # environments/`.
6691
+ # Corresponds to the JSON property `name`
6692
+ # @return [String]
6693
+ attr_accessor :name
6694
+
6695
+ # The configuration for continuous tests.
6696
+ # Corresponds to the JSON property `testCasesConfig`
6697
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig]
6698
+ attr_accessor :test_cases_config
6699
+
6700
+ # Output only. Update time of this environment.
6701
+ # Corresponds to the JSON property `updateTime`
6702
+ # @return [String]
6703
+ attr_accessor :update_time
6704
+
6705
+ # Required. A list of configurations for flow versions. You should include
6706
+ # version configs for all flows that are reachable from `Start Flow` in the
6707
+ # agent. Otherwise, an error will be returned.
6708
+ # Corresponds to the JSON property `versionConfigs`
6709
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig>]
6710
+ attr_accessor :version_configs
6711
+
6712
+ def initialize(**args)
6713
+ update!(**args)
6714
+ end
6715
+
6716
+ # Update properties of this object
6717
+ def update!(**args)
6718
+ @description = args[:description] if args.key?(:description)
6719
+ @display_name = args[:display_name] if args.key?(:display_name)
6720
+ @name = args[:name] if args.key?(:name)
6721
+ @test_cases_config = args[:test_cases_config] if args.key?(:test_cases_config)
6722
+ @update_time = args[:update_time] if args.key?(:update_time)
6723
+ @version_configs = args[:version_configs] if args.key?(:version_configs)
6724
+ end
6725
+ end
6726
+
6727
+ # The configuration for continuous tests.
6728
+ class GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig
6729
+ include Google::Apis::Core::Hashable
6730
+
6731
+ # Whether to run test cases in TestCasesConfig.test_cases periodically. Default
6732
+ # false. If set to true, run once a day.
6733
+ # Corresponds to the JSON property `enableContinuousRun`
6734
+ # @return [Boolean]
6735
+ attr_accessor :enable_continuous_run
6736
+ alias_method :enable_continuous_run?, :enable_continuous_run
6737
+
6738
+ # Whether to run test cases in TestCasesConfig.test_cases before deploying a
6739
+ # flow version to the environment. Default false.
6740
+ # Corresponds to the JSON property `enablePredeploymentRun`
6741
+ # @return [Boolean]
6742
+ attr_accessor :enable_predeployment_run
6743
+ alias_method :enable_predeployment_run?, :enable_predeployment_run
6744
+
6745
+ # A list of test case names to run. They should be under the same agent. Format
6746
+ # of each test case name: `projects//locations/ /agents//testCases/`
6747
+ # Corresponds to the JSON property `testCases`
6748
+ # @return [Array<String>]
6749
+ attr_accessor :test_cases
6750
+
6751
+ def initialize(**args)
6752
+ update!(**args)
6753
+ end
6754
+
6755
+ # Update properties of this object
6756
+ def update!(**args)
6757
+ @enable_continuous_run = args[:enable_continuous_run] if args.key?(:enable_continuous_run)
6758
+ @enable_predeployment_run = args[:enable_predeployment_run] if args.key?(:enable_predeployment_run)
6759
+ @test_cases = args[:test_cases] if args.key?(:test_cases)
6760
+ end
6761
+ end
6762
+
6763
+ # Configuration for the version.
6764
+ class GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig
6765
+ include Google::Apis::Core::Hashable
6766
+
6767
+ # Required. Format: projects//locations//agents//flows//versions/.
6768
+ # Corresponds to the JSON property `version`
6769
+ # @return [String]
6770
+ attr_accessor :version
6771
+
6772
+ def initialize(**args)
6773
+ update!(**args)
6774
+ end
6775
+
6776
+ # Update properties of this object
6777
+ def update!(**args)
6778
+ @version = args[:version] if args.key?(:version)
6779
+ end
6780
+ end
6781
+
6098
6782
  # An event handler specifies an event that can be handled during a session. When
6099
6783
  # the specified event happens, the following actions are taken in order: * If
6100
6784
  # there is a `trigger_fulfillment` associated with the event, it will be called.
@@ -6225,6 +6909,7 @@ module Google
6225
6909
  end
6226
6910
 
6227
6911
  # Metadata returned for the TestCases.ExportTestCases long running operation.
6912
+ # This message currently has no fields.
6228
6913
  class GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata
6229
6914
  include Google::Apis::Core::Hashable
6230
6915
 
@@ -7604,7 +8289,8 @@ module Google
7604
8289
  end
7605
8290
  end
7606
8291
 
7607
- # Metadata returned for the TestCases.RunTestCase long running operation.
8292
+ # Metadata returned for the TestCases.RunTestCase long running operation. This
8293
+ # message currently has no fields.
7608
8294
  class GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata
7609
8295
  include Google::Apis::Core::Hashable
7610
8296
 
@@ -8825,8 +9511,9 @@ module Google
8825
9511
  # @return [Array<String>]
8826
9512
  attr_accessor :events
8827
9513
 
8828
- # Read-only. Information about all followup intents that have this intent as a
8829
- # direct or indirect parent. We populate this field only in the output.
9514
+ # Output only. Read-only. Information about all followup intents that have this
9515
+ # intent as a direct or indirect parent. We populate this field only in the
9516
+ # output.
8830
9517
  # Corresponds to the JSON property `followupIntentInfo`
8831
9518
  # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentFollowupIntentInfo>]
8832
9519
  attr_accessor :followup_intent_info
@@ -8911,9 +9598,10 @@ module Google
8911
9598
  attr_accessor :reset_contexts
8912
9599
  alias_method :reset_contexts?, :reset_contexts
8913
9600
 
8914
- # Read-only. The unique identifier of the root intent in the chain of followup
8915
- # intents. It identifies the correct followup intents chain for this intent. We
8916
- # populate this field only in the output. Format: `projects//agent/intents/`.
9601
+ # Output only. Read-only. The unique identifier of the root intent in the chain
9602
+ # of followup intents. It identifies the correct followup intents chain for this
9603
+ # intent. We populate this field only in the output. Format: `projects//agent/
9604
+ # intents/`.
8917
9605
  # Corresponds to the JSON property `rootFollowupIntentName`
8918
9606
  # @return [String]
8919
9607
  attr_accessor :root_followup_intent_name
@@ -13865,6 +14553,78 @@ module Google
13865
14553
  end
13866
14554
  end
13867
14555
 
14556
+ # The response message for Locations.ListLocations.
14557
+ class GoogleCloudLocationListLocationsResponse
14558
+ include Google::Apis::Core::Hashable
14559
+
14560
+ # A list of locations that matches the specified filter in the request.
14561
+ # Corresponds to the JSON property `locations`
14562
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudLocationLocation>]
14563
+ attr_accessor :locations
14564
+
14565
+ # The standard List next-page token.
14566
+ # Corresponds to the JSON property `nextPageToken`
14567
+ # @return [String]
14568
+ attr_accessor :next_page_token
14569
+
14570
+ def initialize(**args)
14571
+ update!(**args)
14572
+ end
14573
+
14574
+ # Update properties of this object
14575
+ def update!(**args)
14576
+ @locations = args[:locations] if args.key?(:locations)
14577
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
14578
+ end
14579
+ end
14580
+
14581
+ # A resource that represents Google Cloud Platform location.
14582
+ class GoogleCloudLocationLocation
14583
+ include Google::Apis::Core::Hashable
14584
+
14585
+ # The friendly name for this location, typically a nearby city name. For example,
14586
+ # "Tokyo".
14587
+ # Corresponds to the JSON property `displayName`
14588
+ # @return [String]
14589
+ attr_accessor :display_name
14590
+
14591
+ # Cross-service attributes for the location. For example `"cloud.googleapis.com/
14592
+ # region": "us-east1"`
14593
+ # Corresponds to the JSON property `labels`
14594
+ # @return [Hash<String,String>]
14595
+ attr_accessor :labels
14596
+
14597
+ # The canonical id for this location. For example: `"us-east1"`.
14598
+ # Corresponds to the JSON property `locationId`
14599
+ # @return [String]
14600
+ attr_accessor :location_id
14601
+
14602
+ # Service-specific metadata. For example the available capacity at the given
14603
+ # location.
14604
+ # Corresponds to the JSON property `metadata`
14605
+ # @return [Hash<String,Object>]
14606
+ attr_accessor :metadata
14607
+
14608
+ # Resource name for the location, which may vary between implementations. For
14609
+ # example: `"projects/example-project/locations/us-east1"`
14610
+ # Corresponds to the JSON property `name`
14611
+ # @return [String]
14612
+ attr_accessor :name
14613
+
14614
+ def initialize(**args)
14615
+ update!(**args)
14616
+ end
14617
+
14618
+ # Update properties of this object
14619
+ def update!(**args)
14620
+ @display_name = args[:display_name] if args.key?(:display_name)
14621
+ @labels = args[:labels] if args.key?(:labels)
14622
+ @location_id = args[:location_id] if args.key?(:location_id)
14623
+ @metadata = args[:metadata] if args.key?(:metadata)
14624
+ @name = args[:name] if args.key?(:name)
14625
+ end
14626
+ end
14627
+
13868
14628
  # The response message for Operations.ListOperations.
13869
14629
  class GoogleLongrunningListOperationsResponse
13870
14630
  include Google::Apis::Core::Hashable