# Dialogflow v3 API - Class Fulfillment (3.1.0)

3.1.0 (latest) 3.0.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0

    public sealed class Fulfillment : IMessage<Fulfillment>, IEquatable<Fulfillment>, IDeepCloneable<Fulfillment>, IBufferMessage, IMessage

Reference 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.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> Fulfillment

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Fulfillment](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Fulfillment](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Fulfillment](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Dialogflow.Cx.V3](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3)

## Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

## Constructors

### Fulfillment()

    public Fulfillment()

### Fulfillment(Fulfillment)

    public Fulfillment(Fulfillment other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.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** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.AdvancedSettings` |   |

### ConditionalCases

    public RepeatedField<Fulfillment.Types.ConditionalCases> ConditionalCases { get; }

Conditional cases for this fulfillment.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillmenthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment.Types.ConditionalCases` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### Generators

    public RepeatedField<Fulfillment.Types.GeneratorSettings> Generators { get; }

A list of Generators to be called during this fulfillment.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillmenthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment.Types.GeneratorSettings` |   |

### Messages

    public RepeatedField<ResponseMessage> Messages { get; }

The list of rich message responses to present to the user.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.ResponseMessage` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### SetParameterActions

    public RepeatedField<Fulfillment.Types.SetParameterAction> SetParameterActions { get; }

Set parameter values before executing the webhook.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillmenthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment.Types.SetParameterAction` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Webhook

    public string Webhook { get; set; }

The webhook to call.
Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### WebhookAsWebhookName

    public WebhookName WebhookAsWebhookName { get; set; }

[WebhookName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.WebhookName)-typed view over the [Webhook](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.Fulfillment#Google_Cloud_Dialogflow_Cx_V3_Fulfillment_Webhook) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dialogflow.Cx.V3/latest/Google.Cloud.Dialogflow.Cx.V3.WebhookName` |   |