Class WebhookRequest (0.5.0)

Version 0.5.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

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
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.
trigger_intent	str If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/.
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.
trigger_event	str If an event 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_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	Sequence[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. .. attribute:: last_matched_intent

Always present. The unique identifier of the last matched intent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

:type: str

SentimentAnalysisResult

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

Represents the result of sentiment analysis. .. attribute:: score

Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

:type: float