Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1WebhookResponse
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1WebhookResponse
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2beta1/classes.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb
Overview
The response message for a webhook call.
Instance Attribute Summary collapse
-
#end_interaction ⇒ Boolean
(also: #end_interaction?)
Optional.
-
#followup_event_input ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EventInput
Events allow for matching intents by event name instead of the natural language input.
-
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessage>
Optional.
-
#fulfillment_text ⇒ String
Optional.
-
#output_contexts ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context>
Optional.
-
#payload ⇒ Hash<String,Object>
Optional.
-
#source ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1WebhookResponse
constructor
A new instance of GoogleCloudDialogflowV2beta1WebhookResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1WebhookResponse
Returns a new instance of GoogleCloudDialogflowV2beta1WebhookResponse
5308 5309 5310 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5308 def initialize(**args) update!(**args) end |
Instance Attribute Details
#end_interaction ⇒ Boolean Also known as: end_interaction?
Optional. Indicates that this intent ends an interaction. Some integrations
(e.g., Actions on Google or Dialogflow phone gateway) use this information
to close interaction with an end user. Default is false.
Corresponds to the JSON property endInteraction
5247 5248 5249 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5247 def end_interaction @end_interaction end |
#followup_event_input ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EventInput
Events allow for matching intents by event name instead of the natural
language input. For instance, input <event:
name: "welcome_event",
parameters: name: "Sam"
>
can trigger a personalized welcome response.
The parameter name
may be used by the agent in the response:
"Hello #welcome_event.name! What can I do for you today?"
.
Corresponds to the JSON property followupEventInput
5257 5258 5259 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5257 def followup_event_input @followup_event_input end |
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessage>
Optional. The collection of rich messages to present to the user. This
value is passed directly to QueryResult.fulfillment_messages
.
Corresponds to the JSON property fulfillmentMessages
5263 5264 5265 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5263 def @fulfillment_messages end |
#fulfillment_text ⇒ String
Optional. The text to be shown on the screen. This value is passed directly
to QueryResult.fulfillment_text
.
Corresponds to the JSON property fulfillmentText
5269 5270 5271 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5269 def fulfillment_text @fulfillment_text end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context>
Optional. The collection of output contexts. This value is passed directly
to QueryResult.output_contexts
.
Corresponds to the JSON property outputContexts
5275 5276 5277 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5275 def output_contexts @output_contexts end |
#payload ⇒ Hash<String,Object>
Optional. This value is passed directly to QueryResult.webhook_payload
.
See the related fulfillment_messages[i].payload field
, which may be used
as an alternative to this field.
This field can be used for Actions on Google responses.
It should have a structure similar to the JSON message shown here. For more
information, see
Actions on Google Webhook
Format
`
"google": `
"expectUserResponse": true,
"richResponse": `
"items": [
`
"simpleResponse": `
"textToSpeech": "this is a simple response"
`
`
]
`
`
`
Corresponds to the JSON property payload
5301 5302 5303 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5301 def payload @payload end |
#source ⇒ String
Optional. This value is passed directly to QueryResult.webhook_source
.
Corresponds to the JSON property source
5306 5307 5308 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5306 def source @source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5313 5314 5315 5316 5317 5318 5319 5320 5321 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5313 def update!(**args) @end_interaction = args[:end_interaction] if args.key?(:end_interaction) @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input) @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @payload = args[:payload] if args.key?(:payload) @source = args[:source] if args.key?(:source) end |