google_api_dialogflow v0.31.0 GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2WebhookResponse View Source

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.

Attributes

  • followupEventInput (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EventInput.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.GoogleCloudDialogflowV2IntentMessage.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.GoogleCloudDialogflowV2Context.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"
          }
        }
      ]
    }

    } }

  • sessionEntityTypes (type: list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t), default: nil) - 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 of this query. Setting the session entity types inside webhook overwrites the session entity types that have been set through DetectIntentRequest.query_params.session_entity_types.

  • 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.GoogleCloudDialogflowV2WebhookResponse{
  followupEventInput:
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EventInput.t(),
  fulfillmentMessages: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentMessage.t()
  ],
  fulfillmentText: String.t(),
  outputContexts: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()
  ],
  payload: map(),
  sessionEntityTypes: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()
  ],
  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.