Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb
Overview
Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
Instance Attribute Summary collapse
-
#channel ⇒ String
The channel which the response is associated with.
-
#conversation_success ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.
-
#end_interaction ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageEndInteraction
Indicates that interaction with the Dialogflow agent has ended.
-
#live_agent_handoff ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
Indicates that the conversation should be handed off to a live agent.
-
#mixed_audio ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.
-
#output_audio_text ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-
#payload ⇒ Hash<String,Object>
Returns a response containing a custom, platform-specific payload.
-
#play_audio ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
Specifies an audio clip to be played by the client as part of the response.
-
#telephony_transfer_call ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall
Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
-
#text ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageText
The text response message.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3ResponseMessage
constructor
A new instance of GoogleCloudDialogflowCxV3ResponseMessage.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3ResponseMessage
Returns a new instance of GoogleCloudDialogflowCxV3ResponseMessage.
4390 4391 4392 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4390 def initialize(**args) update!(**args) end |
Instance Attribute Details
#channel ⇒ String
The channel which the response is associated with. Clients can specify the
channel via QueryParameters.channel, and only associated channel response will
be returned.
Corresponds to the JSON property channel
4323 4324 4325 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4323 def channel @channel end |
#conversation_success ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
Indicates that the conversation succeeded, i.e., the bot handled the issue
that the customer talked to it about. Dialogflow only uses this to determine
which conversations should be counted as successful and doesn't process the
metadata in this message in any way. Note that Dialogflow also considers
conversations that get to the conversation end page as successful even if they
don't return ConversationSuccess. You may set this, for example: * In the
entry_fulfillment of a Page if entering the page indicates that the
conversation succeeded. * In a webhook response when you determine that you
handled the customer issue.
Corresponds to the JSON property conversationSuccess
4336 4337 4338 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4336 def conversation_success @conversation_success end |
#end_interaction ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageEndInteraction
Indicates that interaction with the Dialogflow agent has ended. This message
is generated by Dialogflow only and not supposed to be defined by the user.
Corresponds to the JSON property endInteraction
4342 4343 4344 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4342 def end_interaction @end_interaction end |
#live_agent_handoff ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
Indicates that the conversation should be handed off to a live agent.
Dialogflow only uses this to determine which conversations were handed off to
a human agent for measurement purposes. What else to do with this signal is up
to you and your handoff procedures. You may set this, for example: * In the
entry_fulfillment of a Page if entering the page indicates something went
extremely wrong in the conversation. * In a webhook response when you
determine that the customer issue can only be handled by a human.
Corresponds to the JSON property liveAgentHandoff
4353 4354 4355 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4353 def live_agent_handoff @live_agent_handoff end |
#mixed_audio ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
Represents an audio message that is composed of both segments synthesized from
the Dialogflow agent prompts and ones hosted externally at the specified URIs.
The external URIs are specified via play_audio. This message is generated by
Dialogflow only and not supposed to be defined by the user.
Corresponds to the JSON property mixedAudio
4361 4362 4363 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4361 def mixed_audio @mixed_audio end |
#output_audio_text ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
A text or ssml response that is preferentially used for TTS output audio
synthesis, as described in the comment on the ResponseMessage message.
Corresponds to the JSON property outputAudioText
4367 4368 4369 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4367 def output_audio_text @output_audio_text end |
#payload ⇒ Hash<String,Object>
Returns a response containing a custom, platform-specific payload.
Corresponds to the JSON property payload
4372 4373 4374 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4372 def payload @payload end |
#play_audio ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
Specifies an audio clip to be played by the client as part of the response.
Corresponds to the JSON property playAudio
4377 4378 4379 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4377 def play_audio @play_audio end |
#telephony_transfer_call ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall
Represents the signal that telles the client to transfer the phone call
connected to the agent to a third-party endpoint.
Corresponds to the JSON property telephonyTransferCall
4383 4384 4385 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4383 def telephony_transfer_call @telephony_transfer_call end |
#text ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessageText
The text response message.
Corresponds to the JSON property text
4388 4389 4390 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4388 def text @text end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4395 def update!(**args) @channel = args[:channel] if args.key?(:channel) @conversation_success = args[:conversation_success] if args.key?(:conversation_success) @end_interaction = args[:end_interaction] if args.key?(:end_interaction) @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff) @mixed_audio = args[:mixed_audio] if args.key?(:mixed_audio) @output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text) @payload = args[:payload] if args.key?(:payload) @play_audio = args[:play_audio] if args.key?(:play_audio) @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call) @text = args[:text] if args.key?(:text) end |