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.

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
NameDescription
strdetect_intent_response_id
Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.
strtext
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``.
strtrigger_intent
If an intent was provided as input, this field will contain a copy of the intent identifier. Format: ``projects/
strtranscript
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``.
strtrigger_event
If an event was provided as input, this field will contain the name of the event. This field is a member of `oneof`_ ``query``.
strlanguage_code
The language code specified in the [original request][QueryInput.language_code].
google.cloud.dialogflowcx_v3beta1.types.WebhookRequest.FulfillmentInfofulfillment_info
Always present. Information about the fulfillment that triggered this webhook call.
google.cloud.dialogflowcx_v3beta1.types.WebhookRequest.IntentInfointent_info
Information about the last matched intent.
google.cloud.dialogflowcx_v3beta1.types.PageInfopage_info
Information about page status.
google.cloud.dialogflowcx_v3beta1.types.SessionInfosession_info
Information about session status.
Sequence[google.cloud.dialogflowcx_v3beta1.types.ResponseMessage]messages
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.protobuf.struct_pb2.Structpayload
Custom data set in QueryParameters.payload.
google.cloud.dialogflowcx_v3beta1.types.WebhookRequest.SentimentAnalysisResultsentiment_analysis_result
The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

Inheritance

builtins.object > proto.message.Message > WebhookRequest

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.