com.google.cloud.dialogflow.v2beta1

Interface QueryResultOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

QueryResult, QueryResult.Builder

public interface QueryResultOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAction() The action name from the matched intent.
ByteString	getActionBytes() The action name from the matched intent.
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.
boolean	getCancelsSlotFilling() Indicates whether the conversational query triggers a cancellation for slot filling.
Struct	getDiagnosticInfo() Free-form diagnostic information for the associated detect intent request.
StructOrBuilder	getDiagnosticInfoOrBuilder() Free-form diagnostic information for the associated detect intent request.
Intent.Message	getFulfillmentMessages(int index) The collection of rich messages to present to the user.
int	getFulfillmentMessagesCount() The collection of rich messages to present to the user.
List<Intent.Message>	getFulfillmentMessagesList() The collection of rich messages to present to the user.
Intent.MessageOrBuilder	getFulfillmentMessagesOrBuilder(int index) The collection of rich messages to present to the user.
List<? extends Intent.MessageOrBuilder>	getFulfillmentMessagesOrBuilderList() The collection of rich messages to present to the user.
String	getFulfillmentText() The text to be pronounced to the user or shown on the screen.
ByteString	getFulfillmentTextBytes() The text to be pronounced to the user or shown on the screen.
Intent	getIntent() The intent that matched the conversational query.
float	getIntentDetectionConfidence() The intent detection confidence.
IntentOrBuilder	getIntentOrBuilder() The intent that matched the conversational query.
KnowledgeAnswers	getKnowledgeAnswers() The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`.
KnowledgeAnswersOrBuilder	getKnowledgeAnswersOrBuilder() The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`.
String	getLanguageCode() The language that was triggered during intent detection.
ByteString	getLanguageCodeBytes() The language that was triggered during intent detection.
Context	getOutputContexts(int index) The collection of output contexts.
int	getOutputContextsCount() The collection of output contexts.
List<Context>	getOutputContextsList() The collection of output contexts.
ContextOrBuilder	getOutputContextsOrBuilder(int index) The collection of output contexts.
List<? extends ContextOrBuilder>	getOutputContextsOrBuilderList() The collection of output contexts.
Struct	getParameters() The collection of extracted parameters.
StructOrBuilder	getParametersOrBuilder() The collection of extracted parameters.
String	getQueryText() The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input.
ByteString	getQueryTextBytes() The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input.
SentimentAnalysisResult	getSentimentAnalysisResult() The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request.
SentimentAnalysisResultOrBuilder	getSentimentAnalysisResultOrBuilder() The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request.
float	getSpeechRecognitionConfidence() The Speech recognition confidence between 0.0 and 1.0.
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.
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.
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.
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.
boolean	hasDiagnosticInfo() Free-form diagnostic information for the associated detect intent request.
boolean	hasIntent() The intent that matched the conversational query.
boolean	hasKnowledgeAnswers() The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`.
boolean	hasParameters() The collection of extracted parameters.
boolean	hasSentimentAnalysisResult() The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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

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

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

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: map
     -   Else: depending on parameter value type, could be one of string,
         number, boolean, null, list or map
 -   MapValue value:
     -   If parameter's entity type is a composite entity:
         map from composite entity property names to property values
     -   Else: parameter value
 

.google.protobuf.Struct parameters = 4;

Returns:

Whether the parameters field is set.

getParameters

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: map
     -   Else: depending on parameter value type, could be one of string,
         number, boolean, null, list or map
 -   MapValue value:
     -   If parameter's entity type is a composite entity:
         map from composite entity property names to property values
     -   Else: parameter value
 

.google.protobuf.Struct parameters = 4;

Returns:

The parameters.

getParametersOrBuilder

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: map
     -   Else: depending on parameter value type, could be one of string,
         number, boolean, null, list or map
 -   MapValue value:
     -   If parameter's entity type is a composite entity:
         map from composite entity property names to property values
     -   Else: 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

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

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

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

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

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

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;