Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::ResponseMessage (v1.2.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::ResponseMessage.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#channel

def channel() -> ::String
Returns
  • (::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.

#channel=

def channel=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#conversation_success

def conversation_success() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess
Returns

#conversation_success=

def conversation_success=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess
Parameter
Returns

#end_interaction

def end_interaction() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::EndInteraction
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::EndInteraction) — Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user.

    It's guaranteed that there is at most one such message in each response.

#knowledge_info_card

def knowledge_info_card() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::KnowledgeInfoCard
Returns

#knowledge_info_card=

def knowledge_info_card=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::KnowledgeInfoCard
Parameter
Returns

#live_agent_handoff

def live_agent_handoff() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff
Returns

#live_agent_handoff=

def live_agent_handoff=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff
Parameter
Returns

#mixed_audio

def mixed_audio() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::MixedAudio
Returns

#output_audio_text

def output_audio_text() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText
Returns

#output_audio_text=

def output_audio_text=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText
Parameter
Returns

#payload

def payload() -> ::Google::Protobuf::Struct
Returns

#payload=

def payload=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#play_audio

def play_audio() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio
Returns

#play_audio=

def play_audio=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio
Parameter
Returns

#response_type

def response_type() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType

#response_type=

def response_type=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType

#telephony_transfer_call

def telephony_transfer_call() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall
Returns

#telephony_transfer_call=

def telephony_transfer_call=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall
Parameter
Returns

#text

def text() -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text
Returns

#text=

def text=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text
Parameter
Returns