Class Match.Builder (0.39.0) 

public static final class Match.Builder extends GeneratedMessageV3.Builder<Match.Builder> implements MatchOrBuilder

Represents one match result of [MatchIntent][].

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

Inheritance

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

Implements

MatchOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Match.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Match.Builder
Overrides

build()

public Match build()
Returns
Type Description
Match

buildPartial()

public Match buildPartial()
Returns
Type Description
Match

clear()

public Match.Builder clear()
Returns
Type Description
Match.Builder
Overrides

clearConfidence()

public Match.Builder clearConfidence()

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
Match.Builder

This builder for chaining.

clearEvent()

public Match.Builder clearEvent()

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

string event = 6;

Returns
Type Description
Match.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Match.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Match.Builder
Overrides

clearIntent()

public Match.Builder clearIntent()

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
Match.Builder

clearMatchType()

public Match.Builder clearMatchType()

Type of this Match.

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

Returns
Type Description
Match.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Match.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Match.Builder
Overrides

clearParameters()

public Match.Builder clearParameters()

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
Match.Builder

clearResolvedInput()

public Match.Builder clearResolvedInput()

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
Match.Builder

This builder for chaining.

clone()

public Match.Builder clone()
Returns
Type Description
Match.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getIntentBuilder()

public Intent.Builder getIntentBuilder()

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

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.

getParametersBuilder()

public Struct.Builder getParametersBuilder()

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
Builder

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Match other)

public Match.Builder mergeFrom(Match other)
Parameter
Name Description
other Match
Returns
Type Description
Match.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Match.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Match.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Match.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Match.Builder
Overrides

mergeIntent(Intent value)

public Match.Builder mergeIntent(Intent value)

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;

Parameter
Name Description
value Intent
Returns
Type Description
Match.Builder

mergeParameters(Struct value)

public Match.Builder mergeParameters(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
Match.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Match.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Match.Builder
Overrides

setConfidence(float value)

public Match.Builder setConfidence(float value)

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;

Parameter
Name Description
value float

The confidence to set.
Returns
Type Description
Match.Builder

This builder for chaining.

setEvent(String value)

public Match.Builder setEvent(String value)

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

string event = 6;

Parameter
Name Description
value String

The event to set.
Returns
Type Description
Match.Builder

This builder for chaining.

setEventBytes(ByteString value)

public Match.Builder setEventBytes(ByteString value)

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

string event = 6;

Parameter
Name Description
value ByteString

The bytes for event to set.
Returns
Type Description
Match.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Match.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Match.Builder
Overrides

setIntent(Intent value)

public Match.Builder setIntent(Intent value)

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;

Parameter
Name Description
value Intent
Returns
Type Description
Match.Builder

setIntent(Intent.Builder builderForValue)

public Match.Builder setIntent(Intent.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Intent.Builder
Returns
Type Description
Match.Builder

setMatchType(Match.MatchType value)

public Match.Builder setMatchType(Match.MatchType value)

Type of this Match.

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

Parameter
Name Description
value Match.MatchType

The matchType to set.
Returns
Type Description
Match.Builder

This builder for chaining.

setMatchTypeValue(int value)

public Match.Builder setMatchTypeValue(int value)

Type of this Match.

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

Parameter
Name Description
value int

The enum numeric value on the wire for matchType to set.
Returns
Type Description
Match.Builder

This builder for chaining.

setParameters(Struct value)

public Match.Builder setParameters(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
Match.Builder

setParameters(Struct.Builder builderForValue)

public Match.Builder setParameters(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Match.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Match.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Match.Builder
Overrides

setResolvedInput(String value)

public Match.Builder setResolvedInput(String value)

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;

Parameter
Name Description
value String

The resolvedInput to set.
Returns
Type Description
Match.Builder

This builder for chaining.

setResolvedInputBytes(ByteString value)

public Match.Builder setResolvedInputBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for resolvedInput to set.
Returns
Type Description
Match.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Match.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Match.Builder
Overrides