Class ResponseMessage (0.8.0)

Version 0.8.0

• 1.37.0 (latest)
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

ResponseMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes: text (google.cloud.dialogflowcx_v3.types.ResponseMessage.Text): Returns a text response. payload (google.protobuf.struct_pb2.Struct): Returns a response containing a custom, platform-specific payload. conversation_success (google.cloud.dialogflowcx_v3.types.ResponseMessage.ConversationSuccess): Indicates that the conversation succeeded. output_audio_text (google.cloud.dialogflowcx_v3.types.ResponseMessage.OutputAudioText): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. live_agent_handoff (google.cloud.dialogflowcx_v3.types.ResponseMessage.LiveAgentHandoff): Hands off conversation to a human agent. end_interaction (google.cloud.dialogflowcx_v3.types.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.
play_audio (google.cloud.dialogflowcx_v3.types.ResponseMessage.PlayAudio):
    Signal that the client should play an audio clip hosted at a
    client-specific URI. Dialogflow uses this to construct
    [mixed_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.mixed_audio].
    However, Dialogflow itself does not try to read or process
    the URI in any way.
mixed_audio (google.cloud.dialogflowcx_v3.types.ResponseMessage.MixedAudio):
    Output only. An audio response message composed of both the
    synthesized Dialogflow agent responses and responses defined
    via
    [play_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio].
    This message is generated by Dialogflow only and not
    supposed to be defined by the user.

Inheritance

builtins.object > proto.message.Message > ResponseMessage