Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Fulfillment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Fulfillment

Returns a new instance of GoogleCloudDialogflowCxV3beta1Fulfillment.



5675
5676
5677
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5675

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#conditional_cases ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases>

Conditional cases for this fulfillment. Corresponds to the JSON property conditionalCases

Returns:



5637
5638
5639
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5637

def conditional_cases
  @conditional_cases
end

#messages ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage>

The list of rich message responses to present to the user. Corresponds to the JSON property messages

Returns:



5642
5643
5644
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5642

def messages
  @messages
end

#return_partial_responses ⇒ Boolean Also known as: return_partial_responses?

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

Returns:

  • (Boolean) 


5653
5654
5655
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5653

def return_partial_responses
  @return_partial_responses
end

#set_parameter_actions ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction>

Set parameter values before executing the webhook. Corresponds to the JSON property setParameterActions

Returns:



5659
5660
5661
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5659

def set_parameter_actions
  @set_parameter_actions
end

#tag ⇒ String

The value of this field will be populated in the 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. Corresponds to the JSON property tag

Returns:

  • (String) 


5668
5669
5670
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5668

def tag
  @tag
end

#webhook ⇒ String

The webhook to call. Format: projects//locations//agents//webhooks/. Corresponds to the JSON property webhook

Returns:

  • (String) 


5673
5674
5675
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5673

def webhook
  @webhook
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5680
5681
5682
5683
5684
5685
5686
5687
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5680

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