Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment
- 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
-
#conditional_cases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentConditionalCases>
Conditional cases for this fulfillment.
-
#messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>
The list of rich message responses to present to the user.
-
#return_partial_responses ⇒ Boolean
(also: #return_partial_responses?)
Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs.
-
#set_parameter_actions ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentSetParameterAction>
Set parameter values before executing the webhook.
-
#tag ⇒ String
The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag
field by Dialogflow when the associated webhook is called. -
#webhook ⇒ String
The webhook to call.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Fulfillment
constructor
A new instance of GoogleCloudDialogflowCxV3Fulfillment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Fulfillment
Returns a new instance of GoogleCloudDialogflowCxV3Fulfillment.
2285 2286 2287 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2285 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
2247 2248 2249 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2247 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
2252 2253 2254 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2252 def @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
2263 2264 2265 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2263 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
2269 2270 2271 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2269 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
2278 2279 2280 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2278 def tag @tag end |
#webhook ⇒ String
The webhook to call. Format: projects//locations//agents//webhooks/
.
Corresponds to the JSON property webhook
2283 2284 2285 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2283 def webhook @webhook end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2290 2291 2292 2293 2294 2295 2296 2297 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2290 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 |