public final class Match extends GeneratedMessageV3 implements MatchOrBuilder
Represents one match result of [MatchIntent][].
Protobuf type google.cloud.dialogflow.cx.v3.Match
Static Fields
CONFIDENCE_FIELD_NUMBER
public static final int CONFIDENCE_FIELD_NUMBER
Field Value
EVENT_FIELD_NUMBER
public static final int EVENT_FIELD_NUMBER
Field Value
INTENT_FIELD_NUMBER
public static final int INTENT_FIELD_NUMBER
Field Value
MATCH_TYPE_FIELD_NUMBER
public static final int MATCH_TYPE_FIELD_NUMBER
Field Value
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value
public static final int RESOLVED_INPUT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Match getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Match.Builder newBuilder()
Returns
newBuilder(Match prototype)
public static Match.Builder newBuilder(Match prototype)
Parameter
Name |
Description |
prototype |
Match
|
Returns
public static Match parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Match parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Match parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Match parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Match parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Match parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Match parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Match parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Match parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Match parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Match parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Match parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Match> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
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.v3.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.v3.Intent intent = 1;
Returns
getMatchType()
public Match.MatchType getMatchType()
Type of this Match.
.google.cloud.dialogflow.cx.v3.Match.MatchType match_type = 4;
Returns
getMatchTypeValue()
public int getMatchTypeValue()
Type of this Match.
.google.cloud.dialogflow.cx.v3.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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: 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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 2;
Returns
getParserForType()
public Parser<Match> getParserForType()
Returns
Overrides
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.
|
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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.v3.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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 2;
Returns
Type |
Description |
boolean |
Whether the parameters field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Match.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Match.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Match.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions