google-apis-dialogflow_v3beta1 0.98.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.
@@ -3816,23 +3816,51 @@ module Google
3816
3816
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentUtterance]
3817
3817
  attr_accessor :agent_utterance
3818
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
+
3819
3829
  # Event represents the event sent by the customer.
3820
3830
  # Corresponds to the JSON property `event`
3821
3831
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Event]
3822
3832
  attr_accessor :event
3823
3833
 
3824
- # 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.
3825
3836
  # Corresponds to the JSON property `flowInvocation`
3826
3837
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowInvocation]
3827
3838
  attr_accessor :flow_invocation
3828
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
+
3829
3846
  # Stores metadata of the transition to a target CX flow. Flow transition actions
3830
3847
  # exit the caller playbook and enter the child flow.
3831
3848
  # Corresponds to the JSON property `flowTransition`
3832
3849
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowTransition]
3833
3850
  attr_accessor :flow_transition
3834
3851
 
3835
- # 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.
3836
3864
  # Corresponds to the JSON property `playbookInvocation`
3837
3865
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookInvocation]
3838
3866
  attr_accessor :playbook_invocation
@@ -3843,11 +3871,37 @@ module Google
3843
3871
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookTransition]
3844
3872
  attr_accessor :playbook_transition
3845
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
+
3846
3895
  # Stores metadata of the invocation of an action supported by a tool.
3847
3896
  # Corresponds to the JSON property `toolUse`
3848
3897
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUse]
3849
3898
  attr_accessor :tool_use
3850
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
+
3851
3905
  # UserUtterance represents one message sent by the customer.
3852
3906
  # Corresponds to the JSON property `userUtterance`
3853
3907
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1UserUtterance]
@@ -3860,16 +3914,203 @@ module Google
3860
3914
  # Update properties of this object
3861
3915
  def update!(**args)
3862
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)
3863
3919
  @event = args[:event] if args.key?(:event)
3864
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)
3865
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)
3866
3925
  @playbook_invocation = args[:playbook_invocation] if args.key?(:playbook_invocation)
3867
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)
3868
3931
  @tool_use = args[:tool_use] if args.key?(:tool_use)
3932
+ @tts = args[:tts] if args.key?(:tts)
3869
3933
  @user_utterance = args[:user_utterance] if args.key?(:user_utterance)
3870
3934
  end
3871
3935
  end
3872
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
+
3873
4114
  # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
3874
4115
  # Settings exposed at lower level overrides the settings exposed at higher level.
3875
4116
  # Overriding occurs at the sub-setting level. For example, the
@@ -4464,6 +4705,15 @@ module Google
4464
4705
  class GoogleCloudDialogflowCxV3beta1AgentUtterance
4465
4706
  include Google::Apis::Core::Hashable
4466
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
+
4467
4717
  # Required. Message content in text.
4468
4718
  # Corresponds to the JSON property `text`
4469
4719
  # @return [String]
@@ -4475,6 +4725,7 @@ module Google
4475
4725
 
4476
4726
  # Update properties of this object
4477
4727
  def update!(**args)
4728
+ @require_generation = args[:require_generation] if args.key?(:require_generation)
4478
4729
  @text = args[:text] if args.key?(:text)
4479
4730
  end
4480
4731
  end
@@ -6600,6 +6851,11 @@ module Google
6600
6851
  # @return [String]
6601
6852
  attr_accessor :event
6602
6853
 
6854
+ # Optional. Unstructured text payload of the event.
6855
+ # Corresponds to the JSON property `text`
6856
+ # @return [String]
6857
+ attr_accessor :text
6858
+
6603
6859
  def initialize(**args)
6604
6860
  update!(**args)
6605
6861
  end
@@ -6607,6 +6863,7 @@ module Google
6607
6863
  # Update properties of this object
6608
6864
  def update!(**args)
6609
6865
  @event = args[:event] if args.key?(:event)
6866
+ @text = args[:text] if args.key?(:text)
6610
6867
  end
6611
6868
  end
6612
6869
 
@@ -6780,6 +7037,25 @@ module Google
6780
7037
  end
6781
7038
  end
6782
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
+
6783
7059
  # Represents an experiment in an environment.
6784
7060
  class GoogleCloudDialogflowCxV3beta1Experiment
6785
7061
  include Google::Apis::Core::Hashable
@@ -7416,6 +7692,38 @@ module Google
7416
7692
  end
7417
7693
  end
7418
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
+
7419
7727
  # Metadata returned for the TestCases.ExportTestCases long running operation.
7420
7728
  # This message currently has no fields.
7421
7729
  class GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata
@@ -7717,7 +8025,8 @@ module Google
7717
8025
  end
7718
8026
  end
7719
8027
 
7720
- # 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.
7721
8030
  class GoogleCloudDialogflowCxV3beta1FlowInvocation
7722
8031
  include Google::Apis::Core::Hashable
7723
8032
 
@@ -7727,7 +8036,7 @@ module Google
7727
8036
  attr_accessor :display_name
7728
8037
 
7729
8038
  # Required. The unique identifier of the flow. Format: `projects//locations//
7730
- # agents//flows/`.
8039
+ # agents/`.
7731
8040
  # Corresponds to the JSON property `flow`
7732
8041
  # @return [String]
7733
8042
  attr_accessor :flow
@@ -7808,6 +8117,11 @@ module Google
7808
8117
  # @return [String]
7809
8118
  attr_accessor :flow
7810
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
+
7811
8125
  def initialize(**args)
7812
8126
  update!(**args)
7813
8127
  end
@@ -7816,6 +8130,7 @@ module Google
7816
8130
  def update!(**args)
7817
8131
  @display_name = args[:display_name] if args.key?(:display_name)
7818
8132
  @flow = args[:flow] if args.key?(:flow)
8133
+ @input_action_parameters = args[:input_action_parameters] if args.key?(:input_action_parameters)
7819
8134
  end
7820
8135
  end
7821
8136
 
@@ -9012,6 +9327,40 @@ module Google
9012
9327
  end
9013
9328
  end
9014
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
+
9015
9364
  # Metadata returned for the TestCases.ImportTestCases long running operation.
9016
9365
  class GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata
9017
9366
  include Google::Apis::Core::Hashable
@@ -10261,6 +10610,117 @@ module Google
10261
10610
  end
10262
10611
  end
10263
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
+
10264
10724
  # Settings for LLM models.
10265
10725
  class GoogleCloudDialogflowCxV3beta1LlmModelSettings
10266
10726
  include Google::Apis::Core::Hashable
@@ -10504,6 +10964,38 @@ module Google
10504
10964
  end
10505
10965
  end
10506
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
+
10507
10999
  # Settings related to NLU.
10508
11000
  class GoogleCloudDialogflowCxV3beta1NluSettings
10509
11001
  include Google::Apis::Core::Hashable
@@ -10990,6 +11482,43 @@ module Google
10990
11482
  end
10991
11483
  end
10992
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
+
10993
11522
  # Input of the playbook.
10994
11523
  class GoogleCloudDialogflowCxV3beta1PlaybookInput
10995
11524
  include Google::Apis::Core::Hashable
@@ -11043,7 +11572,8 @@ module Google
11043
11572
  end
11044
11573
  end
11045
11574
 
11046
- # 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.
11047
11577
  class GoogleCloudDialogflowCxV3beta1PlaybookInvocation
11048
11578
  include Google::Apis::Core::Hashable
11049
11579
 
@@ -11101,6 +11631,11 @@ module Google
11101
11631
  # @return [String]
11102
11632
  attr_accessor :execution_summary
11103
11633
 
11634
+ # End state of the playbook.
11635
+ # Corresponds to the JSON property `state`
11636
+ # @return [String]
11637
+ attr_accessor :state
11638
+
11104
11639
  def initialize(**args)
11105
11640
  update!(**args)
11106
11641
  end
@@ -11109,6 +11644,7 @@ module Google
11109
11644
  def update!(**args)
11110
11645
  @action_parameters = args[:action_parameters] if args.key?(:action_parameters)
11111
11646
  @execution_summary = args[:execution_summary] if args.key?(:execution_summary)
11647
+ @state = args[:state] if args.key?(:state)
11112
11648
  end
11113
11649
  end
11114
11650
 
@@ -11147,6 +11683,11 @@ module Google
11147
11683
  # @return [String]
11148
11684
  attr_accessor :display_name
11149
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
+
11150
11691
  # Required. The unique identifier of the playbook. Format: `projects//locations//
11151
11692
  # agents//playbooks/`.
11152
11693
  # Corresponds to the JSON property `playbook`
@@ -11160,6 +11701,7 @@ module Google
11160
11701
  # Update properties of this object
11161
11702
  def update!(**args)
11162
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)
11163
11705
  @playbook = args[:playbook] if args.key?(:playbook)
11164
11706
  end
11165
11707
  end
@@ -12145,6 +12687,43 @@ module Google
12145
12687
  end
12146
12688
  end
12147
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
+
12148
12727
  # The request message for Tools.RestoreToolVersion.
12149
12728
  class GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest
12150
12729
  include Google::Apis::Core::Hashable
@@ -12754,6 +13333,49 @@ module Google
12754
13333
  end
12755
13334
  end
12756
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
+
12757
13379
  # Settings related to speech recognition.
12758
13380
  class GoogleCloudDialogflowCxV3beta1SpeechToTextSettings
12759
13381
  include Google::Apis::Core::Hashable
@@ -12787,6 +13409,25 @@ module Google
12787
13409
  end
12788
13410
  end
12789
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
+
12790
13431
  # The request message for Experiments.StopExperiment.
12791
13432
  class GoogleCloudDialogflowCxV3beta1StopExperimentRequest
12792
13433
  include Google::Apis::Core::Hashable
@@ -13920,6 +14561,11 @@ module Google
13920
14561
  # @return [String]
13921
14562
  attr_accessor :action
13922
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
+
13923
14569
  # Output only. The display name of the tool.
13924
14570
  # Corresponds to the JSON property `displayName`
13925
14571
  # @return [String]
@@ -13941,6 +14587,11 @@ module Google
13941
14587
  # @return [String]
13942
14588
  attr_accessor :tool
13943
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
+
13944
14595
  def initialize(**args)
13945
14596
  update!(**args)
13946
14597
  end
@@ -13948,10 +14599,59 @@ module Google
13948
14599
  # Update properties of this object
13949
14600
  def update!(**args)
13950
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)
13951
14603
  @display_name = args[:display_name] if args.key?(:display_name)
13952
14604
  @input_action_parameters = args[:input_action_parameters] if args.key?(:input_action_parameters)
13953
14605
  @output_action_parameters = args[:output_action_parameters] if args.key?(:output_action_parameters)
13954
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)
13955
14655
  end
13956
14656
  end
13957
14657
 
@@ -14495,6 +15195,17 @@ module Google
14495
15195
  class GoogleCloudDialogflowCxV3beta1UserUtterance
14496
15196
  include Google::Apis::Core::Hashable
14497
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
+
14498
15209
  # Required. Message content in text.
14499
15210
  # Corresponds to the JSON property `text`
14500
15211
  # @return [String]
@@ -14506,6 +15217,8 @@ module Google
14506
15217
 
14507
15218
  # Update properties of this object
14508
15219
  def update!(**args)
15220
+ @audio = args[:audio] if args.key?(:audio)
15221
+ @audio_tokens = args[:audio_tokens] if args.key?(:audio_tokens)
14509
15222
  @text = args[:text] if args.key?(:text)
14510
15223
  end
14511
15224
  end