Struct google_api_proto::google::cloud::dialogflow::cx::v3::Fulfillment

pub struct Fulfillment {
    pub messages: Vec<ResponseMessage>,
    pub webhook: String,
    pub return_partial_responses: bool,
    pub tag: String,
    pub set_parameter_actions: Vec<SetParameterAction>,
    pub conditional_cases: Vec<ConditionalCases>,
    pub advanced_settings: Option<AdvancedSettings>,
    pub enable_generative_fallback: bool,
}

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.

Fields

messages: Vec<ResponseMessage>

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

webhook: String

The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

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: String

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.

set_parameter_actions: Vec<SetParameterAction>

Set parameter values before executing the webhook.

conditional_cases: Vec<ConditionalCases>

Conditional cases for this fulfillment.

advanced_settings: Option<AdvancedSettings>

Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.

enable_generative_fallback: bool

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.

Trait Implementations

impl Clone for Fulfillment

fn clone(&self) -> Fulfillment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Fulfillment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Fulfillment

fn default() -> Self

Returns the “default value” for a type.

impl Message for Fulfillment

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Fulfillment

fn eq(&self, other: &Fulfillment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Fulfillment