google-apis-dialogflow_v3beta1 0.97.0 → 0.99.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.
@@ -3345,6 +3345,22 @@ module Google
3345
3345
  # @return [Hash<String,String>]
3346
3346
  attr_accessor :request_headers
3347
3347
 
3348
+ # Optional. The SecretManager secret version resource storing the username:
3349
+ # password pair for HTTP Basic authentication. Format: `projects/`project`/
3350
+ # secrets/`secret`/versions/`version``
3351
+ # Corresponds to the JSON property `secretVersionForUsernamePassword`
3352
+ # @return [String]
3353
+ attr_accessor :secret_version_for_username_password
3354
+
3355
+ # Optional. The HTTP request headers to send together with webhook requests.
3356
+ # Header values are stored in SecretManager secret versions. When the same
3357
+ # header name is specified in both `request_headers` and `
3358
+ # secret_versions_for_request_headers`, the value in `
3359
+ # secret_versions_for_request_headers` will be used.
3360
+ # Corresponds to the JSON property `secretVersionsForRequestHeaders`
3361
+ # @return [Hash<String,Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue>]
3362
+ attr_accessor :secret_versions_for_request_headers
3363
+
3348
3364
  # Optional. Indicate the auth token type generated from the [Diglogflow service
3349
3365
  # agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-
3350
3366
  # agent). The generated token is sent in the Authorization header.
@@ -3381,6 +3397,8 @@ module Google
3381
3397
  @password = args[:password] if args.key?(:password)
3382
3398
  @request_body = args[:request_body] if args.key?(:request_body)
3383
3399
  @request_headers = args[:request_headers] if args.key?(:request_headers)
3400
+ @secret_version_for_username_password = args[:secret_version_for_username_password] if args.key?(:secret_version_for_username_password)
3401
+ @secret_versions_for_request_headers = args[:secret_versions_for_request_headers] if args.key?(:secret_versions_for_request_headers)
3384
3402
  @service_agent_auth = args[:service_agent_auth] if args.key?(:service_agent_auth)
3385
3403
  @uri = args[:uri] if args.key?(:uri)
3386
3404
  @username = args[:username] if args.key?(:username)
@@ -3408,6 +3426,13 @@ module Google
3408
3426
  # @return [Array<String>]
3409
3427
  attr_accessor :scopes
3410
3428
 
3429
+ # Optional. The name of the SecretManager secret version resource storing the
3430
+ # client secret. If this field is set, the `client_secret` field will be ignored.
3431
+ # Format: `projects/`project`/secrets/`secret`/versions/`version``
3432
+ # Corresponds to the JSON property `secretVersionForClientSecret`
3433
+ # @return [String]
3434
+ attr_accessor :secret_version_for_client_secret
3435
+
3411
3436
  # Required. The token endpoint provided by the 3rd party platform to exchange an
3412
3437
  # access token.
3413
3438
  # Corresponds to the JSON property `tokenEndpoint`
@@ -3423,10 +3448,32 @@ module Google
3423
3448
  @client_id = args[:client_id] if args.key?(:client_id)
3424
3449
  @client_secret = args[:client_secret] if args.key?(:client_secret)
3425
3450
  @scopes = args[:scopes] if args.key?(:scopes)
3451
+ @secret_version_for_client_secret = args[:secret_version_for_client_secret] if args.key?(:secret_version_for_client_secret)
3426
3452
  @token_endpoint = args[:token_endpoint] if args.key?(:token_endpoint)
3427
3453
  end
3428
3454
  end
3429
3455
 
3456
+ # Represents the value of an HTTP header stored in a SecretManager secret
3457
+ # version.
3458
+ class GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue
3459
+ include Google::Apis::Core::Hashable
3460
+
3461
+ # Required. The SecretManager secret version resource storing the header value.
3462
+ # Format: `projects/`project`/secrets/`secret`/versions/`version``
3463
+ # Corresponds to the JSON property `secretVersion`
3464
+ # @return [String]
3465
+ attr_accessor :secret_version
3466
+
3467
+ def initialize(**args)
3468
+ update!(**args)
3469
+ end
3470
+
3471
+ # Update properties of this object
3472
+ def update!(**args)
3473
+ @secret_version = args[:secret_version] if args.key?(:secret_version)
3474
+ end
3475
+ end
3476
+
3430
3477
  # The request message for a webhook call. The request is sent as a JSON object
3431
3478
  # and the field names will be presented in camel cases. You may see undocumented
3432
3479
  # fields in an actual request. These fields are used internally by Dialogflow
@@ -3769,23 +3816,51 @@ module Google
3769
3816
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentUtterance]
3770
3817
  attr_accessor :agent_utterance
3771
3818
 
3819
+ # Output only. Timestamp of the completion of the agent action.
3820
+ # Corresponds to the JSON property `completeTime`
3821
+ # @return [String]
3822
+ attr_accessor :complete_time
3823
+
3824
+ # Output only. The display name of the action.
3825
+ # Corresponds to the JSON property `displayName`
3826
+ # @return [String]
3827
+ attr_accessor :display_name
3828
+
3772
3829
  # Event represents the event sent by the customer.
3773
3830
  # Corresponds to the JSON property `event`
3774
3831
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Event]
3775
3832
  attr_accessor :event
3776
3833
 
3777
- # Stores metadata of the invocation of a CX flow.
3834
+ # Stores metadata of the invocation of a child CX flow. Flow invocation actions
3835
+ # enter the child flow.
3778
3836
  # Corresponds to the JSON property `flowInvocation`
3779
3837
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowInvocation]
3780
3838
  attr_accessor :flow_invocation
3781
3839
 
3840
+ # Stores metadata of the state update action, such as a state machine execution
3841
+ # in flows.
3842
+ # Corresponds to the JSON property `flowStateUpdate`
3843
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdate]
3844
+ attr_accessor :flow_state_update
3845
+
3782
3846
  # Stores metadata of the transition to a target CX flow. Flow transition actions
3783
3847
  # exit the caller playbook and enter the child flow.
3784
3848
  # Corresponds to the JSON property `flowTransition`
3785
3849
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowTransition]
3786
3850
  attr_accessor :flow_transition
3787
3851
 
3788
- # Stores metadata of the invocation of a child playbook.
3852
+ # Stores metadata of the intent match action.
3853
+ # Corresponds to the JSON property `intentMatch`
3854
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionIntentMatch]
3855
+ attr_accessor :intent_match
3856
+
3857
+ # Stores metadata of the call of an LLM.
3858
+ # Corresponds to the JSON property `llmCall`
3859
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmCall]
3860
+ attr_accessor :llm_call
3861
+
3862
+ # Stores metadata of the invocation of a child playbook. Playbook invocation
3863
+ # actions enter the child playbook.
3789
3864
  # Corresponds to the JSON property `playbookInvocation`
3790
3865
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookInvocation]
3791
3866
  attr_accessor :playbook_invocation
@@ -3796,11 +3871,37 @@ module Google
3796
3871
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookTransition]
3797
3872
  attr_accessor :playbook_transition
3798
3873
 
3874
+ # Output only. Timestamp of the start of the agent action.
3875
+ # Corresponds to the JSON property `startTime`
3876
+ # @return [String]
3877
+ attr_accessor :start_time
3878
+
3879
+ # The status of the action.
3880
+ # Corresponds to the JSON property `status`
3881
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Status]
3882
+ attr_accessor :status
3883
+
3884
+ # Stores metadata of the Speech-to-Text action.
3885
+ # Corresponds to the JSON property `stt`
3886
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionStt]
3887
+ attr_accessor :stt
3888
+
3889
+ # Optional. The detailed tracing information for sub execution steps of the
3890
+ # action.
3891
+ # Corresponds to the JSON property `subExecutionSteps`
3892
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Span>]
3893
+ attr_accessor :sub_execution_steps
3894
+
3799
3895
  # Stores metadata of the invocation of an action supported by a tool.
3800
3896
  # Corresponds to the JSON property `toolUse`
3801
3897
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUse]
3802
3898
  attr_accessor :tool_use
3803
3899
 
3900
+ # Stores metadata of the Text-to-Speech action.
3901
+ # Corresponds to the JSON property `tts`
3902
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionTts]
3903
+ attr_accessor :tts
3904
+
3804
3905
  # UserUtterance represents one message sent by the customer.
3805
3906
  # Corresponds to the JSON property `userUtterance`
3806
3907
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1UserUtterance]
@@ -3813,16 +3914,203 @@ module Google
3813
3914
  # Update properties of this object
3814
3915
  def update!(**args)
3815
3916
  @agent_utterance = args[:agent_utterance] if args.key?(:agent_utterance)
3917
+ @complete_time = args[:complete_time] if args.key?(:complete_time)
3918
+ @display_name = args[:display_name] if args.key?(:display_name)
3816
3919
  @event = args[:event] if args.key?(:event)
3817
3920
  @flow_invocation = args[:flow_invocation] if args.key?(:flow_invocation)
3921
+ @flow_state_update = args[:flow_state_update] if args.key?(:flow_state_update)
3818
3922
  @flow_transition = args[:flow_transition] if args.key?(:flow_transition)
3923
+ @intent_match = args[:intent_match] if args.key?(:intent_match)
3924
+ @llm_call = args[:llm_call] if args.key?(:llm_call)
3819
3925
  @playbook_invocation = args[:playbook_invocation] if args.key?(:playbook_invocation)
3820
3926
  @playbook_transition = args[:playbook_transition] if args.key?(:playbook_transition)
3927
+ @start_time = args[:start_time] if args.key?(:start_time)
3928
+ @status = args[:status] if args.key?(:status)
3929
+ @stt = args[:stt] if args.key?(:stt)
3930
+ @sub_execution_steps = args[:sub_execution_steps] if args.key?(:sub_execution_steps)
3821
3931
  @tool_use = args[:tool_use] if args.key?(:tool_use)
3932
+ @tts = args[:tts] if args.key?(:tts)
3822
3933
  @user_utterance = args[:user_utterance] if args.key?(:user_utterance)
3823
3934
  end
3824
3935
  end
3825
3936
 
3937
+ # Stores metadata of the state update action, such as a state machine execution
3938
+ # in flows.
3939
+ class GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdate
3940
+ include Google::Apis::Core::Hashable
3941
+
3942
+ # The destination of the transition. Format: `projects//locations//agents//flows/
3943
+ # /pages/` or `projects//locations//agents//playbooks/`.
3944
+ # Corresponds to the JSON property `destination`
3945
+ # @return [String]
3946
+ attr_accessor :destination
3947
+
3948
+ # The type of the event that triggered the state update.
3949
+ # Corresponds to the JSON property `eventType`
3950
+ # @return [String]
3951
+ attr_accessor :event_type
3952
+
3953
+ # Stores the metadata of a function call to execute.
3954
+ # Corresponds to the JSON property `functionCall`
3955
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdateFunctionCall]
3956
+ attr_accessor :function_call
3957
+
3958
+ # Stores the state of a page and its flow.
3959
+ # Corresponds to the JSON property `pageState`
3960
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdatePageState]
3961
+ attr_accessor :page_state
3962
+
3963
+ # The updated parameters.
3964
+ # Corresponds to the JSON property `updatedParameters`
3965
+ # @return [Hash<String,Object>]
3966
+ attr_accessor :updated_parameters
3967
+
3968
+ def initialize(**args)
3969
+ update!(**args)
3970
+ end
3971
+
3972
+ # Update properties of this object
3973
+ def update!(**args)
3974
+ @destination = args[:destination] if args.key?(:destination)
3975
+ @event_type = args[:event_type] if args.key?(:event_type)
3976
+ @function_call = args[:function_call] if args.key?(:function_call)
3977
+ @page_state = args[:page_state] if args.key?(:page_state)
3978
+ @updated_parameters = args[:updated_parameters] if args.key?(:updated_parameters)
3979
+ end
3980
+ end
3981
+
3982
+ # Stores the metadata of a function call to execute.
3983
+ class GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdateFunctionCall
3984
+ include Google::Apis::Core::Hashable
3985
+
3986
+ # The name of the function call.
3987
+ # Corresponds to the JSON property `name`
3988
+ # @return [String]
3989
+ attr_accessor :name
3990
+
3991
+ def initialize(**args)
3992
+ update!(**args)
3993
+ end
3994
+
3995
+ # Update properties of this object
3996
+ def update!(**args)
3997
+ @name = args[:name] if args.key?(:name)
3998
+ end
3999
+ end
4000
+
4001
+ # Stores the state of a page and its flow.
4002
+ class GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdatePageState
4003
+ include Google::Apis::Core::Hashable
4004
+
4005
+ # The display name of the page.
4006
+ # Corresponds to the JSON property `displayName`
4007
+ # @return [String]
4008
+ attr_accessor :display_name
4009
+
4010
+ # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
4011
+ # Corresponds to the JSON property `page`
4012
+ # @return [String]
4013
+ attr_accessor :page
4014
+
4015
+ # The status of the page.
4016
+ # Corresponds to the JSON property `status`
4017
+ # @return [String]
4018
+ attr_accessor :status
4019
+
4020
+ def initialize(**args)
4021
+ update!(**args)
4022
+ end
4023
+
4024
+ # Update properties of this object
4025
+ def update!(**args)
4026
+ @display_name = args[:display_name] if args.key?(:display_name)
4027
+ @page = args[:page] if args.key?(:page)
4028
+ @status = args[:status] if args.key?(:status)
4029
+ end
4030
+ end
4031
+
4032
+ # Stores metadata of the intent match action.
4033
+ class GoogleCloudDialogflowCxV3beta1ActionIntentMatch
4034
+ include Google::Apis::Core::Hashable
4035
+
4036
+ # The matched intent.
4037
+ # Corresponds to the JSON property `matchedIntents`
4038
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionIntentMatchMatchedIntent>]
4039
+ attr_accessor :matched_intents
4040
+
4041
+ def initialize(**args)
4042
+ update!(**args)
4043
+ end
4044
+
4045
+ # Update properties of this object
4046
+ def update!(**args)
4047
+ @matched_intents = args[:matched_intents] if args.key?(:matched_intents)
4048
+ end
4049
+ end
4050
+
4051
+ # Stores the matched intent, which is the result of the intent match action.
4052
+ class GoogleCloudDialogflowCxV3beta1ActionIntentMatchMatchedIntent
4053
+ include Google::Apis::Core::Hashable
4054
+
4055
+ # The display name of the matched intent.
4056
+ # Corresponds to the JSON property `displayName`
4057
+ # @return [String]
4058
+ attr_accessor :display_name
4059
+
4060
+ # The generative fallback response of the matched intent.
4061
+ # Corresponds to the JSON property `generativeFallback`
4062
+ # @return [Hash<String,Object>]
4063
+ attr_accessor :generative_fallback
4064
+
4065
+ # The ID of the matched intent.
4066
+ # Corresponds to the JSON property `intentId`
4067
+ # @return [String]
4068
+ attr_accessor :intent_id
4069
+
4070
+ # The score of the matched intent.
4071
+ # Corresponds to the JSON property `score`
4072
+ # @return [Float]
4073
+ attr_accessor :score
4074
+
4075
+ def initialize(**args)
4076
+ update!(**args)
4077
+ end
4078
+
4079
+ # Update properties of this object
4080
+ def update!(**args)
4081
+ @display_name = args[:display_name] if args.key?(:display_name)
4082
+ @generative_fallback = args[:generative_fallback] if args.key?(:generative_fallback)
4083
+ @intent_id = args[:intent_id] if args.key?(:intent_id)
4084
+ @score = args[:score] if args.key?(:score)
4085
+ end
4086
+ end
4087
+
4088
+ # Stores metadata of the Speech-to-Text action.
4089
+ class GoogleCloudDialogflowCxV3beta1ActionStt
4090
+ include Google::Apis::Core::Hashable
4091
+
4092
+ def initialize(**args)
4093
+ update!(**args)
4094
+ end
4095
+
4096
+ # Update properties of this object
4097
+ def update!(**args)
4098
+ end
4099
+ end
4100
+
4101
+ # Stores metadata of the Text-to-Speech action.
4102
+ class GoogleCloudDialogflowCxV3beta1ActionTts
4103
+ include Google::Apis::Core::Hashable
4104
+
4105
+ def initialize(**args)
4106
+ update!(**args)
4107
+ end
4108
+
4109
+ # Update properties of this object
4110
+ def update!(**args)
4111
+ end
4112
+ end
4113
+
3826
4114
  # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
3827
4115
  # Settings exposed at lower level overrides the settings exposed at higher level.
3828
4116
  # Overriding occurs at the sub-setting level. For example, the
@@ -4417,6 +4705,15 @@ module Google
4417
4705
  class GoogleCloudDialogflowCxV3beta1AgentUtterance
4418
4706
  include Google::Apis::Core::Hashable
4419
4707
 
4708
+ # Optional. True if the agent utterance needs to be generated by the LLM. Only
4709
+ # used in webhook response to differentiate from empty text. Revisit whether we
4710
+ # need this field or mark `text` as optional when we expose webhook interface to
4711
+ # customer.
4712
+ # Corresponds to the JSON property `requireGeneration`
4713
+ # @return [Boolean]
4714
+ attr_accessor :require_generation
4715
+ alias_method :require_generation?, :require_generation
4716
+
4420
4717
  # Required. Message content in text.
4421
4718
  # Corresponds to the JSON property `text`
4422
4719
  # @return [String]
@@ -4428,6 +4725,7 @@ module Google
4428
4725
 
4429
4726
  # Update properties of this object
4430
4727
  def update!(**args)
4728
+ @require_generation = args[:require_generation] if args.key?(:require_generation)
4431
4729
  @text = args[:text] if args.key?(:text)
4432
4730
  end
4433
4731
  end
@@ -6553,6 +6851,11 @@ module Google
6553
6851
  # @return [String]
6554
6852
  attr_accessor :event
6555
6853
 
6854
+ # Optional. Unstructured text payload of the event.
6855
+ # Corresponds to the JSON property `text`
6856
+ # @return [String]
6857
+ attr_accessor :text
6858
+
6556
6859
  def initialize(**args)
6557
6860
  update!(**args)
6558
6861
  end
@@ -6560,6 +6863,7 @@ module Google
6560
6863
  # Update properties of this object
6561
6864
  def update!(**args)
6562
6865
  @event = args[:event] if args.key?(:event)
6866
+ @text = args[:text] if args.key?(:text)
6563
6867
  end
6564
6868
  end
6565
6869
 
@@ -6733,6 +7037,25 @@ module Google
6733
7037
  end
6734
7038
  end
6735
7039
 
7040
+ # Exception thrown during the execution of an action.
7041
+ class GoogleCloudDialogflowCxV3beta1Exception
7042
+ include Google::Apis::Core::Hashable
7043
+
7044
+ # Optional. The error message.
7045
+ # Corresponds to the JSON property `errorMessage`
7046
+ # @return [String]
7047
+ attr_accessor :error_message
7048
+
7049
+ def initialize(**args)
7050
+ update!(**args)
7051
+ end
7052
+
7053
+ # Update properties of this object
7054
+ def update!(**args)
7055
+ @error_message = args[:error_message] if args.key?(:error_message)
7056
+ end
7057
+ end
7058
+
6736
7059
  # Represents an experiment in an environment.
6737
7060
  class GoogleCloudDialogflowCxV3beta1Experiment
6738
7061
  include Google::Apis::Core::Hashable
@@ -7369,6 +7692,38 @@ module Google
7369
7692
  end
7370
7693
  end
7371
7694
 
7695
+ # The request message for Playbooks.ExportPlaybook.
7696
+ class GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest
7697
+ include Google::Apis::Core::Hashable
7698
+
7699
+ # Optional. The data format of the exported agent. If not specified, `BLOB` is
7700
+ # assumed.
7701
+ # Corresponds to the JSON property `dataFormat`
7702
+ # @return [String]
7703
+ attr_accessor :data_format
7704
+
7705
+ # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/)
7706
+ # URI to export the playbook to. The format of this URI must be `gs:///`. If
7707
+ # left unspecified, the serialized playbook is returned inline. Dialogflow
7708
+ # performs a write operation for the Cloud Storage object on the caller's behalf,
7709
+ # so your request authentication must have write permissions for the object.
7710
+ # For more information, see [Dialogflow access control](https://cloud.google.com/
7711
+ # dialogflow/cx/docs/concept/access-control#storage).
7712
+ # Corresponds to the JSON property `playbookUri`
7713
+ # @return [String]
7714
+ attr_accessor :playbook_uri
7715
+
7716
+ def initialize(**args)
7717
+ update!(**args)
7718
+ end
7719
+
7720
+ # Update properties of this object
7721
+ def update!(**args)
7722
+ @data_format = args[:data_format] if args.key?(:data_format)
7723
+ @playbook_uri = args[:playbook_uri] if args.key?(:playbook_uri)
7724
+ end
7725
+ end
7726
+
7372
7727
  # Metadata returned for the TestCases.ExportTestCases long running operation.
7373
7728
  # This message currently has no fields.
7374
7729
  class GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata
@@ -7670,7 +8025,8 @@ module Google
7670
8025
  end
7671
8026
  end
7672
8027
 
7673
- # Stores metadata of the invocation of a CX flow.
8028
+ # Stores metadata of the invocation of a child CX flow. Flow invocation actions
8029
+ # enter the child flow.
7674
8030
  class GoogleCloudDialogflowCxV3beta1FlowInvocation
7675
8031
  include Google::Apis::Core::Hashable
7676
8032
 
@@ -7680,7 +8036,7 @@ module Google
7680
8036
  attr_accessor :display_name
7681
8037
 
7682
8038
  # Required. The unique identifier of the flow. Format: `projects//locations//
7683
- # agents//flows/`.
8039
+ # agents/`.
7684
8040
  # Corresponds to the JSON property `flow`
7685
8041
  # @return [String]
7686
8042
  attr_accessor :flow
@@ -7761,6 +8117,11 @@ module Google
7761
8117
  # @return [String]
7762
8118
  attr_accessor :flow
7763
8119
 
8120
+ # A list of input parameters for the action.
8121
+ # Corresponds to the JSON property `inputActionParameters`
8122
+ # @return [Hash<String,Object>]
8123
+ attr_accessor :input_action_parameters
8124
+
7764
8125
  def initialize(**args)
7765
8126
  update!(**args)
7766
8127
  end
@@ -7769,6 +8130,7 @@ module Google
7769
8130
  def update!(**args)
7770
8131
  @display_name = args[:display_name] if args.key?(:display_name)
7771
8132
  @flow = args[:flow] if args.key?(:flow)
8133
+ @input_action_parameters = args[:input_action_parameters] if args.key?(:input_action_parameters)
7772
8134
  end
7773
8135
  end
7774
8136
 
@@ -8965,6 +9327,40 @@ module Google
8965
9327
  end
8966
9328
  end
8967
9329
 
9330
+ # The request message for Playbooks.ImportPlaybook.
9331
+ class GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest
9332
+ include Google::Apis::Core::Hashable
9333
+
9334
+ # The playbook import strategy used for resource conflict resolution associated
9335
+ # with an ImportPlaybookRequest.
9336
+ # Corresponds to the JSON property `importStrategy`
9337
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookImportStrategy]
9338
+ attr_accessor :import_strategy
9339
+
9340
+ # Uncompressed raw byte content for playbook.
9341
+ # Corresponds to the JSON property `playbookContent`
9342
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
9343
+ # @return [String]
9344
+ attr_accessor :playbook_content
9345
+
9346
+ # [Dialogflow access control] (https://cloud.google.com/dialogflow/cx/docs/
9347
+ # concept/access-control#storage).
9348
+ # Corresponds to the JSON property `playbookUri`
9349
+ # @return [String]
9350
+ attr_accessor :playbook_uri
9351
+
9352
+ def initialize(**args)
9353
+ update!(**args)
9354
+ end
9355
+
9356
+ # Update properties of this object
9357
+ def update!(**args)
9358
+ @import_strategy = args[:import_strategy] if args.key?(:import_strategy)
9359
+ @playbook_content = args[:playbook_content] if args.key?(:playbook_content)
9360
+ @playbook_uri = args[:playbook_uri] if args.key?(:playbook_uri)
9361
+ end
9362
+ end
9363
+
8968
9364
  # Metadata returned for the TestCases.ImportTestCases long running operation.
8969
9365
  class GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata
8970
9366
  include Google::Apis::Core::Hashable
@@ -10214,6 +10610,117 @@ module Google
10214
10610
  end
10215
10611
  end
10216
10612
 
10613
+ # Stores metadata of the call of an LLM.
10614
+ class GoogleCloudDialogflowCxV3beta1LlmCall
10615
+ include Google::Apis::Core::Hashable
10616
+
10617
+ # The model of the LLM call.
10618
+ # Corresponds to the JSON property `model`
10619
+ # @return [String]
10620
+ attr_accessor :model
10621
+
10622
+ # A list of relevant examples used for the LLM prompt.
10623
+ # Corresponds to the JSON property `retrievedExamples`
10624
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmCallRetrievedExample>]
10625
+ attr_accessor :retrieved_examples
10626
+
10627
+ # The temperature of the LLM call.
10628
+ # Corresponds to the JSON property `temperature`
10629
+ # @return [Float]
10630
+ attr_accessor :temperature
10631
+
10632
+ # Stores token counts of the LLM call.
10633
+ # Corresponds to the JSON property `tokenCount`
10634
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmCallTokenCount]
10635
+ attr_accessor :token_count
10636
+
10637
+ def initialize(**args)
10638
+ update!(**args)
10639
+ end
10640
+
10641
+ # Update properties of this object
10642
+ def update!(**args)
10643
+ @model = args[:model] if args.key?(:model)
10644
+ @retrieved_examples = args[:retrieved_examples] if args.key?(:retrieved_examples)
10645
+ @temperature = args[:temperature] if args.key?(:temperature)
10646
+ @token_count = args[:token_count] if args.key?(:token_count)
10647
+ end
10648
+ end
10649
+
10650
+ # Relevant example used for the LLM prompt.
10651
+ class GoogleCloudDialogflowCxV3beta1LlmCallRetrievedExample
10652
+ include Google::Apis::Core::Hashable
10653
+
10654
+ # The display name of the example.
10655
+ # Corresponds to the JSON property `exampleDisplayName`
10656
+ # @return [String]
10657
+ attr_accessor :example_display_name
10658
+
10659
+ # The id of the example.
10660
+ # Corresponds to the JSON property `exampleId`
10661
+ # @return [String]
10662
+ attr_accessor :example_id
10663
+
10664
+ # Optional. The matched retrieval label of this LLM call.
10665
+ # Corresponds to the JSON property `matchedRetrievalLabel`
10666
+ # @return [String]
10667
+ attr_accessor :matched_retrieval_label
10668
+
10669
+ # Retrieval strategy of the example.
10670
+ # Corresponds to the JSON property `retrievalStrategy`
10671
+ # @return [String]
10672
+ attr_accessor :retrieval_strategy
10673
+
10674
+ def initialize(**args)
10675
+ update!(**args)
10676
+ end
10677
+
10678
+ # Update properties of this object
10679
+ def update!(**args)
10680
+ @example_display_name = args[:example_display_name] if args.key?(:example_display_name)
10681
+ @example_id = args[:example_id] if args.key?(:example_id)
10682
+ @matched_retrieval_label = args[:matched_retrieval_label] if args.key?(:matched_retrieval_label)
10683
+ @retrieval_strategy = args[:retrieval_strategy] if args.key?(:retrieval_strategy)
10684
+ end
10685
+ end
10686
+
10687
+ # Stores token counts of the LLM call.
10688
+ class GoogleCloudDialogflowCxV3beta1LlmCallTokenCount
10689
+ include Google::Apis::Core::Hashable
10690
+
10691
+ # The number of tokens used for the conversation history in the prompt.
10692
+ # Corresponds to the JSON property `conversationContextTokenCount`
10693
+ # @return [Fixnum]
10694
+ attr_accessor :conversation_context_token_count
10695
+
10696
+ # The number of tokens used for the retrieved examples in the prompt.
10697
+ # Corresponds to the JSON property `exampleTokenCount`
10698
+ # @return [Fixnum]
10699
+ attr_accessor :example_token_count
10700
+
10701
+ # The total number of tokens used for the input to the LLM call.
10702
+ # Corresponds to the JSON property `totalInputTokenCount`
10703
+ # @return [Fixnum]
10704
+ attr_accessor :total_input_token_count
10705
+
10706
+ # The total number of tokens used for the output of the LLM call.
10707
+ # Corresponds to the JSON property `totalOutputTokenCount`
10708
+ # @return [Fixnum]
10709
+ attr_accessor :total_output_token_count
10710
+
10711
+ def initialize(**args)
10712
+ update!(**args)
10713
+ end
10714
+
10715
+ # Update properties of this object
10716
+ def update!(**args)
10717
+ @conversation_context_token_count = args[:conversation_context_token_count] if args.key?(:conversation_context_token_count)
10718
+ @example_token_count = args[:example_token_count] if args.key?(:example_token_count)
10719
+ @total_input_token_count = args[:total_input_token_count] if args.key?(:total_input_token_count)
10720
+ @total_output_token_count = args[:total_output_token_count] if args.key?(:total_output_token_count)
10721
+ end
10722
+ end
10723
+
10217
10724
  # Settings for LLM models.
10218
10725
  class GoogleCloudDialogflowCxV3beta1LlmModelSettings
10219
10726
  include Google::Apis::Core::Hashable
@@ -10457,6 +10964,38 @@ module Google
10457
10964
  end
10458
10965
  end
10459
10966
 
10967
+ # A named metric is a metric with name, value and unit.
10968
+ class GoogleCloudDialogflowCxV3beta1NamedMetric
10969
+ include Google::Apis::Core::Hashable
10970
+
10971
+ # The name of the metric.
10972
+ # Corresponds to the JSON property `name`
10973
+ # @return [String]
10974
+ attr_accessor :name
10975
+
10976
+ # The unit in which this metric is reported. Follows [The Unified Code for Units
10977
+ # of Measure](https://unitsofmeasure.org/ucum.html) standard.
10978
+ # Corresponds to the JSON property `unit`
10979
+ # @return [String]
10980
+ attr_accessor :unit
10981
+
10982
+ # The value of the metric.
10983
+ # Corresponds to the JSON property `value`
10984
+ # @return [Object]
10985
+ attr_accessor :value
10986
+
10987
+ def initialize(**args)
10988
+ update!(**args)
10989
+ end
10990
+
10991
+ # Update properties of this object
10992
+ def update!(**args)
10993
+ @name = args[:name] if args.key?(:name)
10994
+ @unit = args[:unit] if args.key?(:unit)
10995
+ @value = args[:value] if args.key?(:value)
10996
+ end
10997
+ end
10998
+
10460
10999
  # Settings related to NLU.
10461
11000
  class GoogleCloudDialogflowCxV3beta1NluSettings
10462
11001
  include Google::Apis::Core::Hashable
@@ -10943,6 +11482,43 @@ module Google
10943
11482
  end
10944
11483
  end
10945
11484
 
11485
+ # The playbook import strategy used for resource conflict resolution associated
11486
+ # with an ImportPlaybookRequest.
11487
+ class GoogleCloudDialogflowCxV3beta1PlaybookImportStrategy
11488
+ include Google::Apis::Core::Hashable
11489
+
11490
+ # Optional. Specifies the import strategy used when resolving conflicts with the
11491
+ # main playbook. If not specified, 'CREATE_NEW' is assumed.
11492
+ # Corresponds to the JSON property `mainPlaybookImportStrategy`
11493
+ # @return [String]
11494
+ attr_accessor :main_playbook_import_strategy
11495
+
11496
+ # Optional. Specifies the import strategy used when resolving referenced
11497
+ # playbook/flow conflicts. If not specified, 'CREATE_NEW' is assumed.
11498
+ # Corresponds to the JSON property `nestedResourceImportStrategy`
11499
+ # @return [String]
11500
+ attr_accessor :nested_resource_import_strategy
11501
+
11502
+ # Optional. Specifies the import strategy used when resolving tool conflicts. If
11503
+ # not specified, 'CREATE_NEW' is assumed. This will be applied after the main
11504
+ # playbook and nested resource import strategies, meaning if the playbook that
11505
+ # references the tool is skipped, the tool will also be skipped.
11506
+ # Corresponds to the JSON property `toolImportStrategy`
11507
+ # @return [String]
11508
+ attr_accessor :tool_import_strategy
11509
+
11510
+ def initialize(**args)
11511
+ update!(**args)
11512
+ end
11513
+
11514
+ # Update properties of this object
11515
+ def update!(**args)
11516
+ @main_playbook_import_strategy = args[:main_playbook_import_strategy] if args.key?(:main_playbook_import_strategy)
11517
+ @nested_resource_import_strategy = args[:nested_resource_import_strategy] if args.key?(:nested_resource_import_strategy)
11518
+ @tool_import_strategy = args[:tool_import_strategy] if args.key?(:tool_import_strategy)
11519
+ end
11520
+ end
11521
+
10946
11522
  # Input of the playbook.
10947
11523
  class GoogleCloudDialogflowCxV3beta1PlaybookInput
10948
11524
  include Google::Apis::Core::Hashable
@@ -10996,7 +11572,8 @@ module Google
10996
11572
  end
10997
11573
  end
10998
11574
 
10999
- # Stores metadata of the invocation of a child playbook.
11575
+ # Stores metadata of the invocation of a child playbook. Playbook invocation
11576
+ # actions enter the child playbook.
11000
11577
  class GoogleCloudDialogflowCxV3beta1PlaybookInvocation
11001
11578
  include Google::Apis::Core::Hashable
11002
11579
 
@@ -11054,6 +11631,11 @@ module Google
11054
11631
  # @return [String]
11055
11632
  attr_accessor :execution_summary
11056
11633
 
11634
+ # End state of the playbook.
11635
+ # Corresponds to the JSON property `state`
11636
+ # @return [String]
11637
+ attr_accessor :state
11638
+
11057
11639
  def initialize(**args)
11058
11640
  update!(**args)
11059
11641
  end
@@ -11062,6 +11644,7 @@ module Google
11062
11644
  def update!(**args)
11063
11645
  @action_parameters = args[:action_parameters] if args.key?(:action_parameters)
11064
11646
  @execution_summary = args[:execution_summary] if args.key?(:execution_summary)
11647
+ @state = args[:state] if args.key?(:state)
11065
11648
  end
11066
11649
  end
11067
11650
 
@@ -11100,6 +11683,11 @@ module Google
11100
11683
  # @return [String]
11101
11684
  attr_accessor :display_name
11102
11685
 
11686
+ # A list of input parameters for the action.
11687
+ # Corresponds to the JSON property `inputActionParameters`
11688
+ # @return [Hash<String,Object>]
11689
+ attr_accessor :input_action_parameters
11690
+
11103
11691
  # Required. The unique identifier of the playbook. Format: `projects//locations//
11104
11692
  # agents//playbooks/`.
11105
11693
  # Corresponds to the JSON property `playbook`
@@ -11113,6 +11701,7 @@ module Google
11113
11701
  # Update properties of this object
11114
11702
  def update!(**args)
11115
11703
  @display_name = args[:display_name] if args.key?(:display_name)
11704
+ @input_action_parameters = args[:input_action_parameters] if args.key?(:input_action_parameters)
11116
11705
  @playbook = args[:playbook] if args.key?(:playbook)
11117
11706
  end
11118
11707
  end
@@ -12098,6 +12687,43 @@ module Google
12098
12687
  end
12099
12688
  end
12100
12689
 
12690
+ # The request message for Playbooks.RestorePlaybookVersion.
12691
+ class GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest
12692
+ include Google::Apis::Core::Hashable
12693
+
12694
+ def initialize(**args)
12695
+ update!(**args)
12696
+ end
12697
+
12698
+ # Update properties of this object
12699
+ def update!(**args)
12700
+ end
12701
+ end
12702
+
12703
+ # The response message for Playbooks.RestorePlaybookVersion.
12704
+ class GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse
12705
+ include Google::Apis::Core::Hashable
12706
+
12707
+ # Playbook is the basic building block to instruct the LLM how to execute a
12708
+ # certain task. A playbook consists of a goal to accomplish, an optional list of
12709
+ # step by step instructions (the step instruction may refers to name of the
12710
+ # custom or default plugin tools to use) to perform the task, a list of
12711
+ # contextual input data to be passed in at the beginning of the invoked, and a
12712
+ # list of output parameters to store the playbook result.
12713
+ # Corresponds to the JSON property `playbook`
12714
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook]
12715
+ attr_accessor :playbook
12716
+
12717
+ def initialize(**args)
12718
+ update!(**args)
12719
+ end
12720
+
12721
+ # Update properties of this object
12722
+ def update!(**args)
12723
+ @playbook = args[:playbook] if args.key?(:playbook)
12724
+ end
12725
+ end
12726
+
12101
12727
  # The request message for Tools.RestoreToolVersion.
12102
12728
  class GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest
12103
12729
  include Google::Apis::Core::Hashable
@@ -12707,6 +13333,49 @@ module Google
12707
13333
  end
12708
13334
  end
12709
13335
 
13336
+ # A span represents a sub execution step of an action.
13337
+ class GoogleCloudDialogflowCxV3beta1Span
13338
+ include Google::Apis::Core::Hashable
13339
+
13340
+ # Timestamp of the completion of the span.
13341
+ # Corresponds to the JSON property `completeTime`
13342
+ # @return [String]
13343
+ attr_accessor :complete_time
13344
+
13345
+ # The unordered collection of metrics in this span.
13346
+ # Corresponds to the JSON property `metrics`
13347
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1NamedMetric>]
13348
+ attr_accessor :metrics
13349
+
13350
+ # The name of the span.
13351
+ # Corresponds to the JSON property `name`
13352
+ # @return [String]
13353
+ attr_accessor :name
13354
+
13355
+ # Timestamp of the start of the span.
13356
+ # Corresponds to the JSON property `startTime`
13357
+ # @return [String]
13358
+ attr_accessor :start_time
13359
+
13360
+ # The metadata tags of the span such as span type.
13361
+ # Corresponds to the JSON property `tags`
13362
+ # @return [Array<String>]
13363
+ attr_accessor :tags
13364
+
13365
+ def initialize(**args)
13366
+ update!(**args)
13367
+ end
13368
+
13369
+ # Update properties of this object
13370
+ def update!(**args)
13371
+ @complete_time = args[:complete_time] if args.key?(:complete_time)
13372
+ @metrics = args[:metrics] if args.key?(:metrics)
13373
+ @name = args[:name] if args.key?(:name)
13374
+ @start_time = args[:start_time] if args.key?(:start_time)
13375
+ @tags = args[:tags] if args.key?(:tags)
13376
+ end
13377
+ end
13378
+
12710
13379
  # Settings related to speech recognition.
12711
13380
  class GoogleCloudDialogflowCxV3beta1SpeechToTextSettings
12712
13381
  include Google::Apis::Core::Hashable
@@ -12740,6 +13409,25 @@ module Google
12740
13409
  end
12741
13410
  end
12742
13411
 
13412
+ # The status of the action.
13413
+ class GoogleCloudDialogflowCxV3beta1Status
13414
+ include Google::Apis::Core::Hashable
13415
+
13416
+ # Exception thrown during the execution of an action.
13417
+ # Corresponds to the JSON property `exception`
13418
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Exception]
13419
+ attr_accessor :exception
13420
+
13421
+ def initialize(**args)
13422
+ update!(**args)
13423
+ end
13424
+
13425
+ # Update properties of this object
13426
+ def update!(**args)
13427
+ @exception = args[:exception] if args.key?(:exception)
13428
+ end
13429
+ end
13430
+
12743
13431
  # The request message for Experiments.StopExperiment.
12744
13432
  class GoogleCloudDialogflowCxV3beta1StopExperimentRequest
12745
13433
  include Google::Apis::Core::Hashable
@@ -13263,6 +13951,13 @@ module Google
13263
13951
  # @return [String]
13264
13952
  attr_accessor :request_location
13265
13953
 
13954
+ # Optional. The name of the SecretManager secret version resource storing the
13955
+ # API key. If this field is set, the `api_key` field will be ignored. Format: `
13956
+ # projects/`project`/secrets/`secret`/versions/`version``
13957
+ # Corresponds to the JSON property `secretVersionForApiKey`
13958
+ # @return [String]
13959
+ attr_accessor :secret_version_for_api_key
13960
+
13266
13961
  def initialize(**args)
13267
13962
  update!(**args)
13268
13963
  end
@@ -13272,6 +13967,7 @@ module Google
13272
13967
  @api_key = args[:api_key] if args.key?(:api_key)
13273
13968
  @key_name = args[:key_name] if args.key?(:key_name)
13274
13969
  @request_location = args[:request_location] if args.key?(:request_location)
13970
+ @secret_version_for_api_key = args[:secret_version_for_api_key] if args.key?(:secret_version_for_api_key)
13275
13971
  end
13276
13972
  end
13277
13973
 
@@ -13279,6 +13975,13 @@ module Google
13279
13975
  class GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig
13280
13976
  include Google::Apis::Core::Hashable
13281
13977
 
13978
+ # Optional. The name of the SecretManager secret version resource storing the
13979
+ # Bearer token. If this field is set, the `token` field will be ignored. Format:
13980
+ # `projects/`project`/secrets/`secret`/versions/`version``
13981
+ # Corresponds to the JSON property `secretVersionForToken`
13982
+ # @return [String]
13983
+ attr_accessor :secret_version_for_token
13984
+
13282
13985
  # Optional. The text token appended to the text `Bearer` to the request
13283
13986
  # Authorization header. [Session parameters reference](https://cloud.google.com/
13284
13987
  # dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the
@@ -13293,6 +13996,7 @@ module Google
13293
13996
 
13294
13997
  # Update properties of this object
13295
13998
  def update!(**args)
13999
+ @secret_version_for_token = args[:secret_version_for_token] if args.key?(:secret_version_for_token)
13296
14000
  @token = args[:token] if args.key?(:token)
13297
14001
  end
13298
14002
  end
@@ -13322,6 +14026,13 @@ module Google
13322
14026
  # @return [Array<String>]
13323
14027
  attr_accessor :scopes
13324
14028
 
14029
+ # Optional. The name of the SecretManager secret version resource storing the
14030
+ # client secret. If this field is set, the `client_secret` field will be ignored.
14031
+ # Format: `projects/`project`/secrets/`secret`/versions/`version``
14032
+ # Corresponds to the JSON property `secretVersionForClientSecret`
14033
+ # @return [String]
14034
+ attr_accessor :secret_version_for_client_secret
14035
+
13325
14036
  # Required. The token endpoint in the OAuth provider to exchange for an access
13326
14037
  # token.
13327
14038
  # Corresponds to the JSON property `tokenEndpoint`
@@ -13338,6 +14049,7 @@ module Google
13338
14049
  @client_secret = args[:client_secret] if args.key?(:client_secret)
13339
14050
  @oauth_grant_type = args[:oauth_grant_type] if args.key?(:oauth_grant_type)
13340
14051
  @scopes = args[:scopes] if args.key?(:scopes)
14052
+ @secret_version_for_client_secret = args[:secret_version_for_client_secret] if args.key?(:secret_version_for_client_secret)
13341
14053
  @token_endpoint = args[:token_endpoint] if args.key?(:token_endpoint)
13342
14054
  end
13343
14055
  end
@@ -13849,6 +14561,11 @@ module Google
13849
14561
  # @return [String]
13850
14562
  attr_accessor :action
13851
14563
 
14564
+ # The tracing information for the data store tool.
14565
+ # Corresponds to the JSON property `dataStoreToolTrace`
14566
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUseDataStoreToolTrace]
14567
+ attr_accessor :data_store_tool_trace
14568
+
13852
14569
  # Output only. The display name of the tool.
13853
14570
  # Corresponds to the JSON property `displayName`
13854
14571
  # @return [String]
@@ -13870,6 +14587,11 @@ module Google
13870
14587
  # @return [String]
13871
14588
  attr_accessor :tool
13872
14589
 
14590
+ # The tracing information for the webhook tool.
14591
+ # Corresponds to the JSON property `webhookToolTrace`
14592
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUseWebhookToolTrace]
14593
+ attr_accessor :webhook_tool_trace
14594
+
13873
14595
  def initialize(**args)
13874
14596
  update!(**args)
13875
14597
  end
@@ -13877,10 +14599,59 @@ module Google
13877
14599
  # Update properties of this object
13878
14600
  def update!(**args)
13879
14601
  @action = args[:action] if args.key?(:action)
14602
+ @data_store_tool_trace = args[:data_store_tool_trace] if args.key?(:data_store_tool_trace)
13880
14603
  @display_name = args[:display_name] if args.key?(:display_name)
13881
14604
  @input_action_parameters = args[:input_action_parameters] if args.key?(:input_action_parameters)
13882
14605
  @output_action_parameters = args[:output_action_parameters] if args.key?(:output_action_parameters)
13883
14606
  @tool = args[:tool] if args.key?(:tool)
14607
+ @webhook_tool_trace = args[:webhook_tool_trace] if args.key?(:webhook_tool_trace)
14608
+ end
14609
+ end
14610
+
14611
+ # The tracing information for the data store tool.
14612
+ class GoogleCloudDialogflowCxV3beta1ToolUseDataStoreToolTrace
14613
+ include Google::Apis::Core::Hashable
14614
+
14615
+ # Data store connection feature output signals. Might be only partially field if
14616
+ # processing stop before the final answer. Reasons for this can be, but are not
14617
+ # limited to: empty UCS search results, positive RAI check outcome, grounding
14618
+ # failure, ...
14619
+ # Corresponds to the JSON property `dataStoreConnectionSignals`
14620
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals]
14621
+ attr_accessor :data_store_connection_signals
14622
+
14623
+ def initialize(**args)
14624
+ update!(**args)
14625
+ end
14626
+
14627
+ # Update properties of this object
14628
+ def update!(**args)
14629
+ @data_store_connection_signals = args[:data_store_connection_signals] if args.key?(:data_store_connection_signals)
14630
+ end
14631
+ end
14632
+
14633
+ # The tracing information for the webhook tool.
14634
+ class GoogleCloudDialogflowCxV3beta1ToolUseWebhookToolTrace
14635
+ include Google::Apis::Core::Hashable
14636
+
14637
+ # Optional. The tag of the webhook.
14638
+ # Corresponds to the JSON property `webhookTag`
14639
+ # @return [String]
14640
+ attr_accessor :webhook_tag
14641
+
14642
+ # Optional. The url of the webhook.
14643
+ # Corresponds to the JSON property `webhookUri`
14644
+ # @return [String]
14645
+ attr_accessor :webhook_uri
14646
+
14647
+ def initialize(**args)
14648
+ update!(**args)
14649
+ end
14650
+
14651
+ # Update properties of this object
14652
+ def update!(**args)
14653
+ @webhook_tag = args[:webhook_tag] if args.key?(:webhook_tag)
14654
+ @webhook_uri = args[:webhook_uri] if args.key?(:webhook_uri)
13884
14655
  end
13885
14656
  end
13886
14657
 
@@ -14424,6 +15195,17 @@ module Google
14424
15195
  class GoogleCloudDialogflowCxV3beta1UserUtterance
14425
15196
  include Google::Apis::Core::Hashable
14426
15197
 
15198
+ # Optional. Audio input.
15199
+ # Corresponds to the JSON property `audio`
15200
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
15201
+ # @return [String]
15202
+ attr_accessor :audio
15203
+
15204
+ # Optional. Tokens of the audio input.
15205
+ # Corresponds to the JSON property `audioTokens`
15206
+ # @return [Array<Fixnum>]
15207
+ attr_accessor :audio_tokens
15208
+
14427
15209
  # Required. Message content in text.
14428
15210
  # Corresponds to the JSON property `text`
14429
15211
  # @return [String]
@@ -14435,6 +15217,8 @@ module Google
14435
15217
 
14436
15218
  # Update properties of this object
14437
15219
  def update!(**args)
15220
+ @audio = args[:audio] if args.key?(:audio)
15221
+ @audio_tokens = args[:audio_tokens] if args.key?(:audio_tokens)
14438
15222
  @text = args[:text] if args.key?(:text)
14439
15223
  end
14440
15224
  end
@@ -14791,6 +15575,22 @@ module Google
14791
15575
  # @return [Hash<String,String>]
14792
15576
  attr_accessor :request_headers
14793
15577
 
15578
+ # Optional. The SecretManager secret version resource storing the username:
15579
+ # password pair for HTTP Basic authentication. Format: `projects/`project`/
15580
+ # secrets/`secret`/versions/`version``
15581
+ # Corresponds to the JSON property `secretVersionForUsernamePassword`
15582
+ # @return [String]
15583
+ attr_accessor :secret_version_for_username_password
15584
+
15585
+ # Optional. The HTTP request headers to send together with webhook requests.
15586
+ # Header values are stored in SecretManager secret versions. When the same
15587
+ # header name is specified in both `request_headers` and `
15588
+ # secret_versions_for_request_headers`, the value in `
15589
+ # secret_versions_for_request_headers` will be used.
15590
+ # Corresponds to the JSON property `secretVersionsForRequestHeaders`
15591
+ # @return [Hash<String,Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue>]
15592
+ attr_accessor :secret_versions_for_request_headers
15593
+
14794
15594
  # Optional. Indicate the auth token type generated from the [Diglogflow service
14795
15595
  # agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-
14796
15596
  # agent). The generated token is sent in the Authorization header.
@@ -14827,6 +15627,8 @@ module Google
14827
15627
  @password = args[:password] if args.key?(:password)
14828
15628
  @request_body = args[:request_body] if args.key?(:request_body)
14829
15629
  @request_headers = args[:request_headers] if args.key?(:request_headers)
15630
+ @secret_version_for_username_password = args[:secret_version_for_username_password] if args.key?(:secret_version_for_username_password)
15631
+ @secret_versions_for_request_headers = args[:secret_versions_for_request_headers] if args.key?(:secret_versions_for_request_headers)
14830
15632
  @service_agent_auth = args[:service_agent_auth] if args.key?(:service_agent_auth)
14831
15633
  @uri = args[:uri] if args.key?(:uri)
14832
15634
  @username = args[:username] if args.key?(:username)
@@ -14854,6 +15656,13 @@ module Google
14854
15656
  # @return [Array<String>]
14855
15657
  attr_accessor :scopes
14856
15658
 
15659
+ # Optional. The name of the SecretManager secret version resource storing the
15660
+ # client secret. If this field is set, the `client_secret` field will be ignored.
15661
+ # Format: `projects/`project`/secrets/`secret`/versions/`version``
15662
+ # Corresponds to the JSON property `secretVersionForClientSecret`
15663
+ # @return [String]
15664
+ attr_accessor :secret_version_for_client_secret
15665
+
14857
15666
  # Required. The token endpoint provided by the 3rd party platform to exchange an
14858
15667
  # access token.
14859
15668
  # Corresponds to the JSON property `tokenEndpoint`
@@ -14869,10 +15678,32 @@ module Google
14869
15678
  @client_id = args[:client_id] if args.key?(:client_id)
14870
15679
  @client_secret = args[:client_secret] if args.key?(:client_secret)
14871
15680
  @scopes = args[:scopes] if args.key?(:scopes)
15681
+ @secret_version_for_client_secret = args[:secret_version_for_client_secret] if args.key?(:secret_version_for_client_secret)
14872
15682
  @token_endpoint = args[:token_endpoint] if args.key?(:token_endpoint)
14873
15683
  end
14874
15684
  end
14875
15685
 
15686
+ # Represents the value of an HTTP header stored in a SecretManager secret
15687
+ # version.
15688
+ class GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue
15689
+ include Google::Apis::Core::Hashable
15690
+
15691
+ # Required. The SecretManager secret version resource storing the header value.
15692
+ # Format: `projects/`project`/secrets/`secret`/versions/`version``
15693
+ # Corresponds to the JSON property `secretVersion`
15694
+ # @return [String]
15695
+ attr_accessor :secret_version
15696
+
15697
+ def initialize(**args)
15698
+ update!(**args)
15699
+ end
15700
+
15701
+ # Update properties of this object
15702
+ def update!(**args)
15703
+ @secret_version = args[:secret_version] if args.key?(:secret_version)
15704
+ end
15705
+ end
15706
+
14876
15707
  # The request message for a webhook call. The request is sent as a JSON object
14877
15708
  # and the field names will be presented in camel cases. You may see undocumented
14878
15709
  # fields in an actual request. These fields are used internally by Dialogflow
@@ -16151,6 +16982,11 @@ module Google
16151
16982
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SummarySuggestion]
16152
16983
  attr_accessor :summary_suggestion
16153
16984
 
16985
+ # Optional. List of request and response for tool calls executed.
16986
+ # Corresponds to the JSON property `toolCallInfo`
16987
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo>]
16988
+ attr_accessor :tool_call_info
16989
+
16154
16990
  def initialize(**args)
16155
16991
  update!(**args)
16156
16992
  end
@@ -16159,6 +16995,32 @@ module Google
16159
16995
  def update!(**args)
16160
16996
  @free_form_suggestion = args[:free_form_suggestion] if args.key?(:free_form_suggestion)
16161
16997
  @summary_suggestion = args[:summary_suggestion] if args.key?(:summary_suggestion)
16998
+ @tool_call_info = args[:tool_call_info] if args.key?(:tool_call_info)
16999
+ end
17000
+ end
17001
+
17002
+ # Request and response for a tool call.
17003
+ class GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo
17004
+ include Google::Apis::Core::Hashable
17005
+
17006
+ # Represents a call of a specific tool's action with the specified inputs.
17007
+ # Corresponds to the JSON property `toolCall`
17008
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2ToolCall]
17009
+ attr_accessor :tool_call
17010
+
17011
+ # The result of calling a tool's action.
17012
+ # Corresponds to the JSON property `toolCallResult`
17013
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2ToolCallResult]
17014
+ attr_accessor :tool_call_result
17015
+
17016
+ def initialize(**args)
17017
+ update!(**args)
17018
+ end
17019
+
17020
+ # Update properties of this object
17021
+ def update!(**args)
17022
+ @tool_call = args[:tool_call] if args.key?(:tool_call)
17023
+ @tool_call_result = args[:tool_call_result] if args.key?(:tool_call_result)
16162
17024
  end
16163
17025
  end
16164
17026
 
@@ -18648,6 +19510,115 @@ module Google
18648
19510
  end
18649
19511
  end
18650
19512
 
19513
+ # Represents a call of a specific tool's action with the specified inputs.
19514
+ class GoogleCloudDialogflowV2ToolCall
19515
+ include Google::Apis::Core::Hashable
19516
+
19517
+ # Required. The name of the tool's action associated with this call.
19518
+ # Corresponds to the JSON property `action`
19519
+ # @return [String]
19520
+ attr_accessor :action
19521
+
19522
+ # Output only. Create time of the tool call.
19523
+ # Corresponds to the JSON property `createTime`
19524
+ # @return [String]
19525
+ attr_accessor :create_time
19526
+
19527
+ # Optional. The action's input parameters.
19528
+ # Corresponds to the JSON property `inputParameters`
19529
+ # @return [Hash<String,Object>]
19530
+ attr_accessor :input_parameters
19531
+
19532
+ # Required. The tool associated with this call. Format: `projects//locations//
19533
+ # tools/`.
19534
+ # Corresponds to the JSON property `tool`
19535
+ # @return [String]
19536
+ attr_accessor :tool
19537
+
19538
+ def initialize(**args)
19539
+ update!(**args)
19540
+ end
19541
+
19542
+ # Update properties of this object
19543
+ def update!(**args)
19544
+ @action = args[:action] if args.key?(:action)
19545
+ @create_time = args[:create_time] if args.key?(:create_time)
19546
+ @input_parameters = args[:input_parameters] if args.key?(:input_parameters)
19547
+ @tool = args[:tool] if args.key?(:tool)
19548
+ end
19549
+ end
19550
+
19551
+ # The result of calling a tool's action.
19552
+ class GoogleCloudDialogflowV2ToolCallResult
19553
+ include Google::Apis::Core::Hashable
19554
+
19555
+ # Required. The name of the tool's action associated with this call.
19556
+ # Corresponds to the JSON property `action`
19557
+ # @return [String]
19558
+ attr_accessor :action
19559
+
19560
+ # Only populated if the response content is utf-8 encoded.
19561
+ # Corresponds to the JSON property `content`
19562
+ # @return [String]
19563
+ attr_accessor :content
19564
+
19565
+ # Output only. Create time of the tool call result.
19566
+ # Corresponds to the JSON property `createTime`
19567
+ # @return [String]
19568
+ attr_accessor :create_time
19569
+
19570
+ # An error produced by the tool call.
19571
+ # Corresponds to the JSON property `error`
19572
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2ToolCallResultError]
19573
+ attr_accessor :error
19574
+
19575
+ # Only populated if the response content is not utf-8 encoded. (by definition
19576
+ # byte fields are base64 encoded).
19577
+ # Corresponds to the JSON property `rawContent`
19578
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
19579
+ # @return [String]
19580
+ attr_accessor :raw_content
19581
+
19582
+ # Required. The tool associated with this call. Format: `projects//locations//
19583
+ # tools/`.
19584
+ # Corresponds to the JSON property `tool`
19585
+ # @return [String]
19586
+ attr_accessor :tool
19587
+
19588
+ def initialize(**args)
19589
+ update!(**args)
19590
+ end
19591
+
19592
+ # Update properties of this object
19593
+ def update!(**args)
19594
+ @action = args[:action] if args.key?(:action)
19595
+ @content = args[:content] if args.key?(:content)
19596
+ @create_time = args[:create_time] if args.key?(:create_time)
19597
+ @error = args[:error] if args.key?(:error)
19598
+ @raw_content = args[:raw_content] if args.key?(:raw_content)
19599
+ @tool = args[:tool] if args.key?(:tool)
19600
+ end
19601
+ end
19602
+
19603
+ # An error produced by the tool call.
19604
+ class GoogleCloudDialogflowV2ToolCallResultError
19605
+ include Google::Apis::Core::Hashable
19606
+
19607
+ # Optional. The error message of the function.
19608
+ # Corresponds to the JSON property `message`
19609
+ # @return [String]
19610
+ attr_accessor :message
19611
+
19612
+ def initialize(**args)
19613
+ update!(**args)
19614
+ end
19615
+
19616
+ # Update properties of this object
19617
+ def update!(**args)
19618
+ @message = args[:message] if args.key?(:message)
19619
+ end
19620
+ end
19621
+
18651
19622
  # Metadata for a ConversationModels.UndeployConversationModel operation.
18652
19623
  class GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata
18653
19624
  include Google::Apis::Core::Hashable
@@ -19511,6 +20482,11 @@ module Google
19511
20482
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SummarySuggestion]
19512
20483
  attr_accessor :summary_suggestion
19513
20484
 
20485
+ # Optional. List of request and response for tool calls executed.
20486
+ # Corresponds to the JSON property `toolCallInfo`
20487
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo>]
20488
+ attr_accessor :tool_call_info
20489
+
19514
20490
  def initialize(**args)
19515
20491
  update!(**args)
19516
20492
  end
@@ -19519,6 +20495,32 @@ module Google
19519
20495
  def update!(**args)
19520
20496
  @free_form_suggestion = args[:free_form_suggestion] if args.key?(:free_form_suggestion)
19521
20497
  @summary_suggestion = args[:summary_suggestion] if args.key?(:summary_suggestion)
20498
+ @tool_call_info = args[:tool_call_info] if args.key?(:tool_call_info)
20499
+ end
20500
+ end
20501
+
20502
+ # Request and response for a tool call.
20503
+ class GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo
20504
+ include Google::Apis::Core::Hashable
20505
+
20506
+ # Represents a call of a specific tool's action with the specified inputs.
20507
+ # Corresponds to the JSON property `toolCall`
20508
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1ToolCall]
20509
+ attr_accessor :tool_call
20510
+
20511
+ # The result of calling a tool's action.
20512
+ # Corresponds to the JSON property `toolCallResult`
20513
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1ToolCallResult]
20514
+ attr_accessor :tool_call_result
20515
+
20516
+ def initialize(**args)
20517
+ update!(**args)
20518
+ end
20519
+
20520
+ # Update properties of this object
20521
+ def update!(**args)
20522
+ @tool_call = args[:tool_call] if args.key?(:tool_call)
20523
+ @tool_call_result = args[:tool_call_result] if args.key?(:tool_call_result)
19522
20524
  end
19523
20525
  end
19524
20526
 
@@ -22792,6 +23794,115 @@ module Google
22792
23794
  end
22793
23795
  end
22794
23796
 
23797
+ # Represents a call of a specific tool's action with the specified inputs.
23798
+ class GoogleCloudDialogflowV2beta1ToolCall
23799
+ include Google::Apis::Core::Hashable
23800
+
23801
+ # Required. The name of the tool's action associated with this call.
23802
+ # Corresponds to the JSON property `action`
23803
+ # @return [String]
23804
+ attr_accessor :action
23805
+
23806
+ # Output only. Create time of the tool call.
23807
+ # Corresponds to the JSON property `createTime`
23808
+ # @return [String]
23809
+ attr_accessor :create_time
23810
+
23811
+ # Optional. The action's input parameters.
23812
+ # Corresponds to the JSON property `inputParameters`
23813
+ # @return [Hash<String,Object>]
23814
+ attr_accessor :input_parameters
23815
+
23816
+ # Required. The tool associated with this call. Format: `projects//locations//
23817
+ # tools/`.
23818
+ # Corresponds to the JSON property `tool`
23819
+ # @return [String]
23820
+ attr_accessor :tool
23821
+
23822
+ def initialize(**args)
23823
+ update!(**args)
23824
+ end
23825
+
23826
+ # Update properties of this object
23827
+ def update!(**args)
23828
+ @action = args[:action] if args.key?(:action)
23829
+ @create_time = args[:create_time] if args.key?(:create_time)
23830
+ @input_parameters = args[:input_parameters] if args.key?(:input_parameters)
23831
+ @tool = args[:tool] if args.key?(:tool)
23832
+ end
23833
+ end
23834
+
23835
+ # The result of calling a tool's action.
23836
+ class GoogleCloudDialogflowV2beta1ToolCallResult
23837
+ include Google::Apis::Core::Hashable
23838
+
23839
+ # Required. The name of the tool's action associated with this call.
23840
+ # Corresponds to the JSON property `action`
23841
+ # @return [String]
23842
+ attr_accessor :action
23843
+
23844
+ # Only populated if the response content is utf-8 encoded.
23845
+ # Corresponds to the JSON property `content`
23846
+ # @return [String]
23847
+ attr_accessor :content
23848
+
23849
+ # Output only. Create time of the tool call result.
23850
+ # Corresponds to the JSON property `createTime`
23851
+ # @return [String]
23852
+ attr_accessor :create_time
23853
+
23854
+ # An error produced by the tool call.
23855
+ # Corresponds to the JSON property `error`
23856
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1ToolCallResultError]
23857
+ attr_accessor :error
23858
+
23859
+ # Only populated if the response content is not utf-8 encoded. (by definition
23860
+ # byte fields are base64 encoded).
23861
+ # Corresponds to the JSON property `rawContent`
23862
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
23863
+ # @return [String]
23864
+ attr_accessor :raw_content
23865
+
23866
+ # Required. The tool associated with this call. Format: `projects//locations//
23867
+ # tools/`.
23868
+ # Corresponds to the JSON property `tool`
23869
+ # @return [String]
23870
+ attr_accessor :tool
23871
+
23872
+ def initialize(**args)
23873
+ update!(**args)
23874
+ end
23875
+
23876
+ # Update properties of this object
23877
+ def update!(**args)
23878
+ @action = args[:action] if args.key?(:action)
23879
+ @content = args[:content] if args.key?(:content)
23880
+ @create_time = args[:create_time] if args.key?(:create_time)
23881
+ @error = args[:error] if args.key?(:error)
23882
+ @raw_content = args[:raw_content] if args.key?(:raw_content)
23883
+ @tool = args[:tool] if args.key?(:tool)
23884
+ end
23885
+ end
23886
+
23887
+ # An error produced by the tool call.
23888
+ class GoogleCloudDialogflowV2beta1ToolCallResultError
23889
+ include Google::Apis::Core::Hashable
23890
+
23891
+ # Optional. The error message of the function.
23892
+ # Corresponds to the JSON property `message`
23893
+ # @return [String]
23894
+ attr_accessor :message
23895
+
23896
+ def initialize(**args)
23897
+ update!(**args)
23898
+ end
23899
+
23900
+ # Update properties of this object
23901
+ def update!(**args)
23902
+ @message = args[:message] if args.key?(:message)
23903
+ end
23904
+ end
23905
+
22795
23906
  # The request message for a webhook call.
22796
23907
  class GoogleCloudDialogflowV2beta1WebhookRequest
22797
23908
  include Google::Apis::Core::Hashable