Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1ResponseMessage

Returns a new instance of GoogleCloudDialogflowCxV3beta1ResponseMessage.



6769
6770
6771
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6769

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#conversation_success ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess

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

Returns:



6721
6722
6723
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6721

def conversation_success
  @conversation_success
end

#end_interaction ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction

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

Returns:



6727
6728
6729
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6727

def end_interaction
  @end_interaction
end

#live_agent_handoff ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff

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

Returns:



6738
6739
6740
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6738

def live_agent_handoff
  @live_agent_handoff
end

#mixed_audio ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio

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

Returns:



6746
6747
6748
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6746

def mixed_audio
  @mixed_audio
end

#output_audio_text ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText

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

Returns:



6752
6753
6754
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6752

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

Returns:

  • (Hash<String,Object>) 


6757
6758
6759
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6757

def payload
  @payload
end

#play_audio ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio

Specifies an audio clip to be played by the client as part of the response. Corresponds to the JSON property playAudio

Returns:



6762
6763
6764
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6762

def play_audio
  @play_audio
end

#text ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText

The text response message. Corresponds to the JSON property text

Returns:



6767
6768
6769
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6767

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6774

def update!(**args)
  @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)
  @text = args[:text] if args.key?(:text)
end