GoogleCloudDialogflowV2beta1WebhookResponse class
The response message for a webhook call. This response is validated by the
Dialogflow server. If validation fails, an error will be returned in the
QueryResult.diagnostic_info field. Setting JSON fields to an empty value
with the wrong type is a common error. To avoid this error: - Use ""
for
empty strings - Use {}
or null
for empty objects - Use []
or null
for empty arrays For more information, see the Protocol Buffers Language
Guide.
Constructors
Properties
- endInteraction ↔ bool
-
Optional. Indicates that this intent ends an interaction. Some
integrations (e.g., Actions on Google or Dialogflow phone gateway) use
this information to close interaction with an end user. Default is false.
read / write
- followupEventInput ↔ GoogleCloudDialogflowV2beta1EventInput
-
Optional. Invokes the supplied events. When this field is set, Dialogflow
ignores the
fulfillment_text
,fulfillment_messages
, andpayload
fields.read / write -
fulfillmentMessages
↔ List<
GoogleCloudDialogflowV2beta1IntentMessage> -
Optional. The rich response messages intended for the end-user. When
provided, Dialogflow uses this field to populate
QueryResult.fulfillment_messages sent to the integration or API caller.
read / write
- fulfillmentText ↔ String
-
Optional. The text response message intended for the end-user. It is
recommended to use
fulfillment_messages.text.text[0]
instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.read / write - hashCode → int
-
The hash code for this object. [...]
read-only, inherited
-
outputContexts
↔ List<
GoogleCloudDialogflowV2beta1Context> -
Optional. The collection of output contexts that will overwrite currently
active contexts for the session and reset their lifespans. When provided,
Dialogflow uses this field to populate QueryResult.output_contexts sent to
the integration or API caller.
read / write
-
payload
↔ Map<
String, Object> -
Optional. This field can be used to pass custom data from your webhook to
the integration or API caller. Arbitrary JSON objects are supported. When
provided, Dialogflow uses this field to populate
QueryResult.webhook_payload sent to the integration or API caller. This
field is also used by the Google Assistant
integration
for rich response messages. See the format definition at Google Assistant
Dialogflow webhook
format [...]
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
-
sessionEntityTypes
↔ List<
GoogleCloudDialogflowV2beta1SessionEntityType> -
Optional. Additional session entity types to replace or extend developer
entity types with. The entity synonyms apply to all languages and persist
for the session. Setting this data from a webhook overwrites the session
entity types that have been set using
detectIntent
,streamingDetectIntent
or SessionEntityType management methods.read / write - source ↔ String
-
Optional. A custom field used to identify the webhook source. Arbitrary
strings are supported. When provided, Dialogflow uses this field to
populate QueryResult.webhook_source sent to the integration or API caller.
read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, Object> -
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited