Interface MatchOrBuilder (0.15.0) 

public interface MatchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConfidence()

public abstract float getConfidence()

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.

float confidence = 5;

Returns
Type Description
float

The confidence.

getEvent()

public abstract String getEvent()

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

string event = 6;

Returns
Type Description
String

The event.

getEventBytes()

public abstract ByteString getEventBytes()

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

string event = 6;

Returns
Type Description
ByteString

The bytes for event.

getIntent()

public abstract Intent getIntent()

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

.google.cloud.dialogflow.cx.v3beta1.Intent intent = 1;

Returns
Type Description
Intent

The intent.

getIntentOrBuilder()

public abstract IntentOrBuilder getIntentOrBuilder()

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

.google.cloud.dialogflow.cx.v3beta1.Intent intent = 1;

Returns
Type Description
IntentOrBuilder

getMatchType()

public abstract Match.MatchType getMatchType()

Type of this Match.

.google.cloud.dialogflow.cx.v3beta1.Match.MatchType match_type = 4;

Returns
Type Description
Match.MatchType

The matchType.

getMatchTypeValue()

public abstract int getMatchTypeValue()

Type of this Match.

.google.cloud.dialogflow.cx.v3beta1.Match.MatchType match_type = 4;

Returns
Type Description
int

The enum numeric value on the wire for matchType.

getParameters()

public abstract Struct getParameters()

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.

.google.protobuf.Struct parameters = 2;

Returns
Type Description
Struct

The parameters.

getParametersOrBuilder()

public abstract StructOrBuilder getParametersOrBuilder()

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.

.google.protobuf.Struct parameters = 2;

Returns
Type Description
StructOrBuilder

getResolvedInput()

public abstract String getResolvedInput()

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.

string resolved_input = 3;

Returns
Type Description
String

The resolvedInput.

getResolvedInputBytes()

public abstract ByteString getResolvedInputBytes()

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.

string resolved_input = 3;

Returns
Type Description
ByteString

The bytes for resolvedInput.

hasIntent()

public abstract boolean hasIntent()

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

.google.cloud.dialogflow.cx.v3beta1.Intent intent = 1;

Returns
Type Description
boolean

Whether the intent field is set.

hasParameters()

public abstract boolean hasParameters()

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.

.google.protobuf.Struct parameters = 2;

Returns
Type Description
boolean

Whether the parameters field is set.