class Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment

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

conditional_cases[RW]

Conditional cases for this fulfillment. Corresponds to the JSON property `conditionalCases` @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentConditionalCases>]

messages[RW]

The list of rich message responses to present to the user. Corresponds to the JSON property `messages` @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>]

return_partial_responses[RW]

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. Corresponds to the JSON property `returnPartialResponses` @return [Boolean]

return_partial_responses?[RW]

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. Corresponds to the JSON property `returnPartialResponses` @return [Boolean]

set_parameter_actions[RW]

Set parameter values before executing the webhook. Corresponds to the JSON property `setParameterActions` @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentSetParameterAction>]

tag[RW]

The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. Corresponds to the JSON property `tag` @return [String]

webhook[RW]

The webhook to call. Format: `projects//locations//agents//webhooks/`. Corresponds to the JSON property `webhook` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dialogflow_v3/classes.rb, line 2184
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dialogflow_v3/classes.rb, line 2189
def update!(**args)
  @conditional_cases = args[:conditional_cases] if args.key?(:conditional_cases)
  @messages = args[:messages] if args.key?(:messages)
  @return_partial_responses = args[:return_partial_responses] if args.key?(:return_partial_responses)
  @set_parameter_actions = args[:set_parameter_actions] if args.key?(:set_parameter_actions)
  @tag = args[:tag] if args.key?(:tag)
  @webhook = args[:webhook] if args.key?(:webhook)
end