Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1WebhookResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v3beta1/classes.rb,
generated/google/apis/dialogflow_v3beta1/representations.rb,
generated/google/apis/dialogflow_v3beta1/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.



11430
11431
11432
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11430

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

Instance Attribute Details

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


11368
11369
11370
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11368

def end_interaction
  @end_interaction
end

#followup_event_inputGoogle::Apis::DialogflowV3beta1::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`



11377
11378
11379
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11377

def followup_event_input
  @followup_event_input
end

#fulfillment_messagesArray<Google::Apis::DialogflowV3beta1::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



11384
11385
11386
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11384

def fulfillment_messages
  @fulfillment_messages
end

#fulfillment_textString

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)


11392
11393
11394
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11392

def fulfillment_text
  @fulfillment_text
end

#output_contextsArray<Google::Apis::DialogflowV3beta1::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



11400
11401
11402
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11400

def output_contexts
  @output_contexts
end

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


11412
11413
11414
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11412

def payload
  @payload
end

#session_entity_typesArray<Google::Apis::DialogflowV3beta1::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



11421
11422
11423
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11421

def session_entity_types
  @session_entity_types
end

#sourceString

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)


11428
11429
11430
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11428

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 11435

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