QueryResult

Represents the result of a conversational query.

JSON representation
{
  "languageCode": string,
  "parameters": {
    object
  },
  "responseMessages": [
    {
      object (ResponseMessage)
    }
  ],
  "webhookStatuses": [
    {
      object (Status)
    }
  ],
  "webhookPayloads": [
    {
      object
    }
  ],
  "currentPage": {
    object (Page)
  },
  "intent": {
    object (Intent)
  },
  "intentDetectionConfidence": number,
  "match": {
    object (Match)
  },
  "diagnosticInfo": {
    object
  },
  "sentimentAnalysisResult": {
    object (SentimentAnalysisResult)
  },

  // Union field query can be only one of the following:
  "text": string,
  "triggerIntent": string,
  "transcript": string,
  "triggerEvent": string,
  "dtmf": {
    object (DtmfInput)
  }
  // End of list of possible types for union field query.
}
Fields
languageCode

string

The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

parameters

object (Struct format)

The collected session parameters.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
responseMessages[]

object (ResponseMessage)

The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic.

webhookStatuses[]

object (Status)

The list of webhook call status in the order of call sequence.

webhookPayloads[]

object (Struct format)

The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty Struct would be used instead.

currentPage

object (Page)

The current Page. Some, not all fields are filled in this message, including but not limited to name and displayName.

intent
(deprecated)

object (Intent)

The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name and displayName. This field is deprecated, please use QueryResult.match instead.

intentDetectionConfidence
(deprecated)

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. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead.

match

object (Match)

Intent match result, could be an intent or an event.

diagnosticInfo

object (Struct format)

The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure.

One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results:

  • The list is empty if no intent was matched to end-user input.
  • Only intents that are referenced in the currently active flow are included.
  • The matched intent is included.
  • Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.
  • Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.
sentimentAnalysisResult

object (SentimentAnalysisResult)

The sentiment analyss result, which depends on analyzeQueryTextSentiment, specified in the request.

Union field query. The original conversational query. query can be only one of the following:
text

string

If natural language text was provided as input, this field will contain a copy of the text.

triggerIntent

string

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

transcript

string

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

triggerEvent

string

If an event was provided as input, this field will contain the name of the event.

dtmf

object (DtmfInput)

If a [DTMF][DTMFInput] was provided as input, this field will contain a copy of the [DTMFInput][].

SentimentAnalysisResult

The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.

JSON representation
{
  "score": number,
  "magnitude": number
}
Fields
score

number

Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

magnitude

number

A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).