Package com.google.cloud.dialogflow.cx.v3

Interface MatchOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Match, Match.Builder
    public interface MatchOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      float getConfidence()
      The confidence of this match.
      String getEvent()
      The event that matched the query.
      com.google.protobuf.ByteString getEventBytes()
      The event that matched the query.
      Intent getIntent()
      The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the query.
      IntentOrBuilder getIntentOrBuilder()
      The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the query.
      Match.MatchType getMatchType()
      Type of this [Match][google.cloud.dialogflow.cx.v3.Match].
      int getMatchTypeValue()
      Type of this [Match][google.cloud.dialogflow.cx.v3.Match].
      com.google.protobuf.Struct getParameters()
      The collection of parameters extracted from the query.
      com.google.protobuf.StructOrBuilder getParametersOrBuilder()
      The collection of parameters extracted from the query.
      String getResolvedInput()
      Final text input which was matched during MatchIntent.
      com.google.protobuf.ByteString getResolvedInputBytes()
      Final text input which was matched during MatchIntent.
      boolean hasIntent()
      The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the query.
      boolean hasParameters()
      The collection of parameters extracted from the query.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasIntent

        boolean hasIntent()
         The [Intent][google.cloud.dialogflow.cx.v3.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`][google.cloud.dialogflow.cx.v3.Match.MatchType] match type.
        .google.cloud.dialogflow.cx.v3.Intent intent = 1;
        Returns:
        Whether the intent field is set.

      • getIntent

        Intent getIntent()
         The [Intent][google.cloud.dialogflow.cx.v3.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`][google.cloud.dialogflow.cx.v3.Match.MatchType] match type.
        .google.cloud.dialogflow.cx.v3.Intent intent = 1;
        Returns:
        The intent.

      • getIntentOrBuilder

        IntentOrBuilder getIntentOrBuilder()
         The [Intent][google.cloud.dialogflow.cx.v3.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`][google.cloud.dialogflow.cx.v3.Match.MatchType] match type.
        .google.cloud.dialogflow.cx.v3.Intent intent = 1;

      • getEvent

        String getEvent()
         The event that matched the query. Filled for
 [`EVENT`][google.cloud.dialogflow.cx.v3.Match.MatchType],
 [`NO_MATCH`][google.cloud.dialogflow.cx.v3.Match.MatchType] and
 [`NO_INPUT`][google.cloud.dialogflow.cx.v3.Match.MatchType] match types.
        string event = 6;
        Returns:
        The event.

      • getEventBytes

        com.google.protobuf.ByteString getEventBytes()
         The event that matched the query. Filled for
 [`EVENT`][google.cloud.dialogflow.cx.v3.Match.MatchType],
 [`NO_MATCH`][google.cloud.dialogflow.cx.v3.Match.MatchType] and
 [`NO_INPUT`][google.cloud.dialogflow.cx.v3.Match.MatchType] match types.
        string event = 6;
        Returns:
        The bytes for event.

      • hasParameters

        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:
        Whether the parameters field is set.

      • getParameters

        com.google.protobuf.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:
        The parameters.

      • getParametersOrBuilder

        com.google.protobuf.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;

      • getResolvedInput

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

      • getResolvedInputBytes

        com.google.protobuf.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:
        The bytes for resolvedInput.

      • getMatchTypeValue

        int getMatchTypeValue()
         Type of this [Match][google.cloud.dialogflow.cx.v3.Match].
        .google.cloud.dialogflow.cx.v3.Match.MatchType match_type = 4;
        Returns:
        The enum numeric value on the wire for matchType.

      • getMatchType

        Match.MatchType getMatchType()
         Type of this [Match][google.cloud.dialogflow.cx.v3.Match].
        .google.cloud.dialogflow.cx.v3.Match.MatchType match_type = 4;
        Returns:
        The matchType.

      • getConfidence

        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:
        The confidence.