Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/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) ⇒ GoogleCloudDialogflowCxV3Fulfillment

Returns a new instance of GoogleCloudDialogflowCxV3Fulfillment.



2184
2185
2186
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2184

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

Instance Attribute Details

#conditional_cases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentConditionalCases>

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

Returns:



2149
2150
2151
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2149

def conditional_cases
  @conditional_cases
end

#messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>

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

Returns:



2154
2155
2156
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2154

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) 


2165
2166
2167
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2165

def return_partial_responses
  @return_partial_responses
end

#set_parameter_actions ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentSetParameterAction>

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

Returns:



2171
2172
2173
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2171

def set_parameter_actions
  @set_parameter_actions
end

#tag ⇒ String

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

Returns:

  • (String) 


2177
2178
2179
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2177

def tag
  @tag
end

#webhook ⇒ String

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

Returns:

  • (String) 


2182
2183
2184
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2182

def webhook
  @webhook
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2189
2190
2191
2192
2193
2194
2195
2196
 
# 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