Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2WebhookResponse

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

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



2652
2653
2654
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2652

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

Returns:



2592
2593
2594
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2592

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

Returns:



2598
2599
2600
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2598

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) 


2604
2605
2606
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2604

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

Returns:



2610
2611
2612
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2610

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>) 


2636
2637
2638
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2636

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

Returns:



2645
2646
2647
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2645

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

Returns:

  • (String) 


2650
2651
2652
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2650

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2657
2658
2659
2660
2661
2662
2663
2664
2665
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2657

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