Fulfillment(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A fulfillment can do one or more of the following actions at the same time:
- Generate rich message responses.
- Set parameter values.
- Call the webhook.
Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.
Attributes | |
---|---|
Name | Description |
messages |
Sequence[google.cloud.dialogflowcx_v3.types.ResponseMessage]
The list of rich message responses to present to the user. |
webhook |
str
The webhook to call. Format: projects/ .
|
return_partial_responses |
bool
Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
tag |
str
The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is
specified.
|
set_parameter_actions |
Sequence[google.cloud.dialogflowcx_v3.types.Fulfillment.SetParameterAction]
Set parameter values before executing the webhook. |
conditional_cases |
Sequence[google.cloud.dialogflowcx_v3.types.Fulfillment.ConditionalCases]
Conditional cases for this fulfillment. |
Classes
ConditionalCases
ConditionalCases(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
SetParameterAction
SetParameterAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Setting a parameter value.