Class Match (0.19.0) 

public final class Match extends GeneratedMessageV3 implements MatchOrBuilder

Represents one match result of [MatchIntent][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.Match

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Match

Implements

MatchOrBuilder

Static Fields

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER
Field Value
Type Description
int

INTENT_FIELD_NUMBER

public static final int INTENT_FIELD_NUMBER
Field Value
Type Description
int

MATCH_TYPE_FIELD_NUMBER

public static final int MATCH_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

RESOLVED_INPUT_FIELD_NUMBER

public static final int RESOLVED_INPUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Match getDefaultInstance()
Returns
Type Description
Match

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Match.Builder newBuilder()
Returns
Type Description
Match.Builder

newBuilder(Match prototype)

public static Match.Builder newBuilder(Match prototype)
Parameter
Name Description
prototype Match
Returns
Type Description
Match.Builder

parseDelimitedFrom(InputStream input)

public static Match parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Match
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Match parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Match
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Match parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Match
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Match parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Match
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Match parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Match
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Match parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Match
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Match parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Match
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Match parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Match
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Match parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Match
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Match parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Match
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Match parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Match
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Match parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Match
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Match> parser()
Returns
Type Description
Parser<Match>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfidence()

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

getDefaultInstanceForType()

public Match getDefaultInstanceForType()
Returns
Type Description
Match

getEvent()

public 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 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 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 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 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 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 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 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

getParserForType()

public Parser<Match> getParserForType()
Returns
Type Description
Parser<Match>
Overrides

getResolvedInput()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasIntent()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Match.Builder newBuilderForType()
Returns
Type Description
Match.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Match.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Match.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Match.Builder toBuilder()
Returns
Type Description
Match.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException