WebhookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
---|---|
Name | Description |
detect_intent_response_id |
str
Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller. |
text |
str
If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput] was provided as input, this field will contain a copy of the text. This field is a member of oneof _ query .
|
trigger_intent |
str
If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/ .
This field is a member of oneof _ query .
|
transcript |
str
If [natural language speech audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as input, this field will contain the transcript for the audio. This field is a member of oneof _ query .
|
trigger_event |
str
If an event was provided as input, this field will contain the name of the event. This field is a member of oneof _ query .
|
dtmf_digits |
str
If DTMF was provided as input, this field will contain the DTMF digits. This field is a member of oneof _ query .
|
language_code |
str
The language code specified in the [original request][QueryInput.language_code]. |
fulfillment_info |
google.cloud.dialogflowcx_v3beta1.types.WebhookRequest.FulfillmentInfo
Always present. Information about the fulfillment that triggered this webhook call. |
intent_info |
google.cloud.dialogflowcx_v3beta1.types.WebhookRequest.IntentInfo
Information about the last matched intent. |
page_info |
google.cloud.dialogflowcx_v3beta1.types.PageInfo
Information about page status. |
session_info |
google.cloud.dialogflowcx_v3beta1.types.SessionInfo
Information about session status. |
messages |
MutableSequence[google.cloud.dialogflowcx_v3beta1.types.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 |
google.protobuf.struct_pb2.Struct
Custom data set in QueryParameters.payload. |
sentiment_analysis_result |
google.cloud.dialogflowcx_v3beta1.types.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. |
Classes
FulfillmentInfo
FulfillmentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents fulfillment information communicated to the webhook.
IntentInfo
IntentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents intent information communicated to the webhook.
SentimentAnalysisResult
SentimentAnalysisResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the result of sentiment analysis.