Package com.google.cloud.dialogflow.v2beta1

Interface QueryResultOrBuilder

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

    • Method Detail

      • getQueryText

        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;
        Returns:
        The queryText.

      • getQueryTextBytes

        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;
        Returns:
        The bytes for queryText.

      • getLanguageCode

        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;
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        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;
        Returns:
        The bytes for languageCode.

      • getSpeechRecognitionConfidence

        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;
        Returns:
        The speechRecognitionConfidence.

      • getAction

        String getAction()
         The action name from the matched intent.
        string action = 3;
        Returns:
        The action.

      • getActionBytes

        com.google.protobuf.ByteString getActionBytes()
         The action name from the matched intent.
        string action = 3;
        Returns:
        The bytes for action.

      • hasParameters

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

      • getParameters

        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;
        Returns:
        The parameters.

      • getParametersOrBuilder

        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;

      • getAllRequiredParamsPresent

        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;
        Returns:
        The allRequiredParamsPresent.

      • getCancelsSlotFilling

        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;
        Returns:
        The cancelsSlotFilling.

      • getFulfillmentText

        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;
        Returns:
        The fulfillmentText.

      • getFulfillmentTextBytes

        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;
        Returns:
        The bytes for fulfillmentText.

      • getFulfillmentMessagesList

        List<Intent.Message> getFulfillmentMessagesList()
         The collection of rich messages to present to the user.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 7;

      • getFulfillmentMessages

        Intent.Message getFulfillmentMessages​(int index)
         The collection of rich messages to present to the user.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 7;

      • getFulfillmentMessagesCount

        int getFulfillmentMessagesCount()
         The collection of rich messages to present to the user.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 7;

      • getFulfillmentMessagesOrBuilderList

        List<? extends Intent.MessageOrBuilder> getFulfillmentMessagesOrBuilderList()
         The collection of rich messages to present to the user.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 7;

      • getFulfillmentMessagesOrBuilder

        Intent.MessageOrBuilder getFulfillmentMessagesOrBuilder​(int index)
         The collection of rich messages to present to the user.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 7;

      • getWebhookSource

        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;
        Returns:
        The webhookSource.

      • getWebhookSourceBytes

        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;
        Returns:
        The bytes for webhookSource.

      • hasWebhookPayload

        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;
        Returns:
        Whether the webhookPayload field is set.

      • getWebhookPayload

        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;
        Returns:
        The webhookPayload.

      • getWebhookPayloadOrBuilder

        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;

      • getOutputContextsList

        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.v2beta1.Context output_contexts = 10;

      • getOutputContexts

        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.v2beta1.Context output_contexts = 10;

      • getOutputContextsCount

        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.v2beta1.Context output_contexts = 10;

      • getOutputContextsOrBuilderList

        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.v2beta1.Context output_contexts = 10;

      • getOutputContextsOrBuilder

        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.v2beta1.Context output_contexts = 10;

      • hasIntent

        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.v2beta1.Intent intent = 11;
        Returns:
        Whether the intent field is set.

      • getIntent

        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.v2beta1.Intent intent = 11;
        Returns:
        The intent.

      • getIntentOrBuilder

        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.v2beta1.Intent intent = 11;

      • getIntentDetectionConfidence

        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;
        Returns:
        The intentDetectionConfidence.

      • hasDiagnosticInfo

        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;
        Returns:
        Whether the diagnosticInfo field is set.

      • getDiagnosticInfo

        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;
        Returns:
        The diagnosticInfo.

      • getDiagnosticInfoOrBuilder

        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;

      • hasSentimentAnalysisResult

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

      • getSentimentAnalysisResult

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

      • getSentimentAnalysisResultOrBuilder

        SentimentAnalysisResultOrBuilder getSentimentAnalysisResultOrBuilder()
         The sentiment analysis result, which depends on the
 `sentiment_analysis_request_config` specified in the request.
        .google.cloud.dialogflow.v2beta1.SentimentAnalysisResult sentiment_analysis_result = 17;

      • hasKnowledgeAnswers

        boolean hasKnowledgeAnswers()
         The result from Knowledge Connector (if any), ordered by decreasing
 `KnowledgeAnswers.match_confidence`.
        .google.cloud.dialogflow.v2beta1.KnowledgeAnswers knowledge_answers = 18;
        Returns:
        Whether the knowledgeAnswers field is set.

      • getKnowledgeAnswers

        KnowledgeAnswers getKnowledgeAnswers()
         The result from Knowledge Connector (if any), ordered by decreasing
 `KnowledgeAnswers.match_confidence`.
        .google.cloud.dialogflow.v2beta1.KnowledgeAnswers knowledge_answers = 18;
        Returns:
        The knowledgeAnswers.

      • getKnowledgeAnswersOrBuilder

        KnowledgeAnswersOrBuilder getKnowledgeAnswersOrBuilder()
         The result from Knowledge Connector (if any), ordered by decreasing
 `KnowledgeAnswers.match_confidence`.
        .google.cloud.dialogflow.v2beta1.KnowledgeAnswers knowledge_answers = 18;