Class Google::Cloud::Dialogflow::V2::WebhookResponse (v0.13.0)

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#followup_event_input

def followup_event_input() -> ::Google::Cloud::Dialogflow::V2::EventInput
Returns

#followup_event_input=

def followup_event_input=(value) -> ::Google::Cloud::Dialogflow::V2::EventInput
Parameter
Returns

#fulfillment_messages

def fulfillment_messages() -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>
Returns

#fulfillment_messages=

def fulfillment_messages=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>
Parameter
Returns

#fulfillment_text

def fulfillment_text() -> ::String
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.

#fulfillment_text=

def fulfillment_text=(value) -> ::String
Parameter
  • value (::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.
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.

#output_contexts

def output_contexts() -> ::Array<::Google::Cloud::Dialogflow::V2::Context>
Returns

#output_contexts=

def output_contexts=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Context>
Parameter
Returns

#payload

def payload() -> ::Google::Protobuf::Struct
Returns

#payload=

def payload=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#session_entity_types

def session_entity_types() -> ::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>
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.

#session_entity_types=

def session_entity_types=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>
Parameter
  • value (::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.
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.

#source

def source() -> ::String
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.

#source=

def source=(value) -> ::String
Parameter
  • value (::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.
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.