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.
Attributes:
detect_intent_response_id (str):
Always present. The unique identifier of the
[DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse]
that will be returned to the API caller.
text (str):
If [natural language
text][google.cloud.dialogflow.cx.v3.TextInput] was provided
as input, this field will contain a copy of the text.
trigger_intent (str):
If an [intent][google.cloud.dialogflow.cx.v3.IntentInput]
was provided as input, this field will contain a copy of the
intent identifier. Format:
projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>
.
transcript (str):
If [natural language speech
audio][google.cloud.dialogflow.cx.v3.AudioInput] was
provided as input, this field will contain the transcript
for the audio.
trigger_event (str):
If an [event][google.cloud.dialogflow.cx.v3.EventInput] was
provided as input, this field will contain the name of the
event.
language_code (str):
The language code specified in the [original
request][QueryInput.language_code].
fulfillment_info (google.cloud.dialogflowcx_v3.types.WebhookRequest.FulfillmentInfo):
Always present. Information about the
fulfillment that triggered this webhook call.
intent_info (google.cloud.dialogflowcx_v3.types.WebhookRequest.IntentInfo):
Information about the last matched intent.
page_info (google.cloud.dialogflowcx_v3.types.PageInfo):
Information about page status.
session_info (google.cloud.dialogflowcx_v3.types.SessionInfo):
Information about session status.
messages (Sequence[google.cloud.dialogflowcx_v3.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][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response];
payload (google.protobuf.struct_pb2.Struct):
Custom data set in
[QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload].
sentiment_analysis_result (google.cloud.dialogflowcx_v3.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.