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



3850
3851
3852
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3850

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

Instance Attribute Details

#followup_event_inputGoogle::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



3799
3800
3801
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3799

def followup_event_input
  @followup_event_input
end

#fulfillment_messagesArray<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



3805
3806
3807
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3805

def fulfillment_messages
  @fulfillment_messages
end

#fulfillment_textString

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)


3811
3812
3813
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3811

def fulfillment_text
  @fulfillment_text
end

#output_contextsArray<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



3817
3818
3819
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3817

def output_contexts
  @output_contexts
end

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


3843
3844
3845
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3843

def payload
  @payload
end

#sourceString

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

Returns:

  • (String)


3848
3849
3850
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3848

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3855
3856
3857
3858
3859
3860
3861
3862
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3855

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