public sealed class Fulfillment : IMessage<Fulfillment>, IEquatable<Fulfillment>, IDeepCloneable<Fulfillment>, IBufferMessage, IMessageReference documentation and code samples for the Dialogflow v3 API class Fulfillment.
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][google.cloud.dialogflow.cx.v3.Page] or [Form][google.cloud.dialogflow.cx.v3.Form] lifecycle. For example, when a [DetectIntentRequest][google.cloud.dialogflow.cx.v3.DetectIntentRequest] drives a session to enter a new page, the page's entry fulfillment can add a static response to the [QueryResult][google.cloud.dialogflow.cx.v3.QueryResult] in the returning [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse], call the webhook (for example, to load user data from a database), or both.
Implements
IMessageFulfillment, IEquatableFulfillment, IDeepCloneableFulfillment, IBufferMessage, IMessageNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
Fulfillment()
public Fulfillment()Fulfillment(Fulfillment)
public Fulfillment(Fulfillment other)| Parameter | |
|---|---|
| Name | Description |
other | Fulfillment |
Properties
AdvancedSettings
public AdvancedSettings AdvancedSettings { get; set; }Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
| Property Value | |
|---|---|
| Type | Description |
AdvancedSettings | |
ConditionalCases
public RepeatedField<Fulfillment.Types.ConditionalCases> ConditionalCases { get; }Conditional cases for this fulfillment.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldFulfillmentTypesConditionalCases | |
EnableGenerativeFallback
public bool EnableGenerativeFallback { get; set; }If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined [responses][google.cloud.dialogflow.cx.v3.Fulfillment.messages] in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
| Property Value | |
|---|---|
| Type | Description |
bool | |
Messages
public RepeatedField<ResponseMessage> Messages { get; }The list of rich message responses to present to the user.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldResponseMessage | |
ReturnPartialResponses
public bool ReturnPartialResponses { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
SetParameterActions
public RepeatedField<Fulfillment.Types.SetParameterAction> SetParameterActions { get; }Set parameter values before executing the webhook.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldFulfillmentTypesSetParameterAction | |
Tag
public string Tag { get; set; }The value of this field will be populated in the
[WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]
fulfillmentInfo.tag field by Dialogflow when the associated webhook is
called.
The tag is typically used by the webhook service to identify which
fulfillment is being called, but it could be used for other purposes.
This field is required if webhook is specified.
| Property Value | |
|---|---|
| Type | Description |
string | |
Webhook
public string Webhook { get; set; }The webhook to call.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/webhooks/<Webhook ID>.
| Property Value | |
|---|---|
| Type | Description |
string | |
WebhookAsWebhookName
public WebhookName WebhookAsWebhookName { get; set; }WebhookName-typed view over the Webhook resource name property.
| Property Value | |
|---|---|
| Type | Description |
WebhookName | |