google-apis-dialogflow_v3beta1 0.86.0 → 0.87.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.
@@ -119,13 +119,13 @@ module Google
119
119
  class GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings
120
120
  include Google::Apis::Core::Hashable
121
121
 
122
- # If true, DF Interaction logging is currently enabled.
122
+ # Enables DF Interaction logging.
123
123
  # Corresponds to the JSON property `enableInteractionLogging`
124
124
  # @return [Boolean]
125
125
  attr_accessor :enable_interaction_logging
126
126
  alias_method :enable_interaction_logging?, :enable_interaction_logging
127
127
 
128
- # If true, StackDriver logging is currently enabled.
128
+ # Enables StackDriver logging.
129
129
  # Corresponds to the JSON property `enableStackdriverLogging`
130
130
  # @return [Boolean]
131
131
  attr_accessor :enable_stackdriver_logging
@@ -3868,6 +3868,49 @@ module Google
3868
3868
  end
3869
3869
  end
3870
3870
 
3871
+ # Action performed by end user or Dialogflow agent in the conversation.
3872
+ class GoogleCloudDialogflowCxV3beta1Action
3873
+ include Google::Apis::Core::Hashable
3874
+
3875
+ # AgentUtterance represents one message sent by the agent.
3876
+ # Corresponds to the JSON property `agentUtterance`
3877
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentUtterance]
3878
+ attr_accessor :agent_utterance
3879
+
3880
+ # Stores metadata of the invocation of a CX flow. Next Id: 7
3881
+ # Corresponds to the JSON property `flowInvocation`
3882
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowInvocation]
3883
+ attr_accessor :flow_invocation
3884
+
3885
+ # Stores metadata of the invocation of a child playbook. Next Id: 5
3886
+ # Corresponds to the JSON property `playbookInvocation`
3887
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookInvocation]
3888
+ attr_accessor :playbook_invocation
3889
+
3890
+ # Stores metadata of the invocation of an action supported by a tool.
3891
+ # Corresponds to the JSON property `toolUse`
3892
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUse]
3893
+ attr_accessor :tool_use
3894
+
3895
+ # UserUtterance represents one message sent by the customer.
3896
+ # Corresponds to the JSON property `userUtterance`
3897
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1UserUtterance]
3898
+ attr_accessor :user_utterance
3899
+
3900
+ def initialize(**args)
3901
+ update!(**args)
3902
+ end
3903
+
3904
+ # Update properties of this object
3905
+ def update!(**args)
3906
+ @agent_utterance = args[:agent_utterance] if args.key?(:agent_utterance)
3907
+ @flow_invocation = args[:flow_invocation] if args.key?(:flow_invocation)
3908
+ @playbook_invocation = args[:playbook_invocation] if args.key?(:playbook_invocation)
3909
+ @tool_use = args[:tool_use] if args.key?(:tool_use)
3910
+ @user_utterance = args[:user_utterance] if args.key?(:user_utterance)
3911
+ end
3912
+ end
3913
+
3871
3914
  # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
3872
3915
  # Settings exposed at lower level overrides the settings exposed at higher level.
3873
3916
  # Overriding occurs at the sub-setting level. For example, the
@@ -3965,13 +4008,13 @@ module Google
3965
4008
  class GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings
3966
4009
  include Google::Apis::Core::Hashable
3967
4010
 
3968
- # If true, DF Interaction logging is currently enabled.
4011
+ # Enables DF Interaction logging.
3969
4012
  # Corresponds to the JSON property `enableInteractionLogging`
3970
4013
  # @return [Boolean]
3971
4014
  attr_accessor :enable_interaction_logging
3972
4015
  alias_method :enable_interaction_logging?, :enable_interaction_logging
3973
4016
 
3974
- # If true, StackDriver logging is currently enabled.
4017
+ # Enables StackDriver logging.
3975
4018
  # Corresponds to the JSON property `enableStackdriverLogging`
3976
4019
  # @return [Boolean]
3977
4020
  attr_accessor :enable_stackdriver_logging
@@ -4143,13 +4186,23 @@ module Google
4143
4186
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SpeechToTextSettings]
4144
4187
  attr_accessor :speech_to_text_settings
4145
4188
 
4146
- # Immutable. Name of the start flow in this agent. A start flow will be
4147
- # automatically created when the agent is created, and can only be deleted by
4148
- # deleting the agent. Format: `projects//locations//agents//flows/`.
4189
+ # Name of the start flow in this agent. A start flow will be automatically
4190
+ # created when the agent is created, and can only be deleted by deleting the
4191
+ # agent. Format: `projects//locations//agents//flows/`. Currently only the
4192
+ # default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
4149
4193
  # Corresponds to the JSON property `startFlow`
4150
4194
  # @return [String]
4151
4195
  attr_accessor :start_flow
4152
4196
 
4197
+ # Name of the start playbook in this agent. A start playbook will be
4198
+ # automatically created when the agent is created, and can only be deleted by
4199
+ # deleting the agent. Format: `projects//locations//agents//playbooks/`.
4200
+ # Currently only the default playbook with id "00000000-0000-0000-0000-
4201
+ # 000000000000" is allowed.
4202
+ # Corresponds to the JSON property `startPlaybook`
4203
+ # @return [String]
4204
+ attr_accessor :start_playbook
4205
+
4153
4206
  # The list of all languages supported by the agent (except for the `
4154
4207
  # default_language_code`).
4155
4208
  # Corresponds to the JSON property `supportedLanguageCodes`
@@ -4190,6 +4243,7 @@ module Google
4190
4243
  @security_settings = args[:security_settings] if args.key?(:security_settings)
4191
4244
  @speech_to_text_settings = args[:speech_to_text_settings] if args.key?(:speech_to_text_settings)
4192
4245
  @start_flow = args[:start_flow] if args.key?(:start_flow)
4246
+ @start_playbook = args[:start_playbook] if args.key?(:start_playbook)
4193
4247
  @supported_language_codes = args[:supported_language_codes] if args.key?(:supported_language_codes)
4194
4248
  @text_to_speech_settings = args[:text_to_speech_settings] if args.key?(:text_to_speech_settings)
4195
4249
  @time_zone = args[:time_zone] if args.key?(:time_zone)
@@ -4324,6 +4378,25 @@ module Google
4324
4378
  end
4325
4379
  end
4326
4380
 
4381
+ # AgentUtterance represents one message sent by the agent.
4382
+ class GoogleCloudDialogflowCxV3beta1AgentUtterance
4383
+ include Google::Apis::Core::Hashable
4384
+
4385
+ # Required. Message content in text.
4386
+ # Corresponds to the JSON property `text`
4387
+ # @return [String]
4388
+ attr_accessor :text
4389
+
4390
+ def initialize(**args)
4391
+ update!(**args)
4392
+ end
4393
+
4394
+ # Update properties of this object
4395
+ def update!(**args)
4396
+ @text = args[:text] if args.key?(:text)
4397
+ end
4398
+ end
4399
+
4327
4400
  # The response message for Agents.GetAgentValidationResult.
4328
4401
  class GoogleCloudDialogflowCxV3beta1AgentValidationResult
4329
4402
  include Google::Apis::Core::Hashable
@@ -6376,6 +6449,93 @@ module Google
6376
6449
  end
6377
6450
  end
6378
6451
 
6452
+ # Example represents a sample execution of the playbook in the conversation. An
6453
+ # example consists of a list of ordered actions performed by end user or
6454
+ # Dialogflow agent according the playbook instructions to fulfill the task.
6455
+ class GoogleCloudDialogflowCxV3beta1Example
6456
+ include Google::Apis::Core::Hashable
6457
+
6458
+ # Required. The ordered list of actions performed by the end user and the
6459
+ # Dialogflow agent.
6460
+ # Corresponds to the JSON property `actions`
6461
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Action>]
6462
+ attr_accessor :actions
6463
+
6464
+ # Required. Example's output state.
6465
+ # Corresponds to the JSON property `conversationState`
6466
+ # @return [String]
6467
+ attr_accessor :conversation_state
6468
+
6469
+ # Output only. The timestamp of initial example creation.
6470
+ # Corresponds to the JSON property `createTime`
6471
+ # @return [String]
6472
+ attr_accessor :create_time
6473
+
6474
+ # Optional. The high level concise description of the example. The max number of
6475
+ # characters is 200.
6476
+ # Corresponds to the JSON property `description`
6477
+ # @return [String]
6478
+ attr_accessor :description
6479
+
6480
+ # Required. The display name of the example.
6481
+ # Corresponds to the JSON property `displayName`
6482
+ # @return [String]
6483
+ attr_accessor :display_name
6484
+
6485
+ # Optional. The language code of the example. If not specified, the agent's
6486
+ # default language is used. Note: languages must be enabled in the agent before
6487
+ # they can be used.
6488
+ # Corresponds to the JSON property `languageCode`
6489
+ # @return [String]
6490
+ attr_accessor :language_code
6491
+
6492
+ # The unique identifier of the playbook example. Format: `projects//locations//
6493
+ # agents//playbooks//examples/`.
6494
+ # Corresponds to the JSON property `name`
6495
+ # @return [String]
6496
+ attr_accessor :name
6497
+
6498
+ # Input of the playbook.
6499
+ # Corresponds to the JSON property `playbookInput`
6500
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookInput]
6501
+ attr_accessor :playbook_input
6502
+
6503
+ # Output of the playbook.
6504
+ # Corresponds to the JSON property `playbookOutput`
6505
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookOutput]
6506
+ attr_accessor :playbook_output
6507
+
6508
+ # Output only. Estimated number of tokes current example takes when sent to the
6509
+ # LLM.
6510
+ # Corresponds to the JSON property `tokenCount`
6511
+ # @return [Fixnum]
6512
+ attr_accessor :token_count
6513
+
6514
+ # Output only. Last time the example was updated.
6515
+ # Corresponds to the JSON property `updateTime`
6516
+ # @return [String]
6517
+ attr_accessor :update_time
6518
+
6519
+ def initialize(**args)
6520
+ update!(**args)
6521
+ end
6522
+
6523
+ # Update properties of this object
6524
+ def update!(**args)
6525
+ @actions = args[:actions] if args.key?(:actions)
6526
+ @conversation_state = args[:conversation_state] if args.key?(:conversation_state)
6527
+ @create_time = args[:create_time] if args.key?(:create_time)
6528
+ @description = args[:description] if args.key?(:description)
6529
+ @display_name = args[:display_name] if args.key?(:display_name)
6530
+ @language_code = args[:language_code] if args.key?(:language_code)
6531
+ @name = args[:name] if args.key?(:name)
6532
+ @playbook_input = args[:playbook_input] if args.key?(:playbook_input)
6533
+ @playbook_output = args[:playbook_output] if args.key?(:playbook_output)
6534
+ @token_count = args[:token_count] if args.key?(:token_count)
6535
+ @update_time = args[:update_time] if args.key?(:update_time)
6536
+ end
6537
+ end
6538
+
6379
6539
  # Represents an experiment in an environment.
6380
6540
  class GoogleCloudDialogflowCxV3beta1Experiment
6381
6541
  include Google::Apis::Core::Hashable
@@ -7094,6 +7254,51 @@ module Google
7094
7254
  end
7095
7255
  end
7096
7256
 
7257
+ # The request message for Tools.ExportTools.
7258
+ class GoogleCloudDialogflowCxV3beta1ExportToolsRequest
7259
+ include Google::Apis::Core::Hashable
7260
+
7261
+ # Optional. The data format of the exported tools. If not specified, `BLOB` is
7262
+ # assumed.
7263
+ # Corresponds to the JSON property `dataFormat`
7264
+ # @return [String]
7265
+ attr_accessor :data_format
7266
+
7267
+ # Required. The name of the tools to export. Format: `projects//locations//
7268
+ # agents//tools/`.
7269
+ # Corresponds to the JSON property `tools`
7270
+ # @return [Array<String>]
7271
+ attr_accessor :tools
7272
+
7273
+ # Optional. The option to return the serialized tools inline.
7274
+ # Corresponds to the JSON property `toolsContentInline`
7275
+ # @return [Boolean]
7276
+ attr_accessor :tools_content_inline
7277
+ alias_method :tools_content_inline?, :tools_content_inline
7278
+
7279
+ # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/)
7280
+ # URI to export the tools to. The format of this URI must be `gs:///`.
7281
+ # Dialogflow performs a write operation for the Cloud Storage object on the
7282
+ # caller's behalf, so your request authentication must have write permissions
7283
+ # for the object. For more information, see [Dialogflow access control](https://
7284
+ # cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
7285
+ # Corresponds to the JSON property `toolsUri`
7286
+ # @return [String]
7287
+ attr_accessor :tools_uri
7288
+
7289
+ def initialize(**args)
7290
+ update!(**args)
7291
+ end
7292
+
7293
+ # Update properties of this object
7294
+ def update!(**args)
7295
+ @data_format = args[:data_format] if args.key?(:data_format)
7296
+ @tools = args[:tools] if args.key?(:tools)
7297
+ @tools_content_inline = args[:tools_content_inline] if args.key?(:tools_content_inline)
7298
+ @tools_uri = args[:tools_uri] if args.key?(:tools_uri)
7299
+ end
7300
+ end
7301
+
7097
7302
  # Filter specifications for data stores.
7098
7303
  class GoogleCloudDialogflowCxV3beta1FilterSpecs
7099
7304
  include Google::Apis::Core::Hashable
@@ -7260,6 +7465,44 @@ module Google
7260
7465
  end
7261
7466
  end
7262
7467
 
7468
+ # Stores metadata of the invocation of a CX flow. Next Id: 7
7469
+ class GoogleCloudDialogflowCxV3beta1FlowInvocation
7470
+ include Google::Apis::Core::Hashable
7471
+
7472
+ # Required. The unique identifier of the flow. Format: `projects//locations//
7473
+ # agents/`.
7474
+ # Corresponds to the JSON property `flow`
7475
+ # @return [String]
7476
+ attr_accessor :flow
7477
+
7478
+ # Required. Flow invocation's output state.
7479
+ # Corresponds to the JSON property `flowState`
7480
+ # @return [String]
7481
+ attr_accessor :flow_state
7482
+
7483
+ # Optional. A list of input parameters for the flow.
7484
+ # Corresponds to the JSON property `inputActionParameters`
7485
+ # @return [Hash<String,Object>]
7486
+ attr_accessor :input_action_parameters
7487
+
7488
+ # Optional. A list of output parameters generated by the flow invocation.
7489
+ # Corresponds to the JSON property `outputActionParameters`
7490
+ # @return [Hash<String,Object>]
7491
+ attr_accessor :output_action_parameters
7492
+
7493
+ def initialize(**args)
7494
+ update!(**args)
7495
+ end
7496
+
7497
+ # Update properties of this object
7498
+ def update!(**args)
7499
+ @flow = args[:flow] if args.key?(:flow)
7500
+ @flow_state = args[:flow_state] if args.key?(:flow_state)
7501
+ @input_action_parameters = args[:input_action_parameters] if args.key?(:input_action_parameters)
7502
+ @output_action_parameters = args[:output_action_parameters] if args.key?(:output_action_parameters)
7503
+ end
7504
+ end
7505
+
7263
7506
  # Settings for multi-lingual agents.
7264
7507
  class GoogleCloudDialogflowCxV3beta1FlowMultiLanguageSettings
7265
7508
  include Google::Apis::Core::Hashable
@@ -7775,6 +8018,34 @@ module Google
7775
8018
  end
7776
8019
  end
7777
8020
 
8021
+ # Represents the information of a query if handled by generative agent resources.
8022
+ class GoogleCloudDialogflowCxV3beta1GenerativeInfo
8023
+ include Google::Apis::Core::Hashable
8024
+
8025
+ # Example represents a sample execution of the playbook in the conversation. An
8026
+ # example consists of a list of ordered actions performed by end user or
8027
+ # Dialogflow agent according the playbook instructions to fulfill the task.
8028
+ # Corresponds to the JSON property `actionTracingInfo`
8029
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example]
8030
+ attr_accessor :action_tracing_info
8031
+
8032
+ # The stack of playbooks that the conversation has currently entered, with the
8033
+ # most recent one on the top.
8034
+ # Corresponds to the JSON property `currentPlaybooks`
8035
+ # @return [Array<String>]
8036
+ attr_accessor :current_playbooks
8037
+
8038
+ def initialize(**args)
8039
+ update!(**args)
8040
+ end
8041
+
8042
+ # Update properties of this object
8043
+ def update!(**args)
8044
+ @action_tracing_info = args[:action_tracing_info] if args.key?(:action_tracing_info)
8045
+ @current_playbooks = args[:current_playbooks] if args.key?(:current_playbooks)
8046
+ end
8047
+ end
8048
+
7778
8049
  # Settings for Generative AI.
7779
8050
  class GoogleCloudDialogflowCxV3beta1GenerativeSettings
7780
8051
  include Google::Apis::Core::Hashable
@@ -7801,6 +8072,11 @@ module Google
7801
8072
  # @return [String]
7802
8073
  attr_accessor :language_code
7803
8074
 
8075
+ # Settings for LLM models.
8076
+ # Corresponds to the JSON property `llmModelSettings`
8077
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmModelSettings]
8078
+ attr_accessor :llm_model_settings
8079
+
7804
8080
  # Format: `projects//locations//agents//generativeSettings`.
7805
8081
  # Corresponds to the JSON property `name`
7806
8082
  # @return [String]
@@ -7816,6 +8092,7 @@ module Google
7816
8092
  @generative_safety_settings = args[:generative_safety_settings] if args.key?(:generative_safety_settings)
7817
8093
  @knowledge_connector_settings = args[:knowledge_connector_settings] if args.key?(:knowledge_connector_settings)
7818
8094
  @language_code = args[:language_code] if args.key?(:language_code)
8095
+ @llm_model_settings = args[:llm_model_settings] if args.key?(:llm_model_settings)
7819
8096
  @name = args[:name] if args.key?(:name)
7820
8097
  end
7821
8098
  end
@@ -7951,6 +8228,11 @@ module Google
7951
8228
  # @return [String]
7952
8229
  attr_accessor :display_name
7953
8230
 
8231
+ # Settings for LLM models.
8232
+ # Corresponds to the JSON property `llmModelSettings`
8233
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmModelSettings]
8234
+ attr_accessor :llm_model_settings
8235
+
7954
8236
  # The unique identifier of the generator. Must be set for the Generators.
7955
8237
  # UpdateGenerator method. Generators.CreateGenerate populates the name
7956
8238
  # automatically. Format: `projects//locations//agents//generators/`.
@@ -7975,6 +8257,7 @@ module Google
7975
8257
  # Update properties of this object
7976
8258
  def update!(**args)
7977
8259
  @display_name = args[:display_name] if args.key?(:display_name)
8260
+ @llm_model_settings = args[:llm_model_settings] if args.key?(:llm_model_settings)
7978
8261
  @name = args[:name] if args.key?(:name)
7979
8262
  @placeholders = args[:placeholders] if args.key?(:placeholders)
7980
8263
  @prompt_text = args[:prompt_text] if args.key?(:prompt_text)
@@ -9109,6 +9392,33 @@ module Google
9109
9392
  end
9110
9393
  end
9111
9394
 
9395
+ # The response message for Examples.ListExamples.
9396
+ class GoogleCloudDialogflowCxV3beta1ListExamplesResponse
9397
+ include Google::Apis::Core::Hashable
9398
+
9399
+ # The list of examples. There will be a maximum number of items returned based
9400
+ # on the page_size field in the request.
9401
+ # Corresponds to the JSON property `examples`
9402
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example>]
9403
+ attr_accessor :examples
9404
+
9405
+ # Token to retrieve the next page of results, or empty if there are no more
9406
+ # results in the list.
9407
+ # Corresponds to the JSON property `nextPageToken`
9408
+ # @return [String]
9409
+ attr_accessor :next_page_token
9410
+
9411
+ def initialize(**args)
9412
+ update!(**args)
9413
+ end
9414
+
9415
+ # Update properties of this object
9416
+ def update!(**args)
9417
+ @examples = args[:examples] if args.key?(:examples)
9418
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
9419
+ end
9420
+ end
9421
+
9112
9422
  # The response message for Experiments.ListExperiments.
9113
9423
  class GoogleCloudDialogflowCxV3beta1ListExperimentsResponse
9114
9424
  include Google::Apis::Core::Hashable
@@ -9245,6 +9555,60 @@ module Google
9245
9555
  end
9246
9556
  end
9247
9557
 
9558
+ # The response message for Playbooks.ListPlaybookVersions.
9559
+ class GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse
9560
+ include Google::Apis::Core::Hashable
9561
+
9562
+ # Token to retrieve the next page of results, or empty if there are no more
9563
+ # results in the list.
9564
+ # Corresponds to the JSON property `nextPageToken`
9565
+ # @return [String]
9566
+ attr_accessor :next_page_token
9567
+
9568
+ # The list of playbook version. There will be a maximum number of items returned
9569
+ # based on the page_size field in the request.
9570
+ # Corresponds to the JSON property `playbookVersions`
9571
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion>]
9572
+ attr_accessor :playbook_versions
9573
+
9574
+ def initialize(**args)
9575
+ update!(**args)
9576
+ end
9577
+
9578
+ # Update properties of this object
9579
+ def update!(**args)
9580
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
9581
+ @playbook_versions = args[:playbook_versions] if args.key?(:playbook_versions)
9582
+ end
9583
+ end
9584
+
9585
+ # The response message for Playbooks.ListPlaybooks.
9586
+ class GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse
9587
+ include Google::Apis::Core::Hashable
9588
+
9589
+ # Token to retrieve the next page of results, or empty if there are no more
9590
+ # results in the list.
9591
+ # Corresponds to the JSON property `nextPageToken`
9592
+ # @return [String]
9593
+ attr_accessor :next_page_token
9594
+
9595
+ # The list of playbooks. There will be a maximum number of items returned based
9596
+ # on the page_size field in the request.
9597
+ # Corresponds to the JSON property `playbooks`
9598
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook>]
9599
+ attr_accessor :playbooks
9600
+
9601
+ def initialize(**args)
9602
+ update!(**args)
9603
+ end
9604
+
9605
+ # Update properties of this object
9606
+ def update!(**args)
9607
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
9608
+ @playbooks = args[:playbooks] if args.key?(:playbooks)
9609
+ end
9610
+ end
9611
+
9248
9612
  # The response message for SecuritySettings.ListSecuritySettings.
9249
9613
  class GoogleCloudDialogflowCxV3beta1ListSecuritySettingsResponse
9250
9614
  include Google::Apis::Core::Hashable
@@ -9351,6 +9715,33 @@ module Google
9351
9715
  end
9352
9716
  end
9353
9717
 
9718
+ # The response message for Tools.ListTools.
9719
+ class GoogleCloudDialogflowCxV3beta1ListToolsResponse
9720
+ include Google::Apis::Core::Hashable
9721
+
9722
+ # Token to retrieve the next page of results, or empty if there are no more
9723
+ # results in the list.
9724
+ # Corresponds to the JSON property `nextPageToken`
9725
+ # @return [String]
9726
+ attr_accessor :next_page_token
9727
+
9728
+ # The list of Tools. There will be a maximum number of items returned based on
9729
+ # the page_size field in the request.
9730
+ # Corresponds to the JSON property `tools`
9731
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool>]
9732
+ attr_accessor :tools
9733
+
9734
+ def initialize(**args)
9735
+ update!(**args)
9736
+ end
9737
+
9738
+ # Update properties of this object
9739
+ def update!(**args)
9740
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
9741
+ @tools = args[:tools] if args.key?(:tools)
9742
+ end
9743
+ end
9744
+
9354
9745
  # The response message for TransitionRouteGroups.ListTransitionRouteGroups.
9355
9746
  class GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse
9356
9747
  include Google::Apis::Core::Hashable
@@ -9435,6 +9826,31 @@ module Google
9435
9826
  end
9436
9827
  end
9437
9828
 
9829
+ # Settings for LLM models.
9830
+ class GoogleCloudDialogflowCxV3beta1LlmModelSettings
9831
+ include Google::Apis::Core::Hashable
9832
+
9833
+ # The selected LLM model.
9834
+ # Corresponds to the JSON property `model`
9835
+ # @return [String]
9836
+ attr_accessor :model
9837
+
9838
+ # The custom prompt to use.
9839
+ # Corresponds to the JSON property `promptText`
9840
+ # @return [String]
9841
+ attr_accessor :prompt_text
9842
+
9843
+ def initialize(**args)
9844
+ update!(**args)
9845
+ end
9846
+
9847
+ # Update properties of this object
9848
+ def update!(**args)
9849
+ @model = args[:model] if args.key?(:model)
9850
+ @prompt_text = args[:prompt_text] if args.key?(:prompt_text)
9851
+ end
9852
+ end
9853
+
9438
9854
  # The request message for Versions.LoadVersion.
9439
9855
  class GoogleCloudDialogflowCxV3beta1LoadVersionRequest
9440
9856
  include Google::Apis::Core::Hashable
@@ -9957,12 +10373,278 @@ module Google
9957
10373
  end
9958
10374
  end
9959
10375
 
9960
- # Text input which can be used for prompt or banned phrases.
9961
- class GoogleCloudDialogflowCxV3beta1Phrase
10376
+ # Defines the properties of a parameter. Used to define parameters used in the
10377
+ # agent and the input / output parameters for each fulfillment.
10378
+ class GoogleCloudDialogflowCxV3beta1ParameterDefinition
9962
10379
  include Google::Apis::Core::Hashable
9963
10380
 
9964
- # Required. Text input which can be used for prompt or banned phrases.
9965
- # Corresponds to the JSON property `text`
10381
+ # Human-readable description of the parameter. Limited to 300 characters.
10382
+ # Corresponds to the JSON property `description`
10383
+ # @return [String]
10384
+ attr_accessor :description
10385
+
10386
+ # Required. Name of parameter.
10387
+ # Corresponds to the JSON property `name`
10388
+ # @return [String]
10389
+ attr_accessor :name
10390
+
10391
+ # Required. Type of parameter.
10392
+ # Corresponds to the JSON property `type`
10393
+ # @return [String]
10394
+ attr_accessor :type
10395
+
10396
+ def initialize(**args)
10397
+ update!(**args)
10398
+ end
10399
+
10400
+ # Update properties of this object
10401
+ def update!(**args)
10402
+ @description = args[:description] if args.key?(:description)
10403
+ @name = args[:name] if args.key?(:name)
10404
+ @type = args[:type] if args.key?(:type)
10405
+ end
10406
+ end
10407
+
10408
+ # Text input which can be used for prompt or banned phrases.
10409
+ class GoogleCloudDialogflowCxV3beta1Phrase
10410
+ include Google::Apis::Core::Hashable
10411
+
10412
+ # Required. Text input which can be used for prompt or banned phrases.
10413
+ # Corresponds to the JSON property `text`
10414
+ # @return [String]
10415
+ attr_accessor :text
10416
+
10417
+ def initialize(**args)
10418
+ update!(**args)
10419
+ end
10420
+
10421
+ # Update properties of this object
10422
+ def update!(**args)
10423
+ @text = args[:text] if args.key?(:text)
10424
+ end
10425
+ end
10426
+
10427
+ # Playbook is the basic building block to instruct the LLM how to execute a
10428
+ # certain task. A playbook consists of a goal to accomplish, an optional list of
10429
+ # step by step instructions (the step instruction may refers to name of the
10430
+ # custom or default plugin tools to use) to perform the task, a list of
10431
+ # contextual input data to be passed in at the beginning of the invoked, and a
10432
+ # list of output parameters to store the playbook result.
10433
+ class GoogleCloudDialogflowCxV3beta1Playbook
10434
+ include Google::Apis::Core::Hashable
10435
+
10436
+ # Output only. The timestamp of initial playbook creation.
10437
+ # Corresponds to the JSON property `createTime`
10438
+ # @return [String]
10439
+ attr_accessor :create_time
10440
+
10441
+ # Required. The human-readable name of the playbook, unique within an agent.
10442
+ # Corresponds to the JSON property `displayName`
10443
+ # @return [String]
10444
+ attr_accessor :display_name
10445
+
10446
+ # Required. High level description of the goal the playbook intend to accomplish.
10447
+ # Corresponds to the JSON property `goal`
10448
+ # @return [String]
10449
+ attr_accessor :goal
10450
+
10451
+ # Optional. Defined structured input parameters for this playbook.
10452
+ # Corresponds to the JSON property `inputParameterDefinitions`
10453
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ParameterDefinition>]
10454
+ attr_accessor :input_parameter_definitions
10455
+
10456
+ # Message of the Instruction of the playbook.
10457
+ # Corresponds to the JSON property `instruction`
10458
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookInstruction]
10459
+ attr_accessor :instruction
10460
+
10461
+ # Settings for LLM models.
10462
+ # Corresponds to the JSON property `llmModelSettings`
10463
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmModelSettings]
10464
+ attr_accessor :llm_model_settings
10465
+
10466
+ # The unique identifier of the playbook. Format: `projects//locations//agents//
10467
+ # playbooks/`.
10468
+ # Corresponds to the JSON property `name`
10469
+ # @return [String]
10470
+ attr_accessor :name
10471
+
10472
+ # Optional. Defined structured output parameters for this playbook.
10473
+ # Corresponds to the JSON property `outputParameterDefinitions`
10474
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ParameterDefinition>]
10475
+ attr_accessor :output_parameter_definitions
10476
+
10477
+ # Output only. The resource name of flows referenced by the current playbook in
10478
+ # the instructions.
10479
+ # Corresponds to the JSON property `referencedFlows`
10480
+ # @return [Array<String>]
10481
+ attr_accessor :referenced_flows
10482
+
10483
+ # Output only. The resource name of other playbooks referenced by the current
10484
+ # playbook in the instructions.
10485
+ # Corresponds to the JSON property `referencedPlaybooks`
10486
+ # @return [Array<String>]
10487
+ attr_accessor :referenced_playbooks
10488
+
10489
+ # Optional. The resource name of tools referenced by the current playbook in the
10490
+ # instructions. If not provided explicitly, they are will be implied using the
10491
+ # tool being referenced in goal and steps.
10492
+ # Corresponds to the JSON property `referencedTools`
10493
+ # @return [Array<String>]
10494
+ attr_accessor :referenced_tools
10495
+
10496
+ # Output only. Estimated number of tokes current playbook takes when sent to the
10497
+ # LLM.
10498
+ # Corresponds to the JSON property `tokenCount`
10499
+ # @return [Fixnum]
10500
+ attr_accessor :token_count
10501
+
10502
+ # Output only. Last time the playbook version was updated.
10503
+ # Corresponds to the JSON property `updateTime`
10504
+ # @return [String]
10505
+ attr_accessor :update_time
10506
+
10507
+ def initialize(**args)
10508
+ update!(**args)
10509
+ end
10510
+
10511
+ # Update properties of this object
10512
+ def update!(**args)
10513
+ @create_time = args[:create_time] if args.key?(:create_time)
10514
+ @display_name = args[:display_name] if args.key?(:display_name)
10515
+ @goal = args[:goal] if args.key?(:goal)
10516
+ @input_parameter_definitions = args[:input_parameter_definitions] if args.key?(:input_parameter_definitions)
10517
+ @instruction = args[:instruction] if args.key?(:instruction)
10518
+ @llm_model_settings = args[:llm_model_settings] if args.key?(:llm_model_settings)
10519
+ @name = args[:name] if args.key?(:name)
10520
+ @output_parameter_definitions = args[:output_parameter_definitions] if args.key?(:output_parameter_definitions)
10521
+ @referenced_flows = args[:referenced_flows] if args.key?(:referenced_flows)
10522
+ @referenced_playbooks = args[:referenced_playbooks] if args.key?(:referenced_playbooks)
10523
+ @referenced_tools = args[:referenced_tools] if args.key?(:referenced_tools)
10524
+ @token_count = args[:token_count] if args.key?(:token_count)
10525
+ @update_time = args[:update_time] if args.key?(:update_time)
10526
+ end
10527
+ end
10528
+
10529
+ # Input of the playbook.
10530
+ class GoogleCloudDialogflowCxV3beta1PlaybookInput
10531
+ include Google::Apis::Core::Hashable
10532
+
10533
+ # Optional. A list of input parameters for the action.
10534
+ # Corresponds to the JSON property `actionParameters`
10535
+ # @return [Hash<String,Object>]
10536
+ attr_accessor :action_parameters
10537
+
10538
+ # Optional. Summary string of the preceding conversation for the child playbook
10539
+ # invocation.
10540
+ # Corresponds to the JSON property `precedingConversationSummary`
10541
+ # @return [String]
10542
+ attr_accessor :preceding_conversation_summary
10543
+
10544
+ def initialize(**args)
10545
+ update!(**args)
10546
+ end
10547
+
10548
+ # Update properties of this object
10549
+ def update!(**args)
10550
+ @action_parameters = args[:action_parameters] if args.key?(:action_parameters)
10551
+ @preceding_conversation_summary = args[:preceding_conversation_summary] if args.key?(:preceding_conversation_summary)
10552
+ end
10553
+ end
10554
+
10555
+ # Message of the Instruction of the playbook.
10556
+ class GoogleCloudDialogflowCxV3beta1PlaybookInstruction
10557
+ include Google::Apis::Core::Hashable
10558
+
10559
+ # Ordered list of step by step execution instructions to accomplish target goal.
10560
+ # Corresponds to the JSON property `steps`
10561
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookStep>]
10562
+ attr_accessor :steps
10563
+
10564
+ def initialize(**args)
10565
+ update!(**args)
10566
+ end
10567
+
10568
+ # Update properties of this object
10569
+ def update!(**args)
10570
+ @steps = args[:steps] if args.key?(:steps)
10571
+ end
10572
+ end
10573
+
10574
+ # Stores metadata of the invocation of a child playbook. Next Id: 5
10575
+ class GoogleCloudDialogflowCxV3beta1PlaybookInvocation
10576
+ include Google::Apis::Core::Hashable
10577
+
10578
+ # Required. The unique identifier of the playbook. Format: `projects//locations//
10579
+ # agents//playbooks/`.
10580
+ # Corresponds to the JSON property `playbook`
10581
+ # @return [String]
10582
+ attr_accessor :playbook
10583
+
10584
+ # Input of the playbook.
10585
+ # Corresponds to the JSON property `playbookInput`
10586
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookInput]
10587
+ attr_accessor :playbook_input
10588
+
10589
+ # Output of the playbook.
10590
+ # Corresponds to the JSON property `playbookOutput`
10591
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookOutput]
10592
+ attr_accessor :playbook_output
10593
+
10594
+ # Required. Playbook invocation's output state.
10595
+ # Corresponds to the JSON property `playbookState`
10596
+ # @return [String]
10597
+ attr_accessor :playbook_state
10598
+
10599
+ def initialize(**args)
10600
+ update!(**args)
10601
+ end
10602
+
10603
+ # Update properties of this object
10604
+ def update!(**args)
10605
+ @playbook = args[:playbook] if args.key?(:playbook)
10606
+ @playbook_input = args[:playbook_input] if args.key?(:playbook_input)
10607
+ @playbook_output = args[:playbook_output] if args.key?(:playbook_output)
10608
+ @playbook_state = args[:playbook_state] if args.key?(:playbook_state)
10609
+ end
10610
+ end
10611
+
10612
+ # Output of the playbook.
10613
+ class GoogleCloudDialogflowCxV3beta1PlaybookOutput
10614
+ include Google::Apis::Core::Hashable
10615
+
10616
+ # Optional. A Struct object of output parameters for the action.
10617
+ # Corresponds to the JSON property `actionParameters`
10618
+ # @return [Hash<String,Object>]
10619
+ attr_accessor :action_parameters
10620
+
10621
+ # Optional. Summary string of the execution result of the child playbook.
10622
+ # Corresponds to the JSON property `executionSummary`
10623
+ # @return [String]
10624
+ attr_accessor :execution_summary
10625
+
10626
+ def initialize(**args)
10627
+ update!(**args)
10628
+ end
10629
+
10630
+ # Update properties of this object
10631
+ def update!(**args)
10632
+ @action_parameters = args[:action_parameters] if args.key?(:action_parameters)
10633
+ @execution_summary = args[:execution_summary] if args.key?(:execution_summary)
10634
+ end
10635
+ end
10636
+
10637
+ # Message of single step execution.
10638
+ class GoogleCloudDialogflowCxV3beta1PlaybookStep
10639
+ include Google::Apis::Core::Hashable
10640
+
10641
+ # Sub-processing needed to execute the current step.
10642
+ # Corresponds to the JSON property `steps`
10643
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookStep>]
10644
+ attr_accessor :steps
10645
+
10646
+ # Step instruction in text format.
10647
+ # Corresponds to the JSON property `text`
9966
10648
  # @return [String]
9967
10649
  attr_accessor :text
9968
10650
 
@@ -9972,10 +10654,61 @@ module Google
9972
10654
 
9973
10655
  # Update properties of this object
9974
10656
  def update!(**args)
10657
+ @steps = args[:steps] if args.key?(:steps)
9975
10658
  @text = args[:text] if args.key?(:text)
9976
10659
  end
9977
10660
  end
9978
10661
 
10662
+ # Playbook version is a snapshot of the playbook at certain timestamp.
10663
+ class GoogleCloudDialogflowCxV3beta1PlaybookVersion
10664
+ include Google::Apis::Core::Hashable
10665
+
10666
+ # Optional. The description of the playbook version.
10667
+ # Corresponds to the JSON property `description`
10668
+ # @return [String]
10669
+ attr_accessor :description
10670
+
10671
+ # Output only. Snapshot of the examples belonging to the playbook when the
10672
+ # playbook version is created.
10673
+ # Corresponds to the JSON property `examples`
10674
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example>]
10675
+ attr_accessor :examples
10676
+
10677
+ # The unique identifier of the playbook version. Format: `projects//locations//
10678
+ # agents//playbooks//versions/`.
10679
+ # Corresponds to the JSON property `name`
10680
+ # @return [String]
10681
+ attr_accessor :name
10682
+
10683
+ # Playbook is the basic building block to instruct the LLM how to execute a
10684
+ # certain task. A playbook consists of a goal to accomplish, an optional list of
10685
+ # step by step instructions (the step instruction may refers to name of the
10686
+ # custom or default plugin tools to use) to perform the task, a list of
10687
+ # contextual input data to be passed in at the beginning of the invoked, and a
10688
+ # list of output parameters to store the playbook result.
10689
+ # Corresponds to the JSON property `playbook`
10690
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook]
10691
+ attr_accessor :playbook
10692
+
10693
+ # Output only. Last time the playbook version was created or modified.
10694
+ # Corresponds to the JSON property `updateTime`
10695
+ # @return [String]
10696
+ attr_accessor :update_time
10697
+
10698
+ def initialize(**args)
10699
+ update!(**args)
10700
+ end
10701
+
10702
+ # Update properties of this object
10703
+ def update!(**args)
10704
+ @description = args[:description] if args.key?(:description)
10705
+ @examples = args[:examples] if args.key?(:examples)
10706
+ @name = args[:name] if args.key?(:name)
10707
+ @playbook = args[:playbook] if args.key?(:playbook)
10708
+ @update_time = args[:update_time] if args.key?(:update_time)
10709
+ end
10710
+ end
10711
+
9979
10712
  # Represents the query input. It can contain one of: 1. A conversational query
9980
10713
  # in the form of text. 2. An intent query that specifies which intent to trigger.
9981
10714
  # 3. Natural language speech audio to be processed. 4. An event to be triggered.
@@ -10018,6 +10751,11 @@ module Google
10018
10751
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TextInput]
10019
10752
  attr_accessor :text
10020
10753
 
10754
+ # The result of calling a tool's action that has been executed by the client.
10755
+ # Corresponds to the JSON property `toolCallResult`
10756
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolCallResult]
10757
+ attr_accessor :tool_call_result
10758
+
10021
10759
  def initialize(**args)
10022
10760
  update!(**args)
10023
10761
  end
@@ -10030,6 +10768,7 @@ module Google
10030
10768
  @intent = args[:intent] if args.key?(:intent)
10031
10769
  @language_code = args[:language_code] if args.key?(:language_code)
10032
10770
  @text = args[:text] if args.key?(:text)
10771
+ @tool_call_result = args[:tool_call_result] if args.key?(:tool_call_result)
10033
10772
  end
10034
10773
  end
10035
10774
 
@@ -10063,6 +10802,13 @@ module Google
10063
10802
  # @return [String]
10064
10803
  attr_accessor :current_page
10065
10804
 
10805
+ # Optional. Start the session with the specified playbook. You can only specify
10806
+ # the playbook at the beginning of the session. Otherwise, an error will be
10807
+ # thrown. Format: `projects//locations//agents//playbooks/`.
10808
+ # Corresponds to the JSON property `currentPlaybook`
10809
+ # @return [String]
10810
+ attr_accessor :current_playbook
10811
+
10066
10812
  # Whether to disable webhook calls for this request.
10067
10813
  # Corresponds to the JSON property `disableWebhook`
10068
10814
  # @return [Boolean]
@@ -10096,6 +10842,11 @@ module Google
10096
10842
  # @return [Google::Apis::DialogflowV3beta1::GoogleTypeLatLng]
10097
10843
  attr_accessor :geo_location
10098
10844
 
10845
+ # Settings for LLM models.
10846
+ # Corresponds to the JSON property `llmModelSettings`
10847
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmModelSettings]
10848
+ attr_accessor :llm_model_settings
10849
+
10099
10850
  # Additional parameters to be put into session parameters. To remove a parameter
10100
10851
  # from the session, clients should explicitly set the parameter value to null.
10101
10852
  # You can reference the session parameters in the agent with the following
@@ -10177,10 +10928,12 @@ module Google
10177
10928
  @analyze_query_text_sentiment = args[:analyze_query_text_sentiment] if args.key?(:analyze_query_text_sentiment)
10178
10929
  @channel = args[:channel] if args.key?(:channel)
10179
10930
  @current_page = args[:current_page] if args.key?(:current_page)
10931
+ @current_playbook = args[:current_playbook] if args.key?(:current_playbook)
10180
10932
  @disable_webhook = args[:disable_webhook] if args.key?(:disable_webhook)
10181
10933
  @end_user_metadata = args[:end_user_metadata] if args.key?(:end_user_metadata)
10182
10934
  @flow_versions = args[:flow_versions] if args.key?(:flow_versions)
10183
10935
  @geo_location = args[:geo_location] if args.key?(:geo_location)
10936
+ @llm_model_settings = args[:llm_model_settings] if args.key?(:llm_model_settings)
10184
10937
  @parameters = args[:parameters] if args.key?(:parameters)
10185
10938
  @payload = args[:payload] if args.key?(:payload)
10186
10939
  @populate_data_store_connection_signals = args[:populate_data_store_connection_signals] if args.key?(:populate_data_store_connection_signals)
@@ -10215,6 +10968,21 @@ module Google
10215
10968
  attr_accessor :allow_answer_feedback
10216
10969
  alias_method :allow_answer_feedback?, :allow_answer_feedback
10217
10970
 
10971
+ # Flows represents the conversation flows when you build your chatbot agent. A
10972
+ # flow consists of many pages connected by the transition routes. Conversations
10973
+ # always start with the built-in Start Flow (with an all-0 ID). Transition
10974
+ # routes can direct the conversation session from the current flow (parent flow)
10975
+ # to another flow (sub flow). When the sub flow is finished, Dialogflow will
10976
+ # bring the session back to the parent flow, where the sub flow is started.
10977
+ # Usually, when a transition route is followed by a matched intent, the intent
10978
+ # will be "consumed". This means the intent won't activate more transition
10979
+ # routes. However, when the followed transition route moves the conversation
10980
+ # session into a different flow, the matched intent can be carried over and to
10981
+ # be consumed in the target flow.
10982
+ # Corresponds to the JSON property `currentFlow`
10983
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow]
10984
+ attr_accessor :current_flow
10985
+
10218
10986
  # A Dialogflow CX conversation (session) can be described and visualized as a
10219
10987
  # state machine. The states of a CX session are represented by pages. For each
10220
10988
  # flow, you define many pages, where your combined pages can handle a complete
@@ -10260,6 +11028,11 @@ module Google
10260
11028
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DtmfInput]
10261
11029
  attr_accessor :dtmf
10262
11030
 
11031
+ # Represents the information of a query if handled by generative agent resources.
11032
+ # Corresponds to the JSON property `generativeInfo`
11033
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeInfo]
11034
+ attr_accessor :generative_info
11035
+
10263
11036
  # An intent represents a user's intent to interact with a conversational agent.
10264
11037
  # You can provide information for the Dialogflow API to use to match user input
10265
11038
  # to an intent by adding training phrases (i.e., examples of user input) to your
@@ -10381,10 +11154,12 @@ module Google
10381
11154
  def update!(**args)
10382
11155
  @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
10383
11156
  @allow_answer_feedback = args[:allow_answer_feedback] if args.key?(:allow_answer_feedback)
11157
+ @current_flow = args[:current_flow] if args.key?(:current_flow)
10384
11158
  @current_page = args[:current_page] if args.key?(:current_page)
10385
11159
  @data_store_connection_signals = args[:data_store_connection_signals] if args.key?(:data_store_connection_signals)
10386
11160
  @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info)
10387
11161
  @dtmf = args[:dtmf] if args.key?(:dtmf)
11162
+ @generative_info = args[:generative_info] if args.key?(:generative_info)
10388
11163
  @intent = args[:intent] if args.key?(:intent)
10389
11164
  @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence)
10390
11165
  @language_code = args[:language_code] if args.key?(:language_code)
@@ -10543,6 +11318,11 @@ module Google
10543
11318
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
10544
11319
  attr_accessor :text
10545
11320
 
11321
+ # Represents a call of a specific tool's action with the specified inputs.
11322
+ # Corresponds to the JSON property `toolCall`
11323
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolCall]
11324
+ attr_accessor :tool_call
11325
+
10546
11326
  def initialize(**args)
10547
11327
  update!(**args)
10548
11328
  end
@@ -10560,6 +11340,7 @@ module Google
10560
11340
  @play_audio = args[:play_audio] if args.key?(:play_audio)
10561
11341
  @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call)
10562
11342
  @text = args[:text] if args.key?(:text)
11343
+ @tool_call = args[:tool_call] if args.key?(:tool_call)
10563
11344
  end
10564
11345
  end
10565
11346
 
@@ -11757,29 +12538,494 @@ module Google
11757
12538
  end
11758
12539
  end
11759
12540
 
11760
- # Error info for running a test.
11761
- class GoogleCloudDialogflowCxV3beta1TestError
12541
+ # Error info for running a test.
12542
+ class GoogleCloudDialogflowCxV3beta1TestError
12543
+ include Google::Apis::Core::Hashable
12544
+
12545
+ # The `Status` type defines a logical error model that is suitable for different
12546
+ # programming environments, including REST APIs and RPC APIs. It is used by [
12547
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
12548
+ # data: error code, error message, and error details. You can find out more
12549
+ # about this error model and how to work with it in the [API Design Guide](https:
12550
+ # //cloud.google.com/apis/design/errors).
12551
+ # Corresponds to the JSON property `status`
12552
+ # @return [Google::Apis::DialogflowV3beta1::GoogleRpcStatus]
12553
+ attr_accessor :status
12554
+
12555
+ # The test case resource name.
12556
+ # Corresponds to the JSON property `testCase`
12557
+ # @return [String]
12558
+ attr_accessor :test_case
12559
+
12560
+ # The timestamp when the test was completed.
12561
+ # Corresponds to the JSON property `testTime`
12562
+ # @return [String]
12563
+ attr_accessor :test_time
12564
+
12565
+ def initialize(**args)
12566
+ update!(**args)
12567
+ end
12568
+
12569
+ # Update properties of this object
12570
+ def update!(**args)
12571
+ @status = args[:status] if args.key?(:status)
12572
+ @test_case = args[:test_case] if args.key?(:test_case)
12573
+ @test_time = args[:test_time] if args.key?(:test_time)
12574
+ end
12575
+ end
12576
+
12577
+ # The description of differences between original and replayed agent output.
12578
+ class GoogleCloudDialogflowCxV3beta1TestRunDifference
12579
+ include Google::Apis::Core::Hashable
12580
+
12581
+ # A human readable description of the diff, showing the actual output vs
12582
+ # expected output.
12583
+ # Corresponds to the JSON property `description`
12584
+ # @return [String]
12585
+ attr_accessor :description
12586
+
12587
+ # The type of diff.
12588
+ # Corresponds to the JSON property `type`
12589
+ # @return [String]
12590
+ attr_accessor :type
12591
+
12592
+ def initialize(**args)
12593
+ update!(**args)
12594
+ end
12595
+
12596
+ # Update properties of this object
12597
+ def update!(**args)
12598
+ @description = args[:description] if args.key?(:description)
12599
+ @type = args[:type] if args.key?(:type)
12600
+ end
12601
+ end
12602
+
12603
+ # Represents the natural language text to be processed.
12604
+ class GoogleCloudDialogflowCxV3beta1TextInput
12605
+ include Google::Apis::Core::Hashable
12606
+
12607
+ # Required. The UTF-8 encoded natural language text to be processed.
12608
+ # Corresponds to the JSON property `text`
12609
+ # @return [String]
12610
+ attr_accessor :text
12611
+
12612
+ def initialize(**args)
12613
+ update!(**args)
12614
+ end
12615
+
12616
+ # Update properties of this object
12617
+ def update!(**args)
12618
+ @text = args[:text] if args.key?(:text)
12619
+ end
12620
+ end
12621
+
12622
+ # Settings related to speech synthesizing.
12623
+ class GoogleCloudDialogflowCxV3beta1TextToSpeechSettings
12624
+ include Google::Apis::Core::Hashable
12625
+
12626
+ # Configuration of how speech should be synthesized, mapping from language (
12627
+ # https://cloud.google.com/dialogflow/cx/docs/reference/language) to
12628
+ # SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://
12629
+ # cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway)
12630
+ # synthesize configuration set via Agent.text_to_speech_settings. - How speech
12631
+ # is synthesized when invoking session APIs. Agent.text_to_speech_settings only
12632
+ # applies if OutputAudioConfig.synthesize_speech_config is not specified.
12633
+ # Corresponds to the JSON property `synthesizeSpeechConfigs`
12634
+ # @return [Hash<String,Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SynthesizeSpeechConfig>]
12635
+ attr_accessor :synthesize_speech_configs
12636
+
12637
+ def initialize(**args)
12638
+ update!(**args)
12639
+ end
12640
+
12641
+ # Update properties of this object
12642
+ def update!(**args)
12643
+ @synthesize_speech_configs = args[:synthesize_speech_configs] if args.key?(:synthesize_speech_configs)
12644
+ end
12645
+ end
12646
+
12647
+ # A tool provides a list of actions which are available to the Playbook to
12648
+ # attain its goal. A Tool consists of a description of the tool's usage and a
12649
+ # specification of the tool which contains the schema and authentication
12650
+ # information.
12651
+ class GoogleCloudDialogflowCxV3beta1Tool
12652
+ include Google::Apis::Core::Hashable
12653
+
12654
+ # A DataStoreTool is a way to provide specifications needed to search a list of
12655
+ # data stores.
12656
+ # Corresponds to the JSON property `dataStoreSpec`
12657
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolDataStoreTool]
12658
+ attr_accessor :data_store_spec
12659
+
12660
+ # Required. High level description of the Tool and its usage.
12661
+ # Corresponds to the JSON property `description`
12662
+ # @return [String]
12663
+ attr_accessor :description
12664
+
12665
+ # Required. The human-readable name of the Tool, unique within an agent.
12666
+ # Corresponds to the JSON property `displayName`
12667
+ # @return [String]
12668
+ attr_accessor :display_name
12669
+
12670
+ # An ExtensionTool is a way to use Vertex Extensions as a tool.
12671
+ # Corresponds to the JSON property `extensionSpec`
12672
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolExtensionTool]
12673
+ attr_accessor :extension_spec
12674
+
12675
+ # A Function tool describes the functions to be invoked on the client side.
12676
+ # Corresponds to the JSON property `functionSpec`
12677
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolFunctionTool]
12678
+ attr_accessor :function_spec
12679
+
12680
+ # The unique identifier of the Tool. Format: `projects//locations//agents//tools/
12681
+ # `.
12682
+ # Corresponds to the JSON property `name`
12683
+ # @return [String]
12684
+ attr_accessor :name
12685
+
12686
+ # An OpenAPI tool is a way to provide the Tool specifications in the Open API
12687
+ # schema format.
12688
+ # Corresponds to the JSON property `openApiSpec`
12689
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolOpenApiTool]
12690
+ attr_accessor :open_api_spec
12691
+
12692
+ # Output only. The tool type.
12693
+ # Corresponds to the JSON property `toolType`
12694
+ # @return [String]
12695
+ attr_accessor :tool_type
12696
+
12697
+ def initialize(**args)
12698
+ update!(**args)
12699
+ end
12700
+
12701
+ # Update properties of this object
12702
+ def update!(**args)
12703
+ @data_store_spec = args[:data_store_spec] if args.key?(:data_store_spec)
12704
+ @description = args[:description] if args.key?(:description)
12705
+ @display_name = args[:display_name] if args.key?(:display_name)
12706
+ @extension_spec = args[:extension_spec] if args.key?(:extension_spec)
12707
+ @function_spec = args[:function_spec] if args.key?(:function_spec)
12708
+ @name = args[:name] if args.key?(:name)
12709
+ @open_api_spec = args[:open_api_spec] if args.key?(:open_api_spec)
12710
+ @tool_type = args[:tool_type] if args.key?(:tool_type)
12711
+ end
12712
+ end
12713
+
12714
+ # Authentication information required for API calls
12715
+ class GoogleCloudDialogflowCxV3beta1ToolAuthentication
12716
+ include Google::Apis::Core::Hashable
12717
+
12718
+ # Config for authentication with API key.
12719
+ # Corresponds to the JSON property `apiKeyConfig`
12720
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolAuthenticationApiKeyConfig]
12721
+ attr_accessor :api_key_config
12722
+
12723
+ # Config for authentication with OAuth.
12724
+ # Corresponds to the JSON property `oauthConfig`
12725
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig]
12726
+ attr_accessor :oauth_config
12727
+
12728
+ # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/
12729
+ # docs/service-agents#dialogflow-service-agent).
12730
+ # Corresponds to the JSON property `serviceAgentAuthConfig`
12731
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig]
12732
+ attr_accessor :service_agent_auth_config
12733
+
12734
+ def initialize(**args)
12735
+ update!(**args)
12736
+ end
12737
+
12738
+ # Update properties of this object
12739
+ def update!(**args)
12740
+ @api_key_config = args[:api_key_config] if args.key?(:api_key_config)
12741
+ @oauth_config = args[:oauth_config] if args.key?(:oauth_config)
12742
+ @service_agent_auth_config = args[:service_agent_auth_config] if args.key?(:service_agent_auth_config)
12743
+ end
12744
+ end
12745
+
12746
+ # Config for authentication with API key.
12747
+ class GoogleCloudDialogflowCxV3beta1ToolAuthenticationApiKeyConfig
12748
+ include Google::Apis::Core::Hashable
12749
+
12750
+ # Required. The API key.
12751
+ # Corresponds to the JSON property `apiKey`
12752
+ # @return [String]
12753
+ attr_accessor :api_key
12754
+
12755
+ # Required. The parameter name or the header name of the API key. E.g., If the
12756
+ # API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the
12757
+ # parameter name.
12758
+ # Corresponds to the JSON property `keyName`
12759
+ # @return [String]
12760
+ attr_accessor :key_name
12761
+
12762
+ # Required. Key location in the request.
12763
+ # Corresponds to the JSON property `requestLocation`
12764
+ # @return [String]
12765
+ attr_accessor :request_location
12766
+
12767
+ def initialize(**args)
12768
+ update!(**args)
12769
+ end
12770
+
12771
+ # Update properties of this object
12772
+ def update!(**args)
12773
+ @api_key = args[:api_key] if args.key?(:api_key)
12774
+ @key_name = args[:key_name] if args.key?(:key_name)
12775
+ @request_location = args[:request_location] if args.key?(:request_location)
12776
+ end
12777
+ end
12778
+
12779
+ # Config for authentication with OAuth.
12780
+ class GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig
12781
+ include Google::Apis::Core::Hashable
12782
+
12783
+ # Required. The client ID from the OAuth provider.
12784
+ # Corresponds to the JSON property `clientId`
12785
+ # @return [String]
12786
+ attr_accessor :client_id
12787
+
12788
+ # Required. The client secret from the OAuth provider.
12789
+ # Corresponds to the JSON property `clientSecret`
12790
+ # @return [String]
12791
+ attr_accessor :client_secret
12792
+
12793
+ # Required. OAuth grant types.
12794
+ # Corresponds to the JSON property `oauthGrantType`
12795
+ # @return [String]
12796
+ attr_accessor :oauth_grant_type
12797
+
12798
+ # Required. The token endpoint in the OAuth provider to exchange for an access
12799
+ # token.
12800
+ # Corresponds to the JSON property `tokenEndpoint`
12801
+ # @return [String]
12802
+ attr_accessor :token_endpoint
12803
+
12804
+ def initialize(**args)
12805
+ update!(**args)
12806
+ end
12807
+
12808
+ # Update properties of this object
12809
+ def update!(**args)
12810
+ @client_id = args[:client_id] if args.key?(:client_id)
12811
+ @client_secret = args[:client_secret] if args.key?(:client_secret)
12812
+ @oauth_grant_type = args[:oauth_grant_type] if args.key?(:oauth_grant_type)
12813
+ @token_endpoint = args[:token_endpoint] if args.key?(:token_endpoint)
12814
+ end
12815
+ end
12816
+
12817
+ # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/
12818
+ # docs/service-agents#dialogflow-service-agent).
12819
+ class GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig
12820
+ include Google::Apis::Core::Hashable
12821
+
12822
+ def initialize(**args)
12823
+ update!(**args)
12824
+ end
12825
+
12826
+ # Update properties of this object
12827
+ def update!(**args)
12828
+ end
12829
+ end
12830
+
12831
+ # Represents a call of a specific tool's action with the specified inputs.
12832
+ class GoogleCloudDialogflowCxV3beta1ToolCall
12833
+ include Google::Apis::Core::Hashable
12834
+
12835
+ # Required. The name of the tool's action associated with this call.
12836
+ # Corresponds to the JSON property `action`
12837
+ # @return [String]
12838
+ attr_accessor :action
12839
+
12840
+ # Optional. The action's input parameters.
12841
+ # Corresponds to the JSON property `inputParameters`
12842
+ # @return [Hash<String,Object>]
12843
+ attr_accessor :input_parameters
12844
+
12845
+ # Required. The tool associated with this call. Format: `projects//locations//
12846
+ # agents//tools/`.
12847
+ # Corresponds to the JSON property `tool`
12848
+ # @return [String]
12849
+ attr_accessor :tool
12850
+
12851
+ def initialize(**args)
12852
+ update!(**args)
12853
+ end
12854
+
12855
+ # Update properties of this object
12856
+ def update!(**args)
12857
+ @action = args[:action] if args.key?(:action)
12858
+ @input_parameters = args[:input_parameters] if args.key?(:input_parameters)
12859
+ @tool = args[:tool] if args.key?(:tool)
12860
+ end
12861
+ end
12862
+
12863
+ # The result of calling a tool's action that has been executed by the client.
12864
+ class GoogleCloudDialogflowCxV3beta1ToolCallResult
12865
+ include Google::Apis::Core::Hashable
12866
+
12867
+ # Required. The name of the tool's action associated with this call.
12868
+ # Corresponds to the JSON property `action`
12869
+ # @return [String]
12870
+ attr_accessor :action
12871
+
12872
+ # An error produced by the tool call.
12873
+ # Corresponds to the JSON property `error`
12874
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolCallResultError]
12875
+ attr_accessor :error
12876
+
12877
+ # The tool call's output parameters.
12878
+ # Corresponds to the JSON property `outputParameters`
12879
+ # @return [Hash<String,Object>]
12880
+ attr_accessor :output_parameters
12881
+
12882
+ # Required. The tool associated with this call. Format: `projects//locations//
12883
+ # agents//tools/`.
12884
+ # Corresponds to the JSON property `tool`
12885
+ # @return [String]
12886
+ attr_accessor :tool
12887
+
12888
+ def initialize(**args)
12889
+ update!(**args)
12890
+ end
12891
+
12892
+ # Update properties of this object
12893
+ def update!(**args)
12894
+ @action = args[:action] if args.key?(:action)
12895
+ @error = args[:error] if args.key?(:error)
12896
+ @output_parameters = args[:output_parameters] if args.key?(:output_parameters)
12897
+ @tool = args[:tool] if args.key?(:tool)
12898
+ end
12899
+ end
12900
+
12901
+ # An error produced by the tool call.
12902
+ class GoogleCloudDialogflowCxV3beta1ToolCallResultError
12903
+ include Google::Apis::Core::Hashable
12904
+
12905
+ # Optional. The error message of the function.
12906
+ # Corresponds to the JSON property `message`
12907
+ # @return [String]
12908
+ attr_accessor :message
12909
+
12910
+ def initialize(**args)
12911
+ update!(**args)
12912
+ end
12913
+
12914
+ # Update properties of this object
12915
+ def update!(**args)
12916
+ @message = args[:message] if args.key?(:message)
12917
+ end
12918
+ end
12919
+
12920
+ # A DataStoreTool is a way to provide specifications needed to search a list of
12921
+ # data stores.
12922
+ class GoogleCloudDialogflowCxV3beta1ToolDataStoreTool
12923
+ include Google::Apis::Core::Hashable
12924
+
12925
+ # Required. List of data stores to search.
12926
+ # Corresponds to the JSON property `dataStoreConnections`
12927
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DataStoreConnection>]
12928
+ attr_accessor :data_store_connections
12929
+
12930
+ # A FallbackPrompt is a way to provide specifications for the Data Store
12931
+ # fallback prompt when generating responses.
12932
+ # Corresponds to the JSON property `fallbackPrompt`
12933
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolDataStoreToolFallbackPrompt]
12934
+ attr_accessor :fallback_prompt
12935
+
12936
+ def initialize(**args)
12937
+ update!(**args)
12938
+ end
12939
+
12940
+ # Update properties of this object
12941
+ def update!(**args)
12942
+ @data_store_connections = args[:data_store_connections] if args.key?(:data_store_connections)
12943
+ @fallback_prompt = args[:fallback_prompt] if args.key?(:fallback_prompt)
12944
+ end
12945
+ end
12946
+
12947
+ # A FallbackPrompt is a way to provide specifications for the Data Store
12948
+ # fallback prompt when generating responses.
12949
+ class GoogleCloudDialogflowCxV3beta1ToolDataStoreToolFallbackPrompt
12950
+ include Google::Apis::Core::Hashable
12951
+
12952
+ def initialize(**args)
12953
+ update!(**args)
12954
+ end
12955
+
12956
+ # Update properties of this object
12957
+ def update!(**args)
12958
+ end
12959
+ end
12960
+
12961
+ # An ExtensionTool is a way to use Vertex Extensions as a tool.
12962
+ class GoogleCloudDialogflowCxV3beta1ToolExtensionTool
12963
+ include Google::Apis::Core::Hashable
12964
+
12965
+ # Required. The full name of the referenced vertex extension. Formats: `projects/
12966
+ # `project`/locations/`location`/extensions/`extension``
12967
+ # Corresponds to the JSON property `name`
12968
+ # @return [String]
12969
+ attr_accessor :name
12970
+
12971
+ def initialize(**args)
12972
+ update!(**args)
12973
+ end
12974
+
12975
+ # Update properties of this object
12976
+ def update!(**args)
12977
+ @name = args[:name] if args.key?(:name)
12978
+ end
12979
+ end
12980
+
12981
+ # A Function tool describes the functions to be invoked on the client side.
12982
+ class GoogleCloudDialogflowCxV3beta1ToolFunctionTool
12983
+ include Google::Apis::Core::Hashable
12984
+
12985
+ # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to
12986
+ # describe the input of the function. This input is a JSON object that contains
12987
+ # the function's parameters as properties of the object.
12988
+ # Corresponds to the JSON property `inputSchema`
12989
+ # @return [Hash<String,Object>]
12990
+ attr_accessor :input_schema
12991
+
12992
+ # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to
12993
+ # describe the output of the function. This output is a JSON object that
12994
+ # contains the function's parameters as properties of the object.
12995
+ # Corresponds to the JSON property `outputSchema`
12996
+ # @return [Hash<String,Object>]
12997
+ attr_accessor :output_schema
12998
+
12999
+ def initialize(**args)
13000
+ update!(**args)
13001
+ end
13002
+
13003
+ # Update properties of this object
13004
+ def update!(**args)
13005
+ @input_schema = args[:input_schema] if args.key?(:input_schema)
13006
+ @output_schema = args[:output_schema] if args.key?(:output_schema)
13007
+ end
13008
+ end
13009
+
13010
+ # An OpenAPI tool is a way to provide the Tool specifications in the Open API
13011
+ # schema format.
13012
+ class GoogleCloudDialogflowCxV3beta1ToolOpenApiTool
11762
13013
  include Google::Apis::Core::Hashable
11763
13014
 
11764
- # The `Status` type defines a logical error model that is suitable for different
11765
- # programming environments, including REST APIs and RPC APIs. It is used by [
11766
- # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
11767
- # data: error code, error message, and error details. You can find out more
11768
- # about this error model and how to work with it in the [API Design Guide](https:
11769
- # //cloud.google.com/apis/design/errors).
11770
- # Corresponds to the JSON property `status`
11771
- # @return [Google::Apis::DialogflowV3beta1::GoogleRpcStatus]
11772
- attr_accessor :status
13015
+ # Authentication information required for API calls
13016
+ # Corresponds to the JSON property `authentication`
13017
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolAuthentication]
13018
+ attr_accessor :authentication
11773
13019
 
11774
- # The test case resource name.
11775
- # Corresponds to the JSON property `testCase`
13020
+ # Required. The OpenAPI schema specified as a text.
13021
+ # Corresponds to the JSON property `textSchema`
11776
13022
  # @return [String]
11777
- attr_accessor :test_case
13023
+ attr_accessor :text_schema
11778
13024
 
11779
- # The timestamp when the test was completed.
11780
- # Corresponds to the JSON property `testTime`
11781
- # @return [String]
11782
- attr_accessor :test_time
13025
+ # The TLS configuration.
13026
+ # Corresponds to the JSON property `tlsConfig`
13027
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolTlsConfig]
13028
+ attr_accessor :tls_config
11783
13029
 
11784
13030
  def initialize(**args)
11785
13031
  update!(**args)
@@ -11787,26 +13033,21 @@ module Google
11787
13033
 
11788
13034
  # Update properties of this object
11789
13035
  def update!(**args)
11790
- @status = args[:status] if args.key?(:status)
11791
- @test_case = args[:test_case] if args.key?(:test_case)
11792
- @test_time = args[:test_time] if args.key?(:test_time)
13036
+ @authentication = args[:authentication] if args.key?(:authentication)
13037
+ @text_schema = args[:text_schema] if args.key?(:text_schema)
13038
+ @tls_config = args[:tls_config] if args.key?(:tls_config)
11793
13039
  end
11794
13040
  end
11795
13041
 
11796
- # The description of differences between original and replayed agent output.
11797
- class GoogleCloudDialogflowCxV3beta1TestRunDifference
13042
+ # The TLS configuration.
13043
+ class GoogleCloudDialogflowCxV3beta1ToolTlsConfig
11798
13044
  include Google::Apis::Core::Hashable
11799
13045
 
11800
- # A human readable description of the diff, showing the actual output vs
11801
- # expected output.
11802
- # Corresponds to the JSON property `description`
11803
- # @return [String]
11804
- attr_accessor :description
11805
-
11806
- # The type of diff.
11807
- # Corresponds to the JSON property `type`
11808
- # @return [String]
11809
- attr_accessor :type
13046
+ # Required. Specifies a list of allowed custom CA certificates for HTTPS
13047
+ # verification.
13048
+ # Corresponds to the JSON property `caCerts`
13049
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolTlsConfigCaCert>]
13050
+ attr_accessor :ca_certs
11810
13051
 
11811
13052
  def initialize(**args)
11812
13053
  update!(**args)
@@ -11814,19 +13055,32 @@ module Google
11814
13055
 
11815
13056
  # Update properties of this object
11816
13057
  def update!(**args)
11817
- @description = args[:description] if args.key?(:description)
11818
- @type = args[:type] if args.key?(:type)
13058
+ @ca_certs = args[:ca_certs] if args.key?(:ca_certs)
11819
13059
  end
11820
13060
  end
11821
13061
 
11822
- # Represents the natural language text to be processed.
11823
- class GoogleCloudDialogflowCxV3beta1TextInput
13062
+ # The CA certificate.
13063
+ class GoogleCloudDialogflowCxV3beta1ToolTlsConfigCaCert
11824
13064
  include Google::Apis::Core::Hashable
11825
13065
 
11826
- # Required. The UTF-8 encoded natural language text to be processed.
11827
- # Corresponds to the JSON property `text`
13066
+ # Required. The allowed custom CA certificates (in DER format) for HTTPS
13067
+ # verification. This overrides the default SSL trust store. If this is empty or
13068
+ # unspecified, Dialogflow will use Google's default trust store to verify
13069
+ # certificates. N.B. Make sure the HTTPS server certificates are signed with "
13070
+ # subject alt name". For instance a certificate can be self-signed using the
13071
+ # following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey
13072
+ # example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='
13073
+ # DNS:www.example.com'")
13074
+ # Corresponds to the JSON property `cert`
13075
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
11828
13076
  # @return [String]
11829
- attr_accessor :text
13077
+ attr_accessor :cert
13078
+
13079
+ # Required. The name of the allowed custom CA certificates. This can be used to
13080
+ # disambiguate the custom CA certificates.
13081
+ # Corresponds to the JSON property `displayName`
13082
+ # @return [String]
13083
+ attr_accessor :display_name
11830
13084
 
11831
13085
  def initialize(**args)
11832
13086
  update!(**args)
@@ -11834,24 +13088,35 @@ module Google
11834
13088
 
11835
13089
  # Update properties of this object
11836
13090
  def update!(**args)
11837
- @text = args[:text] if args.key?(:text)
13091
+ @cert = args[:cert] if args.key?(:cert)
13092
+ @display_name = args[:display_name] if args.key?(:display_name)
11838
13093
  end
11839
13094
  end
11840
13095
 
11841
- # Settings related to speech synthesizing.
11842
- class GoogleCloudDialogflowCxV3beta1TextToSpeechSettings
13096
+ # Stores metadata of the invocation of an action supported by a tool.
13097
+ class GoogleCloudDialogflowCxV3beta1ToolUse
11843
13098
  include Google::Apis::Core::Hashable
11844
13099
 
11845
- # Configuration of how speech should be synthesized, mapping from language (
11846
- # https://cloud.google.com/dialogflow/cx/docs/reference/language) to
11847
- # SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://
11848
- # cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway)
11849
- # synthesize configuration set via Agent.text_to_speech_settings. - How speech
11850
- # is synthesized when invoking session APIs. Agent.text_to_speech_settings only
11851
- # applies if OutputAudioConfig.synthesize_speech_config is not specified.
11852
- # Corresponds to the JSON property `synthesizeSpeechConfigs`
11853
- # @return [Hash<String,Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SynthesizeSpeechConfig>]
11854
- attr_accessor :synthesize_speech_configs
13100
+ # Optional. Name of the action to be called during the tool use.
13101
+ # Corresponds to the JSON property `action`
13102
+ # @return [String]
13103
+ attr_accessor :action
13104
+
13105
+ # Optional. A list of input parameters for the action.
13106
+ # Corresponds to the JSON property `inputActionParameters`
13107
+ # @return [Hash<String,Object>]
13108
+ attr_accessor :input_action_parameters
13109
+
13110
+ # Optional. A list of output parameters generated by the action.
13111
+ # Corresponds to the JSON property `outputActionParameters`
13112
+ # @return [Hash<String,Object>]
13113
+ attr_accessor :output_action_parameters
13114
+
13115
+ # Required. The tool that should be used. Format: `projects//locations//agents//
13116
+ # tools/`.
13117
+ # Corresponds to the JSON property `tool`
13118
+ # @return [String]
13119
+ attr_accessor :tool
11855
13120
 
11856
13121
  def initialize(**args)
11857
13122
  update!(**args)
@@ -11859,7 +13124,10 @@ module Google
11859
13124
 
11860
13125
  # Update properties of this object
11861
13126
  def update!(**args)
11862
- @synthesize_speech_configs = args[:synthesize_speech_configs] if args.key?(:synthesize_speech_configs)
13127
+ @action = args[:action] if args.key?(:action)
13128
+ @input_action_parameters = args[:input_action_parameters] if args.key?(:input_action_parameters)
13129
+ @output_action_parameters = args[:output_action_parameters] if args.key?(:output_action_parameters)
13130
+ @tool = args[:tool] if args.key?(:tool)
11863
13131
  end
11864
13132
  end
11865
13133
 
@@ -12319,6 +13587,25 @@ module Google
12319
13587
  end
12320
13588
  end
12321
13589
 
13590
+ # UserUtterance represents one message sent by the customer.
13591
+ class GoogleCloudDialogflowCxV3beta1UserUtterance
13592
+ include Google::Apis::Core::Hashable
13593
+
13594
+ # Required. Message content in text.
13595
+ # Corresponds to the JSON property `text`
13596
+ # @return [String]
13597
+ attr_accessor :text
13598
+
13599
+ def initialize(**args)
13600
+ update!(**args)
13601
+ end
13602
+
13603
+ # Update properties of this object
13604
+ def update!(**args)
13605
+ @text = args[:text] if args.key?(:text)
13606
+ end
13607
+ end
13608
+
12322
13609
  # The request message for Agents.ValidateAgent.
12323
13610
  class GoogleCloudDialogflowCxV3beta1ValidateAgentRequest
12324
13611
  include Google::Apis::Core::Hashable
@@ -15131,13 +16418,216 @@ module Google
15131
16418
  # @return [Array<String>]
15132
16419
  attr_accessor :prompts
15133
16420
 
15134
- # Optional. The definition of the parameter value. It can be: - a constant
15135
- # string, - a parameter value defined as `$parameter_name`, - an original
15136
- # parameter value defined as `$parameter_name.original`, - a parameter value
15137
- # from some context defined as `#context_name.parameter_name`.
15138
- # Corresponds to the JSON property `value`
15139
- # @return [String]
15140
- attr_accessor :value
16421
+ # Optional. The definition of the parameter value. It can be: - a constant
16422
+ # string, - a parameter value defined as `$parameter_name`, - an original
16423
+ # parameter value defined as `$parameter_name.original`, - a parameter value
16424
+ # from some context defined as `#context_name.parameter_name`.
16425
+ # Corresponds to the JSON property `value`
16426
+ # @return [String]
16427
+ attr_accessor :value
16428
+
16429
+ def initialize(**args)
16430
+ update!(**args)
16431
+ end
16432
+
16433
+ # Update properties of this object
16434
+ def update!(**args)
16435
+ @default_value = args[:default_value] if args.key?(:default_value)
16436
+ @display_name = args[:display_name] if args.key?(:display_name)
16437
+ @entity_type_display_name = args[:entity_type_display_name] if args.key?(:entity_type_display_name)
16438
+ @is_list = args[:is_list] if args.key?(:is_list)
16439
+ @mandatory = args[:mandatory] if args.key?(:mandatory)
16440
+ @name = args[:name] if args.key?(:name)
16441
+ @prompts = args[:prompts] if args.key?(:prompts)
16442
+ @value = args[:value] if args.key?(:value)
16443
+ end
16444
+ end
16445
+
16446
+ # Represents an example that the agent is trained on.
16447
+ class GoogleCloudDialogflowV2IntentTrainingPhrase
16448
+ include Google::Apis::Core::Hashable
16449
+
16450
+ # Output only. The unique identifier of this training phrase.
16451
+ # Corresponds to the JSON property `name`
16452
+ # @return [String]
16453
+ attr_accessor :name
16454
+
16455
+ # Required. The ordered list of training phrase parts. The parts are
16456
+ # concatenated in order to form the training phrase. Note: The API does not
16457
+ # automatically annotate training phrases like the Dialogflow Console does. Note:
16458
+ # Do not forget to include whitespace at part boundaries, so the training
16459
+ # phrase is well formatted when the parts are concatenated. If the training
16460
+ # phrase does not need to be annotated with parameters, you just need a single
16461
+ # part with only the Part.text field set. If you want to annotate the training
16462
+ # phrase, you must create multiple parts, where the fields of each part are
16463
+ # populated in one of two ways: - `Part.text` is set to a part of the phrase
16464
+ # that has no parameters. - `Part.text` is set to a part of the phrase that you
16465
+ # want to annotate, and the `entity_type`, `alias`, and `user_defined` fields
16466
+ # are all set.
16467
+ # Corresponds to the JSON property `parts`
16468
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentTrainingPhrasePart>]
16469
+ attr_accessor :parts
16470
+
16471
+ # Optional. Indicates how many times this example was added to the intent. Each
16472
+ # time a developer adds an existing sample by editing an intent or training,
16473
+ # this counter is increased.
16474
+ # Corresponds to the JSON property `timesAddedCount`
16475
+ # @return [Fixnum]
16476
+ attr_accessor :times_added_count
16477
+
16478
+ # Required. The type of the training phrase.
16479
+ # Corresponds to the JSON property `type`
16480
+ # @return [String]
16481
+ attr_accessor :type
16482
+
16483
+ def initialize(**args)
16484
+ update!(**args)
16485
+ end
16486
+
16487
+ # Update properties of this object
16488
+ def update!(**args)
16489
+ @name = args[:name] if args.key?(:name)
16490
+ @parts = args[:parts] if args.key?(:parts)
16491
+ @times_added_count = args[:times_added_count] if args.key?(:times_added_count)
16492
+ @type = args[:type] if args.key?(:type)
16493
+ end
16494
+ end
16495
+
16496
+ # Represents a part of a training phrase.
16497
+ class GoogleCloudDialogflowV2IntentTrainingPhrasePart
16498
+ include Google::Apis::Core::Hashable
16499
+
16500
+ # Optional. The parameter name for the value extracted from the annotated part
16501
+ # of the example. This field is required for annotated parts of the training
16502
+ # phrase.
16503
+ # Corresponds to the JSON property `alias`
16504
+ # @return [String]
16505
+ attr_accessor :alias
16506
+
16507
+ # Optional. The entity type name prefixed with `@`. This field is required for
16508
+ # annotated parts of the training phrase.
16509
+ # Corresponds to the JSON property `entityType`
16510
+ # @return [String]
16511
+ attr_accessor :entity_type
16512
+
16513
+ # Required. The text for this part.
16514
+ # Corresponds to the JSON property `text`
16515
+ # @return [String]
16516
+ attr_accessor :text
16517
+
16518
+ # Optional. Indicates whether the text was manually annotated. This field is set
16519
+ # to true when the Dialogflow Console is used to manually annotate the part.
16520
+ # When creating an annotated part with the API, you must set this to true.
16521
+ # Corresponds to the JSON property `userDefined`
16522
+ # @return [Boolean]
16523
+ attr_accessor :user_defined
16524
+ alias_method :user_defined?, :user_defined
16525
+
16526
+ def initialize(**args)
16527
+ update!(**args)
16528
+ end
16529
+
16530
+ # Update properties of this object
16531
+ def update!(**args)
16532
+ @alias = args[:alias] if args.key?(:alias)
16533
+ @entity_type = args[:entity_type] if args.key?(:entity_type)
16534
+ @text = args[:text] if args.key?(:text)
16535
+ @user_defined = args[:user_defined] if args.key?(:user_defined)
16536
+ end
16537
+ end
16538
+
16539
+ # Represents a Knowledge Assist answer.
16540
+ class GoogleCloudDialogflowV2KnowledgeAssistAnswer
16541
+ include Google::Apis::Core::Hashable
16542
+
16543
+ # The name of the answer record. Format: `projects//locations//answer Records/`.
16544
+ # Corresponds to the JSON property `answerRecord`
16545
+ # @return [String]
16546
+ attr_accessor :answer_record
16547
+
16548
+ # Represents a suggested query.
16549
+ # Corresponds to the JSON property `suggestedQuery`
16550
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery]
16551
+ attr_accessor :suggested_query
16552
+
16553
+ # Represents an answer from Knowledge. Currently supports FAQ and Generative
16554
+ # answers.
16555
+ # Corresponds to the JSON property `suggestedQueryAnswer`
16556
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer]
16557
+ attr_accessor :suggested_query_answer
16558
+
16559
+ def initialize(**args)
16560
+ update!(**args)
16561
+ end
16562
+
16563
+ # Update properties of this object
16564
+ def update!(**args)
16565
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
16566
+ @suggested_query = args[:suggested_query] if args.key?(:suggested_query)
16567
+ @suggested_query_answer = args[:suggested_query_answer] if args.key?(:suggested_query_answer)
16568
+ end
16569
+ end
16570
+
16571
+ # Represents an answer from Knowledge. Currently supports FAQ and Generative
16572
+ # answers.
16573
+ class GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer
16574
+ include Google::Apis::Core::Hashable
16575
+
16576
+ # The piece of text from the `source` that answers this suggested query.
16577
+ # Corresponds to the JSON property `answerText`
16578
+ # @return [String]
16579
+ attr_accessor :answer_text
16580
+
16581
+ # Details about source of FAQ answer.
16582
+ # Corresponds to the JSON property `faqSource`
16583
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource]
16584
+ attr_accessor :faq_source
16585
+
16586
+ # Details about source of Generative answer.
16587
+ # Corresponds to the JSON property `generativeSource`
16588
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource]
16589
+ attr_accessor :generative_source
16590
+
16591
+ def initialize(**args)
16592
+ update!(**args)
16593
+ end
16594
+
16595
+ # Update properties of this object
16596
+ def update!(**args)
16597
+ @answer_text = args[:answer_text] if args.key?(:answer_text)
16598
+ @faq_source = args[:faq_source] if args.key?(:faq_source)
16599
+ @generative_source = args[:generative_source] if args.key?(:generative_source)
16600
+ end
16601
+ end
16602
+
16603
+ # Details about source of FAQ answer.
16604
+ class GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource
16605
+ include Google::Apis::Core::Hashable
16606
+
16607
+ # The corresponding FAQ question.
16608
+ # Corresponds to the JSON property `question`
16609
+ # @return [String]
16610
+ attr_accessor :question
16611
+
16612
+ def initialize(**args)
16613
+ update!(**args)
16614
+ end
16615
+
16616
+ # Update properties of this object
16617
+ def update!(**args)
16618
+ @question = args[:question] if args.key?(:question)
16619
+ end
16620
+ end
16621
+
16622
+ # Details about source of Generative answer.
16623
+ class GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource
16624
+ include Google::Apis::Core::Hashable
16625
+
16626
+ # All snippets used for this Generative Prediction, with their source URI and
16627
+ # data.
16628
+ # Corresponds to the JSON property `snippets`
16629
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet>]
16630
+ attr_accessor :snippets
15141
16631
 
15142
16632
  def initialize(**args)
15143
16633
  update!(**args)
@@ -15145,53 +16635,28 @@ module Google
15145
16635
 
15146
16636
  # Update properties of this object
15147
16637
  def update!(**args)
15148
- @default_value = args[:default_value] if args.key?(:default_value)
15149
- @display_name = args[:display_name] if args.key?(:display_name)
15150
- @entity_type_display_name = args[:entity_type_display_name] if args.key?(:entity_type_display_name)
15151
- @is_list = args[:is_list] if args.key?(:is_list)
15152
- @mandatory = args[:mandatory] if args.key?(:mandatory)
15153
- @name = args[:name] if args.key?(:name)
15154
- @prompts = args[:prompts] if args.key?(:prompts)
15155
- @value = args[:value] if args.key?(:value)
16638
+ @snippets = args[:snippets] if args.key?(:snippets)
15156
16639
  end
15157
16640
  end
15158
16641
 
15159
- # Represents an example that the agent is trained on.
15160
- class GoogleCloudDialogflowV2IntentTrainingPhrase
16642
+ # Snippet Source for a Generative Prediction.
16643
+ class GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet
15161
16644
  include Google::Apis::Core::Hashable
15162
16645
 
15163
- # Output only. The unique identifier of this training phrase.
15164
- # Corresponds to the JSON property `name`
16646
+ # Text taken from that URI.
16647
+ # Corresponds to the JSON property `text`
15165
16648
  # @return [String]
15166
- attr_accessor :name
15167
-
15168
- # Required. The ordered list of training phrase parts. The parts are
15169
- # concatenated in order to form the training phrase. Note: The API does not
15170
- # automatically annotate training phrases like the Dialogflow Console does. Note:
15171
- # Do not forget to include whitespace at part boundaries, so the training
15172
- # phrase is well formatted when the parts are concatenated. If the training
15173
- # phrase does not need to be annotated with parameters, you just need a single
15174
- # part with only the Part.text field set. If you want to annotate the training
15175
- # phrase, you must create multiple parts, where the fields of each part are
15176
- # populated in one of two ways: - `Part.text` is set to a part of the phrase
15177
- # that has no parameters. - `Part.text` is set to a part of the phrase that you
15178
- # want to annotate, and the `entity_type`, `alias`, and `user_defined` fields
15179
- # are all set.
15180
- # Corresponds to the JSON property `parts`
15181
- # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentTrainingPhrasePart>]
15182
- attr_accessor :parts
16649
+ attr_accessor :text
15183
16650
 
15184
- # Optional. Indicates how many times this example was added to the intent. Each
15185
- # time a developer adds an existing sample by editing an intent or training,
15186
- # this counter is increased.
15187
- # Corresponds to the JSON property `timesAddedCount`
15188
- # @return [Fixnum]
15189
- attr_accessor :times_added_count
16651
+ # Title of the document.
16652
+ # Corresponds to the JSON property `title`
16653
+ # @return [String]
16654
+ attr_accessor :title
15190
16655
 
15191
- # Required. The type of the training phrase.
15192
- # Corresponds to the JSON property `type`
16656
+ # URI the data is sourced from.
16657
+ # Corresponds to the JSON property `uri`
15193
16658
  # @return [String]
15194
- attr_accessor :type
16659
+ attr_accessor :uri
15195
16660
 
15196
16661
  def initialize(**args)
15197
16662
  update!(**args)
@@ -15199,42 +16664,20 @@ module Google
15199
16664
 
15200
16665
  # Update properties of this object
15201
16666
  def update!(**args)
15202
- @name = args[:name] if args.key?(:name)
15203
- @parts = args[:parts] if args.key?(:parts)
15204
- @times_added_count = args[:times_added_count] if args.key?(:times_added_count)
15205
- @type = args[:type] if args.key?(:type)
16667
+ @text = args[:text] if args.key?(:text)
16668
+ @title = args[:title] if args.key?(:title)
16669
+ @uri = args[:uri] if args.key?(:uri)
15206
16670
  end
15207
16671
  end
15208
16672
 
15209
- # Represents a part of a training phrase.
15210
- class GoogleCloudDialogflowV2IntentTrainingPhrasePart
16673
+ # Represents a suggested query.
16674
+ class GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery
15211
16675
  include Google::Apis::Core::Hashable
15212
16676
 
15213
- # Optional. The parameter name for the value extracted from the annotated part
15214
- # of the example. This field is required for annotated parts of the training
15215
- # phrase.
15216
- # Corresponds to the JSON property `alias`
15217
- # @return [String]
15218
- attr_accessor :alias
15219
-
15220
- # Optional. The entity type name prefixed with `@`. This field is required for
15221
- # annotated parts of the training phrase.
15222
- # Corresponds to the JSON property `entityType`
15223
- # @return [String]
15224
- attr_accessor :entity_type
15225
-
15226
- # Required. The text for this part.
15227
- # Corresponds to the JSON property `text`
16677
+ # Suggested query text.
16678
+ # Corresponds to the JSON property `queryText`
15228
16679
  # @return [String]
15229
- attr_accessor :text
15230
-
15231
- # Optional. Indicates whether the text was manually annotated. This field is set
15232
- # to true when the Dialogflow Console is used to manually annotate the part.
15233
- # When creating an annotated part with the API, you must set this to true.
15234
- # Corresponds to the JSON property `userDefined`
15235
- # @return [Boolean]
15236
- attr_accessor :user_defined
15237
- alias_method :user_defined?, :user_defined
16680
+ attr_accessor :query_text
15238
16681
 
15239
16682
  def initialize(**args)
15240
16683
  update!(**args)
@@ -15242,10 +16685,7 @@ module Google
15242
16685
 
15243
16686
  # Update properties of this object
15244
16687
  def update!(**args)
15245
- @alias = args[:alias] if args.key?(:alias)
15246
- @entity_type = args[:entity_type] if args.key?(:entity_type)
15247
- @text = args[:text] if args.key?(:text)
15248
- @user_defined = args[:user_defined] if args.key?(:user_defined)
16688
+ @query_text = args[:query_text] if args.key?(:query_text)
15249
16689
  end
15250
16690
  end
15251
16691
 
@@ -15849,6 +17289,41 @@ module Google
15849
17289
  end
15850
17290
  end
15851
17291
 
17292
+ # The response message for Participants.SuggestKnowledgeAssist.
17293
+ class GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse
17294
+ include Google::Apis::Core::Hashable
17295
+
17296
+ # Number of messages prior to and including latest_message to compile the
17297
+ # suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.
17298
+ # context_size field in the request if there are fewer messages in the
17299
+ # conversation.
17300
+ # Corresponds to the JSON property `contextSize`
17301
+ # @return [Fixnum]
17302
+ attr_accessor :context_size
17303
+
17304
+ # Represents a Knowledge Assist answer.
17305
+ # Corresponds to the JSON property `knowledgeAssistAnswer`
17306
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2KnowledgeAssistAnswer]
17307
+ attr_accessor :knowledge_assist_answer
17308
+
17309
+ # The name of the latest conversation message used to compile suggestion for.
17310
+ # Format: `projects//locations//conversations//messages/`.
17311
+ # Corresponds to the JSON property `latestMessage`
17312
+ # @return [String]
17313
+ attr_accessor :latest_message
17314
+
17315
+ def initialize(**args)
17316
+ update!(**args)
17317
+ end
17318
+
17319
+ # Update properties of this object
17320
+ def update!(**args)
17321
+ @context_size = args[:context_size] if args.key?(:context_size)
17322
+ @knowledge_assist_answer = args[:knowledge_assist_answer] if args.key?(:knowledge_assist_answer)
17323
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
17324
+ end
17325
+ end
17326
+
15852
17327
  # The response message for Participants.SuggestSmartReplies.
15853
17328
  class GoogleCloudDialogflowV2SuggestSmartRepliesResponse
15854
17329
  include Google::Apis::Core::Hashable
@@ -15911,6 +17386,11 @@ module Google
15911
17386
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
15912
17387
  attr_accessor :suggest_faq_answers_response
15913
17388
 
17389
+ # The response message for Participants.SuggestKnowledgeAssist.
17390
+ # Corresponds to the JSON property `suggestKnowledgeAssistResponse`
17391
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse]
17392
+ attr_accessor :suggest_knowledge_assist_response
17393
+
15914
17394
  # The response message for Participants.SuggestSmartReplies.
15915
17395
  # Corresponds to the JSON property `suggestSmartRepliesResponse`
15916
17396
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SuggestSmartRepliesResponse]
@@ -15925,6 +17405,7 @@ module Google
15925
17405
  @error = args[:error] if args.key?(:error)
15926
17406
  @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
15927
17407
  @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
17408
+ @suggest_knowledge_assist_response = args[:suggest_knowledge_assist_response] if args.key?(:suggest_knowledge_assist_response)
15928
17409
  @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
15929
17410
  end
15930
17411
  end
@@ -18529,6 +20010,159 @@ module Google
18529
20010
  end
18530
20011
  end
18531
20012
 
20013
+ # Represents a Knowledge Assist answer.
20014
+ class GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer
20015
+ include Google::Apis::Core::Hashable
20016
+
20017
+ # The name of the answer record. Format: `projects//locations//answer Records/`.
20018
+ # Corresponds to the JSON property `answerRecord`
20019
+ # @return [String]
20020
+ attr_accessor :answer_record
20021
+
20022
+ # Represents a suggested query.
20023
+ # Corresponds to the JSON property `suggestedQuery`
20024
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery]
20025
+ attr_accessor :suggested_query
20026
+
20027
+ # Represents an answer from Knowledge. Currently supports FAQ and Generative
20028
+ # answers.
20029
+ # Corresponds to the JSON property `suggestedQueryAnswer`
20030
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer]
20031
+ attr_accessor :suggested_query_answer
20032
+
20033
+ def initialize(**args)
20034
+ update!(**args)
20035
+ end
20036
+
20037
+ # Update properties of this object
20038
+ def update!(**args)
20039
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
20040
+ @suggested_query = args[:suggested_query] if args.key?(:suggested_query)
20041
+ @suggested_query_answer = args[:suggested_query_answer] if args.key?(:suggested_query_answer)
20042
+ end
20043
+ end
20044
+
20045
+ # Represents an answer from Knowledge. Currently supports FAQ and Generative
20046
+ # answers.
20047
+ class GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer
20048
+ include Google::Apis::Core::Hashable
20049
+
20050
+ # The piece of text from the `source` that answers this suggested query.
20051
+ # Corresponds to the JSON property `answerText`
20052
+ # @return [String]
20053
+ attr_accessor :answer_text
20054
+
20055
+ # Details about source of FAQ answer.
20056
+ # Corresponds to the JSON property `faqSource`
20057
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource]
20058
+ attr_accessor :faq_source
20059
+
20060
+ # Details about source of Generative answer.
20061
+ # Corresponds to the JSON property `generativeSource`
20062
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource]
20063
+ attr_accessor :generative_source
20064
+
20065
+ def initialize(**args)
20066
+ update!(**args)
20067
+ end
20068
+
20069
+ # Update properties of this object
20070
+ def update!(**args)
20071
+ @answer_text = args[:answer_text] if args.key?(:answer_text)
20072
+ @faq_source = args[:faq_source] if args.key?(:faq_source)
20073
+ @generative_source = args[:generative_source] if args.key?(:generative_source)
20074
+ end
20075
+ end
20076
+
20077
+ # Details about source of FAQ answer.
20078
+ class GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource
20079
+ include Google::Apis::Core::Hashable
20080
+
20081
+ # The corresponding FAQ question.
20082
+ # Corresponds to the JSON property `question`
20083
+ # @return [String]
20084
+ attr_accessor :question
20085
+
20086
+ def initialize(**args)
20087
+ update!(**args)
20088
+ end
20089
+
20090
+ # Update properties of this object
20091
+ def update!(**args)
20092
+ @question = args[:question] if args.key?(:question)
20093
+ end
20094
+ end
20095
+
20096
+ # Details about source of Generative answer.
20097
+ class GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource
20098
+ include Google::Apis::Core::Hashable
20099
+
20100
+ # All snippets used for this Generative Prediction, with their source URI and
20101
+ # data.
20102
+ # Corresponds to the JSON property `snippets`
20103
+ # @return [Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet>]
20104
+ attr_accessor :snippets
20105
+
20106
+ def initialize(**args)
20107
+ update!(**args)
20108
+ end
20109
+
20110
+ # Update properties of this object
20111
+ def update!(**args)
20112
+ @snippets = args[:snippets] if args.key?(:snippets)
20113
+ end
20114
+ end
20115
+
20116
+ # Snippet Source for a Generative Prediction.
20117
+ class GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet
20118
+ include Google::Apis::Core::Hashable
20119
+
20120
+ # Text taken from that URI.
20121
+ # Corresponds to the JSON property `text`
20122
+ # @return [String]
20123
+ attr_accessor :text
20124
+
20125
+ # Title of the document.
20126
+ # Corresponds to the JSON property `title`
20127
+ # @return [String]
20128
+ attr_accessor :title
20129
+
20130
+ # URI the data is sourced from.
20131
+ # Corresponds to the JSON property `uri`
20132
+ # @return [String]
20133
+ attr_accessor :uri
20134
+
20135
+ def initialize(**args)
20136
+ update!(**args)
20137
+ end
20138
+
20139
+ # Update properties of this object
20140
+ def update!(**args)
20141
+ @text = args[:text] if args.key?(:text)
20142
+ @title = args[:title] if args.key?(:title)
20143
+ @uri = args[:uri] if args.key?(:uri)
20144
+ end
20145
+ end
20146
+
20147
+ # Represents a suggested query.
20148
+ class GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery
20149
+ include Google::Apis::Core::Hashable
20150
+
20151
+ # Suggested query text.
20152
+ # Corresponds to the JSON property `queryText`
20153
+ # @return [String]
20154
+ attr_accessor :query_text
20155
+
20156
+ def initialize(**args)
20157
+ update!(**args)
20158
+ end
20159
+
20160
+ # Update properties of this object
20161
+ def update!(**args)
20162
+ @query_text = args[:query_text] if args.key?(:query_text)
20163
+ end
20164
+ end
20165
+
18532
20166
  # Metadata in google::longrunning::Operation for Knowledge operations.
18533
20167
  class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata
18534
20168
  include Google::Apis::Core::Hashable
@@ -19155,6 +20789,41 @@ module Google
19155
20789
  end
19156
20790
  end
19157
20791
 
20792
+ # The response message for Participants.SuggestKnowledgeAssist.
20793
+ class GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse
20794
+ include Google::Apis::Core::Hashable
20795
+
20796
+ # Number of messages prior to and including latest_message to compile the
20797
+ # suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.
20798
+ # context_size field in the request if there are fewer messages in the
20799
+ # conversation.
20800
+ # Corresponds to the JSON property `contextSize`
20801
+ # @return [Fixnum]
20802
+ attr_accessor :context_size
20803
+
20804
+ # Represents a Knowledge Assist answer.
20805
+ # Corresponds to the JSON property `knowledgeAssistAnswer`
20806
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer]
20807
+ attr_accessor :knowledge_assist_answer
20808
+
20809
+ # The name of the latest conversation message used to compile suggestion for.
20810
+ # Format: `projects//locations//conversations//messages/`.
20811
+ # Corresponds to the JSON property `latestMessage`
20812
+ # @return [String]
20813
+ attr_accessor :latest_message
20814
+
20815
+ def initialize(**args)
20816
+ update!(**args)
20817
+ end
20818
+
20819
+ # Update properties of this object
20820
+ def update!(**args)
20821
+ @context_size = args[:context_size] if args.key?(:context_size)
20822
+ @knowledge_assist_answer = args[:knowledge_assist_answer] if args.key?(:knowledge_assist_answer)
20823
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
20824
+ end
20825
+ end
20826
+
19158
20827
  # The response message for Participants.SuggestSmartReplies.
19159
20828
  class GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse
19160
20829
  include Google::Apis::Core::Hashable
@@ -19227,6 +20896,11 @@ module Google
19227
20896
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse]
19228
20897
  attr_accessor :suggest_faq_answers_response
19229
20898
 
20899
+ # The response message for Participants.SuggestKnowledgeAssist.
20900
+ # Corresponds to the JSON property `suggestKnowledgeAssistResponse`
20901
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse]
20902
+ attr_accessor :suggest_knowledge_assist_response
20903
+
19230
20904
  # The response message for Participants.SuggestSmartReplies.
19231
20905
  # Corresponds to the JSON property `suggestSmartRepliesResponse`
19232
20906
  # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse]
@@ -19243,6 +20917,7 @@ module Google
19243
20917
  @suggest_dialogflow_assists_response = args[:suggest_dialogflow_assists_response] if args.key?(:suggest_dialogflow_assists_response)
19244
20918
  @suggest_entity_extraction_response = args[:suggest_entity_extraction_response] if args.key?(:suggest_entity_extraction_response)
19245
20919
  @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
20920
+ @suggest_knowledge_assist_response = args[:suggest_knowledge_assist_response] if args.key?(:suggest_knowledge_assist_response)
19246
20921
  @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
19247
20922
  end
19248
20923
  end