Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2WebhookResponse

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2WebhookResponse

Returns a new instance of GoogleCloudDialogflowV2WebhookResponse



1471
1472
1473
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1471

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

Instance Attribute Details

#followup_event_input ⇒ Google::Apis::DialogflowV2beta1::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

Returns:



1420
1421
1422
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1420

def followup_event_input
  @followup_event_input
end

#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2beta1::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

Returns:



1426
1427
1428
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1426

def fulfillment_messages
  @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

Returns:

  • (String) 


1432
1433
1434
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1432

def fulfillment_text
  @fulfillment_text
end

#output_contexts ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2Context>

Optional. The collection of output contexts. This value is passed directly to QueryResult.output_contexts. Corresponds to the JSON property outputContexts

Returns:



1438
1439
1440
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1438

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

Returns:

  • (Hash<String,Object>) 


1464
1465
1466
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1464

def payload
  @payload
end

#source ⇒ String

Optional. This value is passed directly to QueryResult.webhook_source. Corresponds to the JSON property source

Returns:

  • (String) 


1469
1470
1471
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1469

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1476

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)
  @source = args[:source] if args.key?(:source)
end