Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2WebhookResponse
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2WebhookResponse
- 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. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:
- Use
""
for empty strings - Use ```
or
null` for empty objects - Use
[]
ornull
for empty arrays For more information, see the Protocol Buffers Language Guide.
Instance Attribute Summary collapse
-
#followup_event_input ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput
Events allow for matching intents by event name instead of the natural language input.
-
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessage>
Optional.
-
#fulfillment_text ⇒ String
Optional.
-
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context>
Optional.
-
#payload ⇒ Hash<String,Object>
Optional.
-
#session_entity_types ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType>
Optional.
-
#source ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2WebhookResponse
constructor
A new instance of GoogleCloudDialogflowV2WebhookResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2WebhookResponse
Returns a new instance of GoogleCloudDialogflowV2WebhookResponse.
3646 3647 3648 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3646 def initialize(**args) update!(**args) end |
Instance Attribute Details
#followup_event_input ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput
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
3586 3587 3588 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3586 def followup_event_input @followup_event_input end |
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessage>
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
3592 3593 3594 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3592 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
3598 3599 3600 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3598 def fulfillment_text @fulfillment_text end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context>
Optional. The collection of output contexts. This value is passed directly
to QueryResult.output_contexts
.
Corresponds to the JSON property outputContexts
3604 3605 3606 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3604 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
3630 3631 3632 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3630 def payload @payload end |
#session_entity_types ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType>
Optional. Additional session entity types to replace or extend developer
entity types with. The entity synonyms apply to all languages and persist
for the session of this query. Setting the session entity types inside
webhook overwrites the session entity types that have been set through
DetectIntentRequest.query_params.session_entity_types
.
Corresponds to the JSON property sessionEntityTypes
3639 3640 3641 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3639 def session_entity_types @session_entity_types end |
#source ⇒ String
Optional. This value is passed directly to QueryResult.webhook_source
.
Corresponds to the JSON property source
3644 3645 3646 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3644 def source @source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3651 3652 3653 3654 3655 3656 3657 3658 3659 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3651 def update!(**args) @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) @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) @source = args[:source] if args.key?(:source) end |