Class: Google::Cloud::Dialogflow::V2::WebhookResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/webhook.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 null for empty objects
  • Use [] or null for empty arrays

For more information, see the Protocol Buffers Language Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#followup_event_input ⇒ ::Google::Cloud::Dialogflow::V2::EventInput

Returns Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

Returns:



117
118
119
120
 
# File 'proto_docs/google/cloud/dialogflow/v2/webhook.rb', line 117

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#fulfillment_messages ⇒ ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>

Returns 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.

Returns:



117
118
119
120
 
# File 'proto_docs/google/cloud/dialogflow/v2/webhook.rb', line 117

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#fulfillment_text ⇒ ::String

Returns 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.

Returns:

  • (::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.



117
118
119
120
 
# File 'proto_docs/google/cloud/dialogflow/v2/webhook.rb', line 117

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#output_contexts ⇒ ::Array<::Google::Cloud::Dialogflow::V2::Context>

Returns 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.

Returns:



117
118
119
120
 
# File 'proto_docs/google/cloud/dialogflow/v2/webhook.rb', line 117

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#payload ⇒ ::Google::Protobuf::Struct

Returns 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.

Returns:



117
118
119
120
 
# File 'proto_docs/google/cloud/dialogflow/v2/webhook.rb', line 117

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#session_entity_types ⇒ ::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>) —

    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.



117
118
119
120
 
# File 'proto_docs/google/cloud/dialogflow/v2/webhook.rb', line 117

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#source ⇒ ::String

Returns 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.

Returns:

  • (::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.



117
118
119
120
 
# File 'proto_docs/google/cloud/dialogflow/v2/webhook.rb', line 117

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end