Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class WebhookRequest.
The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.
You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.
Generated from protobuf message google.cloud.dialogflow.cx.v3.WebhookRequest
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ detect_intent_response_id
string
Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.
↳ text
↳ trigger_intent
string
If an intent
was provided as input, this field will contain a copy of the intent identifier. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>
.
↳ transcript
string
If natural language speech audio was provided as input, this field will contain the transcript for the audio.
↳ trigger_event
↳ dtmf_digits
↳ language_code
string
The language code specified in the original request .
↳ fulfillment_info
WebhookRequest\FulfillmentInfo
Always present. Information about the fulfillment that triggered this webhook call.
↳ intent_info
↳ page_info
↳ session_info
↳ messages
array< ResponseMessage
>
The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response ;
↳ payload
↳ sentiment_analysis_result
WebhookRequest\SentimentAnalysisResult
The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.
↳ language_info
getDetectIntentResponseId
Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.
string
setDetectIntentResponseId
Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.
var
string
$this
getText
If natural language text was provided as input, this field will contain a copy of the text.
string
hasText
setText
If natural language text was provided as input, this field will contain a copy of the text.
var
string
$this
getTriggerIntent
If an intent
was provided as
input, this field will contain a copy of the intent identifier. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>
.
string
hasTriggerIntent
setTriggerIntent
If an intent
was provided as
input, this field will contain a copy of the intent identifier. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>
.
var
string
$this
getTranscript
If natural language speech audio was provided as input, this field will contain the transcript for the audio.
string
hasTranscript
setTranscript
If natural language speech audio was provided as input, this field will contain the transcript for the audio.
var
string
$this
getTriggerEvent
If an event was provided as input, this field will contain the name of the event.
string
hasTriggerEvent
setTriggerEvent
If an event was provided as input, this field will contain the name of the event.
var
string
$this
getDtmfDigits
If DTMF was provided as input, this field will contain the DTMF digits.
string
hasDtmfDigits
setDtmfDigits
If DTMF was provided as input, this field will contain the DTMF digits.
var
string
$this
getLanguageCode
The language code specified in the original request .
string
setLanguageCode
The language code specified in the original request .
var
string
$this
getFulfillmentInfo
Always present. Information about the fulfillment that triggered this webhook call.
hasFulfillmentInfo
clearFulfillmentInfo
setFulfillmentInfo
Always present. Information about the fulfillment that triggered this webhook call.
$this
getIntentInfo
Information about the last matched intent.
hasIntentInfo
clearIntentInfo
setIntentInfo
Information about the last matched intent.
$this
getPageInfo
Information about page status.
hasPageInfo
clearPageInfo
setPageInfo
Information about page status.
$this
getSessionInfo
Information about session status.
hasSessionInfo
clearSessionInfo
setSessionInfo
Information about session status.
$this
getMessages
The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response ;
setMessages
The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response ;
$this
getPayload
Custom data set in QueryParameters.payload .
hasPayload
clearPayload
setPayload
Custom data set in QueryParameters.payload .
$this
getSentimentAnalysisResult
The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.
hasSentimentAnalysisResult
clearSentimentAnalysisResult
setSentimentAnalysisResult
The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.
$this
getLanguageInfo
Information about the language of the request.
hasLanguageInfo
clearLanguageInfo
setLanguageInfo
Information about the language of the request.
$this
getQuery
string
