Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1WebhookResponse
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1WebhookResponse
- 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 ```or
nullfor empty objects - Use
[]or
null` for empty
arrays For more information, see the Protocol Buffers Language Guide.
Instance Attribute Summary collapse
-
#end_interaction ⇒ Boolean
(also: #end_interaction?)
Optional.
-
#followup_event_input ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1EventInput
Events allow for matching intents by event name instead of the natural language input.
-
#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessage>
Optional.
-
#fulfillment_text ⇒ String
Optional.
-
#live_agent_handoff ⇒ Boolean
(also: #live_agent_handoff?)
Indicates that a live agent should be brought in to handle the interaction with the user.
-
#output_contexts ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1Context>
Optional.
-
#payload ⇒ Hash<String,Object>
Optional.
-
#session_entity_types ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SessionEntityType>
Optional.
-
#source ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1WebhookResponse
constructor
A new instance of GoogleCloudDialogflowV2beta1WebhookResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1WebhookResponse
Returns a new instance of GoogleCloudDialogflowV2beta1WebhookResponse.
17945 17946 17947 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17945 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
17875 17876 17877 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17875 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 parameter
namemay 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`
17884 17885 17886 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17884 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
17891 17892 17893 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17891 def @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
17899 17900 17901 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17899 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
17906 17907 17908 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17906 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
17915 17916 17917 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17915 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
17927 17928 17929 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17927 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
17936 17937 17938 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17936 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
17943 17944 17945 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17943 def source @source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
17950 17951 17952 17953 17954 17955 17956 17957 17958 17959 17960 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 17950 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 |