Google Cloud Dialogflow Cx V3 Client - Class ResponseMessage (0.1.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class 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.

Generated from protobuf message google.cloud.dialogflow.cx.v3.ResponseMessage

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ text
↳ payload
Google\Protobuf\Struct

Returns a response containing a custom, platform-specific payload.

↳ conversation_success
Google\Cloud\Dialogflow\Cx\V3\ResponseMessage\ConversationSuccess

Indicates that the conversation succeeded.

↳ output_audio_text
Google\Cloud\Dialogflow\Cx\V3\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\Dialogflow\Cx\V3\ResponseMessage\LiveAgentHandoff

Hands off conversation to a human agent.

↳ end_interaction
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.

↳ play_audio
Google\Cloud\Dialogflow\Cx\V3\ResponseMessage\PlayAudio

Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio . However, Dialogflow itself does not try to read or process the URI in any way.

↳ mixed_audio
Google\Cloud\Dialogflow\Cx\V3\ResponseMessage\MixedAudio

Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio . This message is generated by Dialogflow only and not supposed to be defined by the user.

↳ telephony_transfer_call
Google\Cloud\Dialogflow\Cx\V3\ResponseMessage\TelephonyTransferCall

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

↳ knowledge_info_card
Google\Cloud\Dialogflow\Cx\V3\ResponseMessage\KnowledgeInfoCard

Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.

↳ response_type
int

Response type.

↳ 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.

getText

Returns a text response.

hasText

setText

Returns a text response.

Returns
Type
Description
$this

getPayload

Returns a response containing a custom, platform-specific payload.

Returns
Type
Description

hasPayload

setPayload

Returns a response containing a custom, platform-specific payload.

Parameter
Name
Description
Returns
Type
Description
$this

getConversationSuccess

Indicates that the conversation succeeded.

hasConversationSuccess

setConversationSuccess

Indicates that the conversation succeeded.

Returns
Type
Description
$this

getOutputAudioText

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

hasOutputAudioText

setOutputAudioText

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

Returns
Type
Description
$this

getLiveAgentHandoff

Hands off conversation to a human agent.

hasLiveAgentHandoff

setLiveAgentHandoff

Hands off conversation to a human agent.

Returns
Type
Description
$this

getEndInteraction

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.

hasEndInteraction

setEndInteraction

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.

Returns
Type
Description
$this

getPlayAudio

Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio .

However, Dialogflow itself does not try to read or process the URI in any way.

hasPlayAudio

setPlayAudio

Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio .

However, Dialogflow itself does not try to read or process the URI in any way.

Returns
Type
Description
$this

getMixedAudio

Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio .

This message is generated by Dialogflow only and not supposed to be defined by the user.

hasMixedAudio

setMixedAudio

Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio .

This message is generated by Dialogflow only and not supposed to be defined by the user.

Returns
Type
Description
$this

getTelephonyTransferCall

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

hasTelephonyTransferCall

setTelephonyTransferCall

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

Returns
Type
Description
$this

getKnowledgeInfoCard

Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.

hasKnowledgeInfoCard

setKnowledgeInfoCard

Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.

Returns
Type
Description
$this

getResponseType

Response type.

Returns
Type
Description
int

setResponseType

Response type.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getChannel

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
Type
Description
string

setChannel

The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel , and only associated channel response will be returned.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getMessage

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: