Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV2WebhookResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/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 ```ornullfor empty objects - Use[]ornull` for empty arrays For more information, see the Protocol Buffers Language Guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2WebhookResponse

Returns a new instance of GoogleCloudDialogflowV2WebhookResponse.



12564
12565
12566
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12564

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

Instance Attribute Details

#followup_event_input ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2EventInput

Events allow for matching intents by event name instead of the natural language input. For instance, input `can trigger a personalized welcome response. The parameternamemay be used by the agent in the response:" Hello #welcome_event.name! What can I do for you today?". Corresponds to the JSON propertyfollowupEventInput`

Returns:



12511
12512
12513
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12511

def followup_event_input
  @followup_event_input
end

#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessage>

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller. Corresponds to the JSON property fulfillmentMessages

Returns:



12518
12519
12520
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12518

def fulfillment_messages
  @fulfillment_messages
end

#fulfillment_text ⇒ String

Optional. The text response message intended for the end-user. It is recommended to use fulfillment_messages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller. Corresponds to the JSON property fulfillmentText

Returns:

  • (String) 


12526
12527
12528
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12526

def fulfillment_text
  @fulfillment_text
end

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

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller. Corresponds to the JSON property outputContexts

Returns:



12534
12535
12536
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12534

def output_contexts
  @output_contexts
end

#payload ⇒ Hash<String,Object>

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format Corresponds to the JSON property payload

Returns:

  • (Hash<String,Object>) 


12546
12547
12548
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12546

def payload
  @payload
end

#session_entity_types ⇒ Array<Google::Apis::DialogflowV3::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. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods. Corresponds to the JSON property sessionEntityTypes

Returns:



12555
12556
12557
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12555

def session_entity_types
  @session_entity_types
end

#source ⇒ String

Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller. Corresponds to the JSON property source

Returns:

  • (String) 


12562
12563
12564
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12562

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12569
12570
12571
12572
12573
12574
12575
12576
12577
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12569

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