google_api_dialogflow v0.7.0 GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1WebhookResponse View Source

The response message for a webhook call.

Attributes

  • endInteraction (type: boolean(), default: nil) - 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.

  • followupEventInput (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1EventInput.t, default: nil) - Optional. Makes the platform immediately invoke another DetectIntent call internally with the specified event as input. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

  • fulfillmentMessages (type: list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1IntentMessage.t), default: nil) - Optional. The collection of rich messages to present to the user. This value is passed directly to QueryResult.fulfillment_messages.

  • fulfillmentText (type: String.t, default: nil) - Optional. The text to be shown on the screen. This value is passed directly to QueryResult.fulfillment_text.

  • outputContexts (type: list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Context.t), default: nil) - Optional. The collection of output contexts. This value is passed directly to QueryResult.output_contexts.

  • payload (type: map(), default: nil) - Optional. This value is passed directly to QueryResult.webhook_payload. See the related fulfillment_messages[i].payload field, which may be used as an alternative to this field.

    This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see Actions on Google Webhook Format

    {
      "google": {

    "expectUserResponse": true,
    "richResponse": {
      "items": [
        {
          "simpleResponse": {
            "textToSpeech": "this is a simple response"
          }
        }
      ]
    }

    } }

  • source (type: String.t, default: nil) - Optional. This value is passed directly to QueryResult.webhook_source.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() ::
  %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1WebhookResponse{
    endInteraction: boolean(),
    followupEventInput:
      GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1EventInput.t(),
    fulfillmentMessages: [
      GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1IntentMessage.t()
    ],
    fulfillmentText: String.t(),
    outputContexts: [
      GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2beta1Context.t()
    ],
    payload: map(),
    source: String.t()
  }

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.