google-apis-dialogflow_v3 0.21.0 → 0.25.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
@@ -610,6 +727,158 @@ module Google
610
727
  end
611
728
  end
612
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
+
613
882
  # The request to detect user's intent.
614
883
  class GoogleCloudDialogflowCxV3DetectIntentRequest
615
884
  include Google::Apis::Core::Hashable
@@ -896,6 +1165,11 @@ module Google
896
1165
  # @return [String]
897
1166
  attr_accessor :name
898
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
+
899
1173
  # Output only. Update time of this environment.
900
1174
  # Corresponds to the JSON property `updateTime`
901
1175
  # @return [String]
@@ -917,11 +1191,48 @@ module Google
917
1191
  @description = args[:description] if args.key?(:description)
918
1192
  @display_name = args[:display_name] if args.key?(:display_name)
919
1193
  @name = args[:name] if args.key?(:name)
1194
+ @test_cases_config = args[:test_cases_config] if args.key?(:test_cases_config)
920
1195
  @update_time = args[:update_time] if args.key?(:update_time)
921
1196
  @version_configs = args[:version_configs] if args.key?(:version_configs)
922
1197
  end
923
1198
  end
924
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
+
925
1236
  # Configuration for the version.
926
1237
  class GoogleCloudDialogflowCxV3EnvironmentVersionConfig
927
1238
  include Google::Apis::Core::Hashable
@@ -2546,6 +2857,34 @@ module Google
2546
2857
  end
2547
2858
  end
2548
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
+
2549
2888
  # The response message for Environments.ListTestCaseResults.
2550
2889
  class GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse
2551
2890
  include Google::Apis::Core::Hashable
@@ -2572,6 +2911,34 @@ module Google
2572
2911
  end
2573
2912
  end
2574
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
+
2575
2942
  # The response message for EntityTypes.ListEntityTypes.
2576
2943
  class GoogleCloudDialogflowCxV3ListEntityTypesResponse
2577
2944
  include Google::Apis::Core::Hashable
@@ -3311,6 +3678,12 @@ module Google
3311
3678
  # @return [String]
3312
3679
  attr_accessor :current_page
3313
3680
 
3681
+ # Always present for WebhookRequest. Ignored for WebhookResponse. The display
3682
+ # name of the current page.
3683
+ # Corresponds to the JSON property `displayName`
3684
+ # @return [String]
3685
+ attr_accessor :display_name
3686
+
3314
3687
  # Represents form information.
3315
3688
  # Corresponds to the JSON property `formInfo`
3316
3689
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3PageInfoFormInfo]
@@ -3323,6 +3696,7 @@ module Google
3323
3696
  # Update properties of this object
3324
3697
  def update!(**args)
3325
3698
  @current_page = args[:current_page] if args.key?(:current_page)
3699
+ @display_name = args[:display_name] if args.key?(:display_name)
3326
3700
  @form_info = args[:form_info] if args.key?(:form_info)
3327
3701
  end
3328
3702
  end
@@ -3597,6 +3971,11 @@ module Google
3597
3971
  # @return [Hash<String,Object>]
3598
3972
  attr_accessor :diagnostic_info
3599
3973
 
3974
+ # Represents the input for dtmf event.
3975
+ # Corresponds to the JSON property `dtmf`
3976
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DtmfInput]
3977
+ attr_accessor :dtmf
3978
+
3600
3979
  # An intent represents a user's intent to interact with a conversational agent.
3601
3980
  # You can provide information for the Dialogflow API to use to match user input
3602
3981
  # to an intent by adding training phrases (i.e., examples of user input) to your
@@ -3697,6 +4076,7 @@ module Google
3697
4076
  def update!(**args)
3698
4077
  @current_page = args[:current_page] if args.key?(:current_page)
3699
4078
  @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info)
4079
+ @dtmf = args[:dtmf] if args.key?(:dtmf)
3700
4080
  @intent = args[:intent] if args.key?(:intent)
3701
4081
  @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence)
3702
4082
  @language_code = args[:language_code] if args.key?(:language_code)
@@ -3826,6 +4206,12 @@ module Google
3826
4206
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio]
3827
4207
  attr_accessor :play_audio
3828
4208
 
4209
+ # Represents the signal that telles the client to transfer the phone call
4210
+ # connected to the agent to a third-party endpoint.
4211
+ # Corresponds to the JSON property `telephonyTransferCall`
4212
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall]
4213
+ attr_accessor :telephony_transfer_call
4214
+
3829
4215
  # The text response message.
3830
4216
  # Corresponds to the JSON property `text`
3831
4217
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageText]
@@ -3844,6 +4230,7 @@ module Google
3844
4230
  @output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text)
3845
4231
  @payload = args[:payload] if args.key?(:payload)
3846
4232
  @play_audio = args[:play_audio] if args.key?(:play_audio)
4233
+ @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call)
3847
4234
  @text = args[:text] if args.key?(:text)
3848
4235
  end
3849
4236
  end
@@ -4036,6 +4423,27 @@ module Google
4036
4423
  end
4037
4424
  end
4038
4425
 
4426
+ # Represents the signal that telles the client to transfer the phone call
4427
+ # connected to the agent to a third-party endpoint.
4428
+ class GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall
4429
+ include Google::Apis::Core::Hashable
4430
+
4431
+ # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/
4432
+ # wiki/E.164).
4433
+ # Corresponds to the JSON property `phoneNumber`
4434
+ # @return [String]
4435
+ attr_accessor :phone_number
4436
+
4437
+ def initialize(**args)
4438
+ update!(**args)
4439
+ end
4440
+
4441
+ # Update properties of this object
4442
+ def update!(**args)
4443
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
4444
+ end
4445
+ end
4446
+
4039
4447
  # The text response message.
4040
4448
  class GoogleCloudDialogflowCxV3ResponseMessageText
4041
4449
  include Google::Apis::Core::Hashable
@@ -4311,7 +4719,10 @@ module Google
4311
4719
  include Google::Apis::Core::Hashable
4312
4720
 
4313
4721
  # [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this
4314
- # template to define de-identification configuration for the content. If empty,
4722
+ # template to define de-identification configuration for the content. The `DLP
4723
+ # De-identify Templates Reader` role is needed on the Dialogflow service
4724
+ # identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-
4725
+ # dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty,
4315
4726
  # Dialogflow replaces sensitive info with `[redacted]` text. The template name
4316
4727
  # will have one of the following formats: `projects//locations//
4317
4728
  # deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note:
@@ -4334,16 +4745,20 @@ module Google
4334
4745
  attr_accessor :insights_export_settings
4335
4746
 
4336
4747
  # [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this
4337
- # template to define inspect base settings. If empty, we use the default DLP
4338
- # inspect config. The template name will have one of the following formats: `
4339
- # projects//locations//inspectTemplates/` OR `organizations//locations//
4340
- # inspectTemplates/` Note: `inspect_template` must be located in the same region
4341
- # as the `SecuritySettings`.
4748
+ # template to define inspect base settings. The `DLP Inspect Templates Reader`
4749
+ # role is needed on the Dialogflow service identity service account (has the
4750
+ # form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for
4751
+ # your agent's project. If empty, we use the default DLP inspect config. The
4752
+ # template name will have one of the following formats: `projects//locations//
4753
+ # inspectTemplates/` OR `organizations//locations//inspectTemplates/` Note: `
4754
+ # inspect_template` must be located in the same region as the `SecuritySettings`.
4342
4755
  # Corresponds to the JSON property `inspectTemplate`
4343
4756
  # @return [String]
4344
4757
  attr_accessor :inspect_template
4345
4758
 
4346
- # Required. Resource name of the settings. Format: `projects//locations//
4759
+ # Resource name of the settings. Required for the SecuritySettingsService.
4760
+ # UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings
4761
+ # populates the name automatically. Format: `projects//locations//
4347
4762
  # securitySettings/`.
4348
4763
  # Corresponds to the JSON property `name`
4349
4764
  # @return [String]
@@ -4367,10 +4782,11 @@ module Google
4367
4782
 
4368
4783
  # Retains data in interaction logging for the specified number of days. This
4369
4784
  # does not apply to Cloud logging, which is owned by the user - not Dialogflow.
4370
- # User must Set a value lower than Dialogflow's default 30d TTL. Setting a value
4371
- # higher than that has no effect. A missing value or setting to 0 also means we
4372
- # use Dialogflow's default TTL. Note: Interaction logging is a limited access
4373
- # feature. Talk to your Google representative to check availability for you.
4785
+ # User must set a value lower than Dialogflow's default 365d TTL. Setting a
4786
+ # value higher than that has no effect. A missing value or setting to 0 also
4787
+ # means we use Dialogflow's default TTL. Note: Interaction logging is a limited
4788
+ # access feature. Talk to your Google representative to check availability for
4789
+ # you.
4374
4790
  # Corresponds to the JSON property `retentionWindowDays`
4375
4791
  # @return [Fixnum]
4376
4792
  attr_accessor :retention_window_days
@@ -5544,6 +5960,18 @@ module Google
5544
5960
  class GoogleCloudDialogflowCxV3WebhookGenericWebService
5545
5961
  include Google::Apis::Core::Hashable
5546
5962
 
5963
+ # Optional. Specifies a list of allowed custom CA certificates (in DER format)
5964
+ # for HTTPS verification. This overrides the default SSL trust store. If this is
5965
+ # empty or unspecified, Dialogflow will use Google's default trust store to
5966
+ # verify certificates. N.B. Make sure the HTTPS server certificates are signed
5967
+ # with "subject alt name". For instance a certificate can be self-signed using
5968
+ # the following command, openssl x509 -req -days 200 -in example.com.csr \ -
5969
+ # signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\
5970
+ # nsubjectAltName='DNS:www.example.com'")
5971
+ # Corresponds to the JSON property `allowedCaCerts`
5972
+ # @return [Array<String>]
5973
+ attr_accessor :allowed_ca_certs
5974
+
5547
5975
  # The password for HTTP Basic authentication.
5548
5976
  # Corresponds to the JSON property `password`
5549
5977
  # @return [String]
@@ -5571,6 +5999,7 @@ module Google
5571
5999
 
5572
6000
  # Update properties of this object
5573
6001
  def update!(**args)
6002
+ @allowed_ca_certs = args[:allowed_ca_certs] if args.key?(:allowed_ca_certs)
5574
6003
  @password = args[:password] if args.key?(:password)
5575
6004
  @request_headers = args[:request_headers] if args.key?(:request_headers)
5576
6005
  @uri = args[:uri] if args.key?(:uri)
@@ -6207,6 +6636,57 @@ module Google
6207
6636
  end
6208
6637
  end
6209
6638
 
6639
+ # Metadata returned for the Environments.DeployFlow long running operation.
6640
+ class GoogleCloudDialogflowCxV3beta1DeployFlowMetadata
6641
+ include Google::Apis::Core::Hashable
6642
+
6643
+ # Errors of running deployment tests.
6644
+ # Corresponds to the JSON property `testErrors`
6645
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1TestError>]
6646
+ attr_accessor :test_errors
6647
+
6648
+ def initialize(**args)
6649
+ update!(**args)
6650
+ end
6651
+
6652
+ # Update properties of this object
6653
+ def update!(**args)
6654
+ @test_errors = args[:test_errors] if args.key?(:test_errors)
6655
+ end
6656
+ end
6657
+
6658
+ # The response message for Environments.DeployFlow.
6659
+ class GoogleCloudDialogflowCxV3beta1DeployFlowResponse
6660
+ include Google::Apis::Core::Hashable
6661
+
6662
+ # The name of the flow version deployment. Format: `projects//locations//agents//
6663
+ # environments//deployments/`.
6664
+ # Corresponds to the JSON property `deployment`
6665
+ # @return [String]
6666
+ attr_accessor :deployment
6667
+
6668
+ # Represents an environment for an agent. You can create multiple versions of
6669
+ # your agent and publish them to separate environments. When you edit an agent,
6670
+ # you are editing the draft agent. At any point, you can save the draft agent as
6671
+ # an agent version, which is an immutable snapshot of your agent. When you save
6672
+ # the draft agent, it is published to the default environment. When you create
6673
+ # agent versions, you can publish them to custom environments. You can create a
6674
+ # variety of custom environments for testing, development, production, etc.
6675
+ # Corresponds to the JSON property `environment`
6676
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1Environment]
6677
+ attr_accessor :environment
6678
+
6679
+ def initialize(**args)
6680
+ update!(**args)
6681
+ end
6682
+
6683
+ # Update properties of this object
6684
+ def update!(**args)
6685
+ @deployment = args[:deployment] if args.key?(:deployment)
6686
+ @environment = args[:environment] if args.key?(:environment)
6687
+ end
6688
+ end
6689
+
6210
6690
  # Represents the input for dtmf event.
6211
6691
  class GoogleCloudDialogflowCxV3beta1DtmfInput
6212
6692
  include Google::Apis::Core::Hashable
@@ -6232,6 +6712,121 @@ module Google
6232
6712
  end
6233
6713
  end
6234
6714
 
6715
+ # Represents an environment for an agent. You can create multiple versions of
6716
+ # your agent and publish them to separate environments. When you edit an agent,
6717
+ # you are editing the draft agent. At any point, you can save the draft agent as
6718
+ # an agent version, which is an immutable snapshot of your agent. When you save
6719
+ # the draft agent, it is published to the default environment. When you create
6720
+ # agent versions, you can publish them to custom environments. You can create a
6721
+ # variety of custom environments for testing, development, production, etc.
6722
+ class GoogleCloudDialogflowCxV3beta1Environment
6723
+ include Google::Apis::Core::Hashable
6724
+
6725
+ # The human-readable description of the environment. The maximum length is 500
6726
+ # characters. If exceeded, the request is rejected.
6727
+ # Corresponds to the JSON property `description`
6728
+ # @return [String]
6729
+ attr_accessor :description
6730
+
6731
+ # Required. The human-readable name of the environment (unique in an agent).
6732
+ # Limit of 64 characters.
6733
+ # Corresponds to the JSON property `displayName`
6734
+ # @return [String]
6735
+ attr_accessor :display_name
6736
+
6737
+ # The name of the environment. Format: `projects//locations//agents//
6738
+ # environments/`.
6739
+ # Corresponds to the JSON property `name`
6740
+ # @return [String]
6741
+ attr_accessor :name
6742
+
6743
+ # The configuration for continuous tests.
6744
+ # Corresponds to the JSON property `testCasesConfig`
6745
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig]
6746
+ attr_accessor :test_cases_config
6747
+
6748
+ # Output only. Update time of this environment.
6749
+ # Corresponds to the JSON property `updateTime`
6750
+ # @return [String]
6751
+ attr_accessor :update_time
6752
+
6753
+ # Required. A list of configurations for flow versions. You should include
6754
+ # version configs for all flows that are reachable from `Start Flow` in the
6755
+ # agent. Otherwise, an error will be returned.
6756
+ # Corresponds to the JSON property `versionConfigs`
6757
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig>]
6758
+ attr_accessor :version_configs
6759
+
6760
+ def initialize(**args)
6761
+ update!(**args)
6762
+ end
6763
+
6764
+ # Update properties of this object
6765
+ def update!(**args)
6766
+ @description = args[:description] if args.key?(:description)
6767
+ @display_name = args[:display_name] if args.key?(:display_name)
6768
+ @name = args[:name] if args.key?(:name)
6769
+ @test_cases_config = args[:test_cases_config] if args.key?(:test_cases_config)
6770
+ @update_time = args[:update_time] if args.key?(:update_time)
6771
+ @version_configs = args[:version_configs] if args.key?(:version_configs)
6772
+ end
6773
+ end
6774
+
6775
+ # The configuration for continuous tests.
6776
+ class GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig
6777
+ include Google::Apis::Core::Hashable
6778
+
6779
+ # Whether to run test cases in TestCasesConfig.test_cases periodically. Default
6780
+ # false. If set to true, run once a day.
6781
+ # Corresponds to the JSON property `enableContinuousRun`
6782
+ # @return [Boolean]
6783
+ attr_accessor :enable_continuous_run
6784
+ alias_method :enable_continuous_run?, :enable_continuous_run
6785
+
6786
+ # Whether to run test cases in TestCasesConfig.test_cases before deploying a
6787
+ # flow version to the environment. Default false.
6788
+ # Corresponds to the JSON property `enablePredeploymentRun`
6789
+ # @return [Boolean]
6790
+ attr_accessor :enable_predeployment_run
6791
+ alias_method :enable_predeployment_run?, :enable_predeployment_run
6792
+
6793
+ # A list of test case names to run. They should be under the same agent. Format
6794
+ # of each test case name: `projects//locations/ /agents//testCases/`
6795
+ # Corresponds to the JSON property `testCases`
6796
+ # @return [Array<String>]
6797
+ attr_accessor :test_cases
6798
+
6799
+ def initialize(**args)
6800
+ update!(**args)
6801
+ end
6802
+
6803
+ # Update properties of this object
6804
+ def update!(**args)
6805
+ @enable_continuous_run = args[:enable_continuous_run] if args.key?(:enable_continuous_run)
6806
+ @enable_predeployment_run = args[:enable_predeployment_run] if args.key?(:enable_predeployment_run)
6807
+ @test_cases = args[:test_cases] if args.key?(:test_cases)
6808
+ end
6809
+ end
6810
+
6811
+ # Configuration for the version.
6812
+ class GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig
6813
+ include Google::Apis::Core::Hashable
6814
+
6815
+ # Required. Format: projects//locations//agents//flows//versions/.
6816
+ # Corresponds to the JSON property `version`
6817
+ # @return [String]
6818
+ attr_accessor :version
6819
+
6820
+ def initialize(**args)
6821
+ update!(**args)
6822
+ end
6823
+
6824
+ # Update properties of this object
6825
+ def update!(**args)
6826
+ @version = args[:version] if args.key?(:version)
6827
+ end
6828
+ end
6829
+
6235
6830
  # An event handler specifies an event that can be handled during a session. When
6236
6831
  # the specified event happens, the following actions are taken in order: * If
6237
6832
  # there is a `trigger_fulfillment` associated with the event, it will be called.
@@ -7232,6 +7827,12 @@ module Google
7232
7827
  # @return [String]
7233
7828
  attr_accessor :current_page
7234
7829
 
7830
+ # Always present for WebhookRequest. Ignored for WebhookResponse. The display
7831
+ # name of the current page.
7832
+ # Corresponds to the JSON property `displayName`
7833
+ # @return [String]
7834
+ attr_accessor :display_name
7835
+
7235
7836
  # Represents form information.
7236
7837
  # Corresponds to the JSON property `formInfo`
7237
7838
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo]
@@ -7244,6 +7845,7 @@ module Google
7244
7845
  # Update properties of this object
7245
7846
  def update!(**args)
7246
7847
  @current_page = args[:current_page] if args.key?(:current_page)
7848
+ @display_name = args[:display_name] if args.key?(:display_name)
7247
7849
  @form_info = args[:form_info] if args.key?(:form_info)
7248
7850
  end
7249
7851
  end
@@ -7466,6 +8068,12 @@ module Google
7466
8068
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio]
7467
8069
  attr_accessor :play_audio
7468
8070
 
8071
+ # Represents the signal that telles the client to transfer the phone call
8072
+ # connected to the agent to a third-party endpoint.
8073
+ # Corresponds to the JSON property `telephonyTransferCall`
8074
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall]
8075
+ attr_accessor :telephony_transfer_call
8076
+
7469
8077
  # The text response message.
7470
8078
  # Corresponds to the JSON property `text`
7471
8079
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
@@ -7484,6 +8092,7 @@ module Google
7484
8092
  @output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text)
7485
8093
  @payload = args[:payload] if args.key?(:payload)
7486
8094
  @play_audio = args[:play_audio] if args.key?(:play_audio)
8095
+ @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call)
7487
8096
  @text = args[:text] if args.key?(:text)
7488
8097
  end
7489
8098
  end
@@ -7676,6 +8285,27 @@ module Google
7676
8285
  end
7677
8286
  end
7678
8287
 
8288
+ # Represents the signal that telles the client to transfer the phone call
8289
+ # connected to the agent to a third-party endpoint.
8290
+ class GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall
8291
+ include Google::Apis::Core::Hashable
8292
+
8293
+ # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/
8294
+ # wiki/E.164).
8295
+ # Corresponds to the JSON property `phoneNumber`
8296
+ # @return [String]
8297
+ attr_accessor :phone_number
8298
+
8299
+ def initialize(**args)
8300
+ update!(**args)
8301
+ end
8302
+
8303
+ # Update properties of this object
8304
+ def update!(**args)
8305
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
8306
+ end
8307
+ end
8308
+
7679
8309
  # The text response message.
7680
8310
  class GoogleCloudDialogflowCxV3beta1ResponseMessageText
7681
8311
  include Google::Apis::Core::Hashable
@@ -10200,7 +10830,7 @@ module Google
10200
10830
  # @return [String]
10201
10831
  attr_accessor :content
10202
10832
 
10203
- # Output only. The time when the message was created.
10833
+ # Output only. The time when the message was created in Contact Center AI.
10204
10834
  # Corresponds to the JSON property `createTime`
10205
10835
  # @return [String]
10206
10836
  attr_accessor :create_time
@@ -10216,7 +10846,7 @@ module Google
10216
10846
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2MessageAnnotation]
10217
10847
  attr_accessor :message_annotation
10218
10848
 
10219
- # The unique identifier of the message. Format: `projects//locations//
10849
+ # Optional. The unique identifier of the message. Format: `projects//locations//
10220
10850
  # conversations//messages/`.
10221
10851
  # Corresponds to the JSON property `name`
10222
10852
  # @return [String]
@@ -10232,6 +10862,23 @@ module Google
10232
10862
  # @return [String]
10233
10863
  attr_accessor :participant_role
10234
10864
 
10865
+ # Optional. The time when the message was sent.
10866
+ # Corresponds to the JSON property `sendTime`
10867
+ # @return [String]
10868
+ attr_accessor :send_time
10869
+
10870
+ # The result of sentiment analysis. Sentiment analysis inspects user input and
10871
+ # identifies the prevailing subjective opinion, especially to determine a user's
10872
+ # attitude as positive, negative, or neutral. For Participants.DetectIntent, it
10873
+ # needs to be configured in DetectIntentRequest.query_params. For Participants.
10874
+ # StreamingDetectIntent, it needs to be configured in
10875
+ # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent
10876
+ # and Participants.StreamingAnalyzeContent, it needs to be configured in
10877
+ # ConversationProfile.human_agent_assistant_config
10878
+ # Corresponds to the JSON property `sentimentAnalysis`
10879
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SentimentAnalysisResult]
10880
+ attr_accessor :sentiment_analysis
10881
+
10235
10882
  def initialize(**args)
10236
10883
  update!(**args)
10237
10884
  end
@@ -10245,6 +10892,8 @@ module Google
10245
10892
  @name = args[:name] if args.key?(:name)
10246
10893
  @participant = args[:participant] if args.key?(:participant)
10247
10894
  @participant_role = args[:participant_role] if args.key?(:participant_role)
10895
+ @send_time = args[:send_time] if args.key?(:send_time)
10896
+ @sentiment_analysis = args[:sentiment_analysis] if args.key?(:sentiment_analysis)
10248
10897
  end
10249
10898
  end
10250
10899
 
@@ -10575,6 +11224,40 @@ module Google
10575
11224
  end
10576
11225
  end
10577
11226
 
11227
+ # Represents a smart reply answer.
11228
+ class GoogleCloudDialogflowV2SmartReplyAnswer
11229
+ include Google::Apis::Core::Hashable
11230
+
11231
+ # The name of answer record, in the format of "projects//locations//
11232
+ # answerRecords/"
11233
+ # Corresponds to the JSON property `answerRecord`
11234
+ # @return [String]
11235
+ attr_accessor :answer_record
11236
+
11237
+ # Smart reply confidence. The system's confidence score that this reply is a
11238
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
11239
+ # to 1.0 (completely certain).
11240
+ # Corresponds to the JSON property `confidence`
11241
+ # @return [Float]
11242
+ attr_accessor :confidence
11243
+
11244
+ # The content of the reply.
11245
+ # Corresponds to the JSON property `reply`
11246
+ # @return [String]
11247
+ attr_accessor :reply
11248
+
11249
+ def initialize(**args)
11250
+ update!(**args)
11251
+ end
11252
+
11253
+ # Update properties of this object
11254
+ def update!(**args)
11255
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
11256
+ @confidence = args[:confidence] if args.key?(:confidence)
11257
+ @reply = args[:reply] if args.key?(:reply)
11258
+ end
11259
+ end
11260
+
10578
11261
  # The response message for Participants.SuggestArticles.
10579
11262
  class GoogleCloudDialogflowV2SuggestArticlesResponse
10580
11263
  include Google::Apis::Core::Hashable
@@ -10643,6 +11326,42 @@ module Google
10643
11326
  end
10644
11327
  end
10645
11328
 
11329
+ # The response message for Participants.SuggestSmartReplies.
11330
+ class GoogleCloudDialogflowV2SuggestSmartRepliesResponse
11331
+ include Google::Apis::Core::Hashable
11332
+
11333
+ # Number of messages prior to and including latest_message to compile the
11334
+ # suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size
11335
+ # field in the request if there aren't that many messages in the conversation.
11336
+ # Corresponds to the JSON property `contextSize`
11337
+ # @return [Fixnum]
11338
+ attr_accessor :context_size
11339
+
11340
+ # The name of the latest conversation message used to compile suggestion for.
11341
+ # Format: `projects//locations//conversations//messages/`.
11342
+ # Corresponds to the JSON property `latestMessage`
11343
+ # @return [String]
11344
+ attr_accessor :latest_message
11345
+
11346
+ # Output only. Multiple reply options provided by smart reply service. The order
11347
+ # is based on the rank of the model prediction. The maximum number of the
11348
+ # returned replies is set in SmartReplyConfig.
11349
+ # Corresponds to the JSON property `smartReplyAnswers`
11350
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SmartReplyAnswer>]
11351
+ attr_accessor :smart_reply_answers
11352
+
11353
+ def initialize(**args)
11354
+ update!(**args)
11355
+ end
11356
+
11357
+ # Update properties of this object
11358
+ def update!(**args)
11359
+ @context_size = args[:context_size] if args.key?(:context_size)
11360
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
11361
+ @smart_reply_answers = args[:smart_reply_answers] if args.key?(:smart_reply_answers)
11362
+ end
11363
+ end
11364
+
10646
11365
  # One response of different type of suggestion response which is used in the
10647
11366
  # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
10648
11367
  # well as HumanAgentAssistantEvent.
@@ -10669,6 +11388,11 @@ module Google
10669
11388
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
10670
11389
  attr_accessor :suggest_faq_answers_response
10671
11390
 
11391
+ # The response message for Participants.SuggestSmartReplies.
11392
+ # Corresponds to the JSON property `suggestSmartRepliesResponse`
11393
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SuggestSmartRepliesResponse]
11394
+ attr_accessor :suggest_smart_replies_response
11395
+
10672
11396
  def initialize(**args)
10673
11397
  update!(**args)
10674
11398
  end
@@ -10678,6 +11402,7 @@ module Google
10678
11402
  @error = args[:error] if args.key?(:error)
10679
11403
  @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
10680
11404
  @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
11405
+ @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
10681
11406
  end
10682
11407
  end
10683
11408
 
@@ -13112,6 +13837,11 @@ module Google
13112
13837
  class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata
13113
13838
  include Google::Apis::Core::Hashable
13114
13839
 
13840
+ # The name of the knowledge base interacted with during the operation.
13841
+ # Corresponds to the JSON property `knowledgeBase`
13842
+ # @return [String]
13843
+ attr_accessor :knowledge_base
13844
+
13115
13845
  # Required. Output only. The current state of this operation.
13116
13846
  # Corresponds to the JSON property `state`
13117
13847
  # @return [String]
@@ -13123,6 +13853,7 @@ module Google
13123
13853
 
13124
13854
  # Update properties of this object
13125
13855
  def update!(**args)
13856
+ @knowledge_base = args[:knowledge_base] if args.key?(:knowledge_base)
13126
13857
  @state = args[:state] if args.key?(:state)
13127
13858
  end
13128
13859
  end