Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1WebhookResponse
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1WebhookResponse
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/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::DialogflowV2::GoogleCloudDialogflowV2beta1EventInput
Events allow for matching intents by event name instead of the natural language input.
-
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessage>
Optional.
-
#fulfillment_text ⇒ String
Optional.
-
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::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
5038 5039 5040 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5038 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
4977 4978 4979 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4977 def end_interaction @end_interaction end |
#followup_event_input ⇒ Google::Apis::DialogflowV2::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
4987 4988 4989 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4987 def followup_event_input @followup_event_input end |
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2::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
4993 4994 4995 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4993 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
4999 5000 5001 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4999 def fulfillment_text @fulfillment_text end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Context>
Optional. The collection of output contexts. This value is passed directly
to QueryResult.output_contexts
.
Corresponds to the JSON property outputContexts
5005 5006 5007 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5005 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
5031 5032 5033 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5031 def payload @payload end |
#source ⇒ String
Optional. This value is passed directly to QueryResult.webhook_source
.
Corresponds to the JSON property source
5036 5037 5038 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5036 def source @source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5043 5044 5045 5046 5047 5048 5049 5050 5051 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5043 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 |