DialogflowResponse

A Dialogflow response.

JSON representation 
{
  "queryText": string,
  "faqResponse": {
    object (FaqResponse)
  },
  "intentResponses": [
    {
      object (IntentResponse)
    }
  ],
  "autoResponded": boolean,
  "autoRespondedMessages": [
    {
      object (AutoRespondedMessage)
    }
  ]
}
Fields
queryText

string

The original conversational query text. If automatic spelling correction is enabled for the Dialogflow model, queryText contains the corrected user input.
faqResponse

object (FaqResponse)

An FAQ response from Dialogflow.
intentResponses[]

object (IntentResponse)

List of intent responses from Dialogflow.
autoResponded

boolean

A boolean indicating if Business Messages automatically responded to the user.
autoRespondedMessages[]

object (AutoRespondedMessage)

Auto-responded message.

FaqResponse

An FAQ response from Dialogflow.

If the FAQ integration is enabled, this includes responses received from all available knowledge documents.

JSON representation 
{
  "userQuestion": string,
  "answers": [
    {
      object (Answer)
    }
  ]
}
Fields
userQuestion
(deprecated)

string

The user's question, retrieved from a message.
answers[]

object (Answer)

3 or fewer responses selected from knowledge bases by Dialogflow.

IntentResponse

An intent response from Dialogflow.

If the FAQ integration is enabled, this includes responses received from all available custom intents.

JSON representation 
{
  "intentName": string,
  "intentDisplayName": string,
  "intentDetectionConfidence": number,
  "fulfillmentMessages": [
    {
      object (FulfillmentMessage)
    }
  ]
}
Fields
intentName

string

The unique identifier of the matched intent.
intentDisplayName

string

The name of the matched intent.
intentDetectionConfidence

number

The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold.
fulfillmentMessages[]

object (FulfillmentMessage)

The collection of messages to send to the user. If the fulfillment message formats are not supported by Business Messages, a fallback message would be sent to the user.

FulfillmentMessage

The content of a fulfillment message.

JSON representation 
{
  "error": {
    object (Status)
  },

  // Union field message can be only one of the following:
  "text": string,
  "jsonPayload": string,
  "liveAgentHandoff": {
    object (LiveAgentHandOff)
  }
  // End of list of possible types for union field message.
}
Fields
error

object (Status)

Error result describing issues with the fulfillment message.
Union field message. Required. The response message from a custom intent. message can be only one of the following:
text

string

A text response.
jsonPayload

string

A custom payload response.

This string matches the custom payload you defined for an intent response in Dialogflow. If the payload does not have a valid Business Messages JSON object structure, the error field provides details.
liveAgentHandoff

object (LiveAgentHandOff)

A live agent handoff response.

LiveAgentHandOff

Live Agent Handoff.

JSON representation 
{
  "metadata": {
    object
  }
}
Fields
metadata

object (Struct format)

Custom data passed to the agent with the live agent handoff request. This is a JSON payload.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

JSON representation 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Fields
code

integer

The status code, which should be an enum value of google.rpc.Code.
message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.