Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1WebhookResponse

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

Returns a new instance of GoogleCloudDialogflowV2beta1WebhookResponse



4147
4148
4149
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4147

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

Returns:

  • (Boolean) 


4086
4087
4088
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4086

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

Returns:



4096
4097
4098
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4096

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

Returns:



4102
4103
4104
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4102

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) 


4108
4109
4110
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4108

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

Returns:



4114
4115
4116
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4114

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


4140
4141
4142
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4140

def payload
  @payload
end

#source ⇒ String

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

Returns:

  • (String) 


4145
4146
4147
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4145

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4152
4153
4154
4155
4156
4157
4158
4159
4160
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4152

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