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