Class WebhookRequest (1.4.0)

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

NameDescription
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.v3.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.v3.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_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;
payload google.protobuf.struct_pb2.Struct
Custom data set in 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.

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