Package com.google.cloud.dialogflow.v2

Class QueryResult

  • All Implemented Interfaces:
    QueryResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class QueryResult
extends com.google.protobuf.GeneratedMessageV3
implements QueryResultOrBuilder
     Represents the result of conversational query or event processing.
    Protobuf type google.cloud.dialogflow.v2.QueryResult
    See Also:
    Serialized Form

    • Field Detail

      • QUERY_TEXT_FIELD_NUMBER

        public static final int QUERY_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LANGUAGE_CODE_FIELD_NUMBER

        public static final int LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SPEECH_RECOGNITION_CONFIDENCE_FIELD_NUMBER

        public static final int SPEECH_RECOGNITION_CONFIDENCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALL_REQUIRED_PARAMS_PRESENT_FIELD_NUMBER

        public static final int ALL_REQUIRED_PARAMS_PRESENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CANCELS_SLOT_FILLING_FIELD_NUMBER

        public static final int CANCELS_SLOT_FILLING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FULFILLMENT_TEXT_FIELD_NUMBER

        public static final int FULFILLMENT_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FULFILLMENT_MESSAGES_FIELD_NUMBER

        public static final int FULFILLMENT_MESSAGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEBHOOK_SOURCE_FIELD_NUMBER

        public static final int WEBHOOK_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEBHOOK_PAYLOAD_FIELD_NUMBER

        public static final int WEBHOOK_PAYLOAD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_CONTEXTS_FIELD_NUMBER

        public static final int OUTPUT_CONTEXTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER

        public static final int INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DIAGNOSTIC_INFO_FIELD_NUMBER

        public static final int DIAGNOSTIC_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SENTIMENT_ANALYSIS_RESULT_FIELD_NUMBER

        public static final int SENTIMENT_ANALYSIS_RESULT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getQueryText

        public String getQueryText()
         The original conversational query text:

 - If natural language text was provided as input, `query_text` contains
   a copy of the input.
 - If natural language speech audio was provided as input, `query_text`
   contains the speech recognition result. If speech recognizer produced
   multiple alternatives, a particular one is picked.
 - If automatic spell correction is enabled, `query_text` will contain the
   corrected user input.
        string query_text = 1;
        Specified by:
        getQueryText in interface QueryResultOrBuilder
        Returns:
        The queryText.

      • getQueryTextBytes

        public com.google.protobuf.ByteString getQueryTextBytes()
         The original conversational query text:

 - If natural language text was provided as input, `query_text` contains
   a copy of the input.
 - If natural language speech audio was provided as input, `query_text`
   contains the speech recognition result. If speech recognizer produced
   multiple alternatives, a particular one is picked.
 - If automatic spell correction is enabled, `query_text` will contain the
   corrected user input.
        string query_text = 1;
        Specified by:
        getQueryTextBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for queryText.

      • getLanguageCode

        public String getLanguageCode()
         The language that was triggered during intent detection.
 See [Language
 Support](https://cloud.google.com/dialogflow/docs/reference/language)
 for a list of the currently supported language codes.
        string language_code = 15;
        Specified by:
        getLanguageCode in interface QueryResultOrBuilder
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        public com.google.protobuf.ByteString getLanguageCodeBytes()
         The language that was triggered during intent detection.
 See [Language
 Support](https://cloud.google.com/dialogflow/docs/reference/language)
 for a list of the currently supported language codes.
        string language_code = 15;
        Specified by:
        getLanguageCodeBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for languageCode.

      • getSpeechRecognitionConfidence

        public float getSpeechRecognitionConfidence()
         The Speech recognition confidence between 0.0 and 1.0. A higher number
 indicates an estimated greater likelihood that the recognized words are
 correct. The default of 0.0 is a sentinel value indicating that confidence
 was not set.

 This field is not guaranteed to be accurate or set. In particular this
 field isn't set for StreamingDetectIntent since the streaming endpoint has
 separate confidence estimates per portion of the audio in
 StreamingRecognitionResult.
        float speech_recognition_confidence = 2;
        Specified by:
        getSpeechRecognitionConfidence in interface QueryResultOrBuilder
        Returns:
        The speechRecognitionConfidence.

      • getAction

        public String getAction()
         The action name from the matched intent.
        string action = 3;
        Specified by:
        getAction in interface QueryResultOrBuilder
        Returns:
        The action.

      • getActionBytes

        public com.google.protobuf.ByteString getActionBytes()
         The action name from the matched intent.
        string action = 3;
        Specified by:
        getActionBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for action.

      • hasParameters

        public boolean hasParameters()
         The collection of extracted parameters.

 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 = 4;
        Specified by:
        hasParameters in interface QueryResultOrBuilder
        Returns:
        Whether the parameters field is set.

      • getParameters

        public com.google.protobuf.Struct getParameters()
         The collection of extracted parameters.

 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 = 4;
        Specified by:
        getParameters in interface QueryResultOrBuilder
        Returns:
        The parameters.

      • getParametersOrBuilder

        public com.google.protobuf.StructOrBuilder getParametersOrBuilder()
         The collection of extracted parameters.

 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 = 4;
        Specified by:
        getParametersOrBuilder in interface QueryResultOrBuilder

      • getAllRequiredParamsPresent

        public boolean getAllRequiredParamsPresent()
         This field is set to:

 - `false` if the matched intent has required parameters and not all of
    the required parameter values have been collected.
 - `true` if all required parameter values have been collected, or if the
    matched intent doesn't contain any required parameters.
        bool all_required_params_present = 5;
        Specified by:
        getAllRequiredParamsPresent in interface QueryResultOrBuilder
        Returns:
        The allRequiredParamsPresent.

      • getCancelsSlotFilling

        public boolean getCancelsSlotFilling()
         Indicates whether the conversational query triggers a cancellation for slot
 filling. For more information, see the [cancel slot filling
 documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).
        bool cancels_slot_filling = 21;
        Specified by:
        getCancelsSlotFilling in interface QueryResultOrBuilder
        Returns:
        The cancelsSlotFilling.

      • getFulfillmentText

        public String getFulfillmentText()
         The text to be pronounced to the user or shown on the screen.
 Note: This is a legacy field, `fulfillment_messages` should be preferred.
        string fulfillment_text = 6;
        Specified by:
        getFulfillmentText in interface QueryResultOrBuilder
        Returns:
        The fulfillmentText.

      • getFulfillmentTextBytes

        public com.google.protobuf.ByteString getFulfillmentTextBytes()
         The text to be pronounced to the user or shown on the screen.
 Note: This is a legacy field, `fulfillment_messages` should be preferred.
        string fulfillment_text = 6;
        Specified by:
        getFulfillmentTextBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for fulfillmentText.

      • getFulfillmentMessagesCount

        public int getFulfillmentMessagesCount()
         The collection of rich messages to present to the user.
        repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
        Specified by:
        getFulfillmentMessagesCount in interface QueryResultOrBuilder

      • getFulfillmentMessages

        public Intent.Message getFulfillmentMessages​(int index)
         The collection of rich messages to present to the user.
        repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
        Specified by:
        getFulfillmentMessages in interface QueryResultOrBuilder

      • getWebhookSource

        public String getWebhookSource()
         If the query was fulfilled by a webhook call, this field is set to the
 value of the `source` field returned in the webhook response.
        string webhook_source = 8;
        Specified by:
        getWebhookSource in interface QueryResultOrBuilder
        Returns:
        The webhookSource.

      • getWebhookSourceBytes

        public com.google.protobuf.ByteString getWebhookSourceBytes()
         If the query was fulfilled by a webhook call, this field is set to the
 value of the `source` field returned in the webhook response.
        string webhook_source = 8;
        Specified by:
        getWebhookSourceBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for webhookSource.

      • hasWebhookPayload

        public boolean hasWebhookPayload()
         If the query was fulfilled by a webhook call, this field is set to the
 value of the `payload` field returned in the webhook response.
        .google.protobuf.Struct webhook_payload = 9;
        Specified by:
        hasWebhookPayload in interface QueryResultOrBuilder
        Returns:
        Whether the webhookPayload field is set.

      • getWebhookPayload

        public com.google.protobuf.Struct getWebhookPayload()
         If the query was fulfilled by a webhook call, this field is set to the
 value of the `payload` field returned in the webhook response.
        .google.protobuf.Struct webhook_payload = 9;
        Specified by:
        getWebhookPayload in interface QueryResultOrBuilder
        Returns:
        The webhookPayload.

      • getWebhookPayloadOrBuilder

        public com.google.protobuf.StructOrBuilder getWebhookPayloadOrBuilder()
         If the query was fulfilled by a webhook call, this field is set to the
 value of the `payload` field returned in the webhook response.
        .google.protobuf.Struct webhook_payload = 9;
        Specified by:
        getWebhookPayloadOrBuilder in interface QueryResultOrBuilder

      • getOutputContextsList

        public List<Context> getOutputContextsList()
         The collection of output contexts. If applicable,
 `output_contexts.parameters` contains entries with name
 `<parameter name>.original` containing the original parameter values
 before the query.
        repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
        Specified by:
        getOutputContextsList in interface QueryResultOrBuilder

      • getOutputContextsOrBuilderList

        public List<? extends ContextOrBuilder> getOutputContextsOrBuilderList()
         The collection of output contexts. If applicable,
 `output_contexts.parameters` contains entries with name
 `<parameter name>.original` containing the original parameter values
 before the query.
        repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
        Specified by:
        getOutputContextsOrBuilderList in interface QueryResultOrBuilder

      • getOutputContextsCount

        public int getOutputContextsCount()
         The collection of output contexts. If applicable,
 `output_contexts.parameters` contains entries with name
 `<parameter name>.original` containing the original parameter values
 before the query.
        repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
        Specified by:
        getOutputContextsCount in interface QueryResultOrBuilder

      • getOutputContexts

        public Context getOutputContexts​(int index)
         The collection of output contexts. If applicable,
 `output_contexts.parameters` contains entries with name
 `<parameter name>.original` containing the original parameter values
 before the query.
        repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
        Specified by:
        getOutputContexts in interface QueryResultOrBuilder

      • getOutputContextsOrBuilder

        public ContextOrBuilder getOutputContextsOrBuilder​(int index)
         The collection of output contexts. If applicable,
 `output_contexts.parameters` contains entries with name
 `<parameter name>.original` containing the original parameter values
 before the query.
        repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
        Specified by:
        getOutputContextsOrBuilder in interface QueryResultOrBuilder

      • hasIntent

        public boolean hasIntent()
         The intent that matched the conversational query. Some, not
 all fields are filled in this message, including but not limited to:
 `name`, `display_name`, `end_interaction` and `is_fallback`.
        .google.cloud.dialogflow.v2.Intent intent = 11;
        Specified by:
        hasIntent in interface QueryResultOrBuilder
        Returns:
        Whether the intent field is set.

      • getIntent

        public Intent getIntent()
         The intent that matched the conversational query. Some, not
 all fields are filled in this message, including but not limited to:
 `name`, `display_name`, `end_interaction` and `is_fallback`.
        .google.cloud.dialogflow.v2.Intent intent = 11;
        Specified by:
        getIntent in interface QueryResultOrBuilder
        Returns:
        The intent.

      • getIntentOrBuilder

        public IntentOrBuilder getIntentOrBuilder()
         The intent that matched the conversational query. Some, not
 all fields are filled in this message, including but not limited to:
 `name`, `display_name`, `end_interaction` and `is_fallback`.
        .google.cloud.dialogflow.v2.Intent intent = 11;
        Specified by:
        getIntentOrBuilder in interface QueryResultOrBuilder

      • getIntentDetectionConfidence

        public float getIntentDetectionConfidence()
         The intent detection confidence. 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.
 If there are `multiple knowledge_answers` messages, this value is set to
 the greatest `knowledgeAnswers.match_confidence` value in the list.
        float intent_detection_confidence = 12;
        Specified by:
        getIntentDetectionConfidence in interface QueryResultOrBuilder
        Returns:
        The intentDetectionConfidence.

      • hasDiagnosticInfo

        public boolean hasDiagnosticInfo()
         Free-form diagnostic information for the associated detect intent request.
 The fields of this data can change without notice, so you should not write
 code that depends on its structure.
 The data may contain:

 - webhook call latency
 - webhook errors
        .google.protobuf.Struct diagnostic_info = 14;
        Specified by:
        hasDiagnosticInfo in interface QueryResultOrBuilder
        Returns:
        Whether the diagnosticInfo field is set.

      • getDiagnosticInfo

        public com.google.protobuf.Struct getDiagnosticInfo()
         Free-form diagnostic information for the associated detect intent request.
 The fields of this data can change without notice, so you should not write
 code that depends on its structure.
 The data may contain:

 - webhook call latency
 - webhook errors
        .google.protobuf.Struct diagnostic_info = 14;
        Specified by:
        getDiagnosticInfo in interface QueryResultOrBuilder
        Returns:
        The diagnosticInfo.

      • getDiagnosticInfoOrBuilder

        public com.google.protobuf.StructOrBuilder getDiagnosticInfoOrBuilder()
         Free-form diagnostic information for the associated detect intent request.
 The fields of this data can change without notice, so you should not write
 code that depends on its structure.
 The data may contain:

 - webhook call latency
 - webhook errors
        .google.protobuf.Struct diagnostic_info = 14;
        Specified by:
        getDiagnosticInfoOrBuilder in interface QueryResultOrBuilder

      • hasSentimentAnalysisResult

        public boolean hasSentimentAnalysisResult()
         The sentiment analysis result, which depends on the
 `sentiment_analysis_request_config` specified in the request.
        .google.cloud.dialogflow.v2.SentimentAnalysisResult sentiment_analysis_result = 17;
        Specified by:
        hasSentimentAnalysisResult in interface QueryResultOrBuilder
        Returns:
        Whether the sentimentAnalysisResult field is set.

      • getSentimentAnalysisResult

        public SentimentAnalysisResult getSentimentAnalysisResult()
         The sentiment analysis result, which depends on the
 `sentiment_analysis_request_config` specified in the request.
        .google.cloud.dialogflow.v2.SentimentAnalysisResult sentiment_analysis_result = 17;
        Specified by:
        getSentimentAnalysisResult in interface QueryResultOrBuilder
        Returns:
        The sentimentAnalysisResult.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static QueryResult parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryResult parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryResult parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryResult parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryResult parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryResult parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryResult parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

        public QueryResult.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public QueryResult.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected QueryResult.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static QueryResult getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<QueryResult> parser()

      • getParserForType

        public com.google.protobuf.Parser<QueryResult> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public QueryResult getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder