Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1WebhookResponse

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

Returns a new instance of GoogleCloudDialogflowV2beta1WebhookResponse.



19784
19785
19786
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19784

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) 


19714
19715
19716
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19714

def end_interaction
  @end_interaction
end

#followup_event_input ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1EventInput

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:



19723
19724
19725
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19723

def followup_event_input
  @followup_event_input
end

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

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:



19730
19731
19732
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19730

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) 


19738
19739
19740
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19738

def fulfillment_text
  @fulfillment_text
end

#live_agent_handoff ⇒ Boolean Also known as: live_agent_handoff?

Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false. Corresponds to the JSON property liveAgentHandoff

Returns:

  • (Boolean) 


19745
19746
19747
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19745

def live_agent_handoff
  @live_agent_handoff
end

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

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:



19754
19755
19756
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19754

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


19766
19767
19768
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19766

def payload
  @payload
end

#session_entity_types ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SessionEntityType>

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:



19775
19776
19777
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19775

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) 


19782
19783
19784
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19782

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 19789

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)
  @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
  @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