Match

Represents one match result of [MatchIntent][].

JSON representation 
{
  "intent": {
    object (Intent)
  },
  "event": string,
  "parameters": {
    object
  },
  "resolvedInput": string,
  "matchType": enum (MatchType),
  "confidence": number
}
Fields
intent

object (Intent)

The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: name and displayName. Only filled for INTENT match type.
event

string

The event that matched the query. Filled for EVENT, NO_MATCH and NO_INPUT match types.
parameters

object (Struct format)

The collection of parameters extracted from the query.

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.
resolvedInput

string

Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.
matchType

enum (MatchType)

Type of this Match.
confidence

number

The confidence of this match. 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.

MatchType

Type of a Match.

Enums
MATCH_TYPE_UNSPECIFIED Not specified. Should never be used.
INTENT The query was matched to an intent.
DIRECT_INTENT The query directly triggered an intent.
PARAMETER_FILLING The query was used for parameter filling.
NO_MATCH No match was found for the query.
NO_INPUT Indicates an empty query.
EVENT The query directly triggered an event.
KNOWLEDGE_CONNECTOR The query was matched to a Knowledge Connector answer.
PLAYBOOK The query was handled by a [Playbook][Playbook].