com.google.cloud.dialogflow.v2.QueryResultOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2/session.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dialogflow.v2;
public interface QueryResultOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.QueryResult)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The queryText.
*/
java.lang.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;
*
* @return The bytes for queryText.
*/
com.google.protobuf.ByteString getQueryTextBytes();
/**
*
*
*
* 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;
*
* @return The languageCode.
*/
java.lang.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;
*
* @return The bytes for languageCode.
*/
com.google.protobuf.ByteString getLanguageCodeBytes();
/**
*
*
*
* 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;
*
* @return The speechRecognitionConfidence.
*/
float getSpeechRecognitionConfidence();
/**
*
*
*
* The action name from the matched intent.
*
*
* string action = 3;
*
* @return The action.
*/
java.lang.String getAction();
/**
*
*
*
* The action name from the matched intent.
*
*
* string action = 3;
*
* @return The bytes for action.
*/
com.google.protobuf.ByteString getActionBytes();
/**
*
*
*
* 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;
*
* @return Whether the parameters field is set.
*/
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;
*
* @return The parameters.
*/
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;
*/
com.google.protobuf.StructOrBuilder getParametersOrBuilder();
/**
*
*
*
* 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;
*
* @return The allRequiredParamsPresent.
*/
boolean getAllRequiredParamsPresent();
/**
*
*
*
* 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;
*
* @return The cancelsSlotFilling.
*/
boolean getCancelsSlotFilling();
/**
*
*
*
* 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;
*
* @return The fulfillmentText.
*/
java.lang.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;
*
* @return The bytes for fulfillmentText.
*/
com.google.protobuf.ByteString getFulfillmentTextBytes();
/**
*
*
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
java.util.List getFulfillmentMessagesList();
/**
*
*
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
com.google.cloud.dialogflow.v2.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;
*/
int getFulfillmentMessagesCount();
/**
*
*
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
java.util.List
getFulfillmentMessagesOrBuilderList();
/**
*
*
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
com.google.cloud.dialogflow.v2.Intent.MessageOrBuilder getFulfillmentMessagesOrBuilder(int index);
/**
*
*
*
* 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;
*
* @return The webhookSource.
*/
java.lang.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;
*
* @return The bytes for webhookSource.
*/
com.google.protobuf.ByteString getWebhookSourceBytes();
/**
*
*
*
* 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;
*
* @return Whether the webhookPayload field is set.
*/
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;
*
* @return The webhookPayload.
*/
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;
*/
com.google.protobuf.StructOrBuilder getWebhookPayloadOrBuilder();
/**
*
*
*
* 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;
*/
java.util.List 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;
*/
com.google.cloud.dialogflow.v2.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;
*/
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;
*/
java.util.List
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;
*/
com.google.cloud.dialogflow.v2.ContextOrBuilder getOutputContextsOrBuilder(int index);
/**
*
*
*
* 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;
*
* @return Whether the intent field is set.
*/
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;
*
* @return The intent.
*/
com.google.cloud.dialogflow.v2.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;
*/
com.google.cloud.dialogflow.v2.IntentOrBuilder getIntentOrBuilder();
/**
*
*
*
* 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;
*
* @return The intentDetectionConfidence.
*/
float getIntentDetectionConfidence();
/**
*
*
*
* 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;
*
* @return Whether the diagnosticInfo field is set.
*/
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;
*
* @return The diagnosticInfo.
*/
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;
*/
com.google.protobuf.StructOrBuilder getDiagnosticInfoOrBuilder();
/**
*
*
*
* 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;
*
*
* @return Whether the sentimentAnalysisResult field is set.
*/
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;
*
*
* @return The sentimentAnalysisResult.
*/
com.google.cloud.dialogflow.v2.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;
*
*/
com.google.cloud.dialogflow.v2.SentimentAnalysisResultOrBuilder
getSentimentAnalysisResultOrBuilder();
}