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.



15918
15919
15920
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15918

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:



15865
15866
15867
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15865

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:



15872
15873
15874
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15872

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) 


15880
15881
15882
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15880

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:



15888
15889
15890
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15888

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


15900
15901
15902
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15900

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:



15909
15910
15911
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15909

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) 


15916
15917
15918
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15916

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15923
15924
15925
15926
15927
15928
15929
15930
15931
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15923

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