- 4.53.0 (latest)
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.1
public interface QueryResultOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getAction()
public abstract String getAction()
The action name from the matched intent.
string action = 3;
Returns | |
---|---|
Type | Description |
String |
The action. |
getActionBytes()
public abstract ByteString getActionBytes()
The action name from the matched intent.
string action = 3;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for action. |
getAllRequiredParamsPresent()
public abstract 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 | |
---|---|
Type | Description |
boolean |
The allRequiredParamsPresent. |
getCancelsSlotFilling()
public abstract boolean getCancelsSlotFilling()
Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation.
bool cancels_slot_filling = 21;
Returns | |
---|---|
Type | Description |
boolean |
The cancelsSlotFilling. |
getDiagnosticInfo()
public abstract 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 | |
---|---|
Type | Description |
Struct |
The diagnosticInfo. |
getDiagnosticInfoOrBuilder()
public abstract 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;
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getFulfillmentMessages(int index)
public abstract 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;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.Message |
getFulfillmentMessagesCount()
public abstract int getFulfillmentMessagesCount()
The collection of rich messages to present to the user.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
Returns | |
---|---|
Type | Description |
int |
getFulfillmentMessagesList()
public abstract List<Intent.Message> getFulfillmentMessagesList()
The collection of rich messages to present to the user.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
Returns | |
---|---|
Type | Description |
List<Message> |
getFulfillmentMessagesOrBuilder(int index)
public abstract Intent.MessageOrBuilder getFulfillmentMessagesOrBuilder(int index)
The collection of rich messages to present to the user.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.MessageOrBuilder |
getFulfillmentMessagesOrBuilderList()
public abstract List<? extends Intent.MessageOrBuilder> getFulfillmentMessagesOrBuilderList()
The collection of rich messages to present to the user.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.dialogflow.v2.Intent.MessageOrBuilder> |
getFulfillmentText()
public abstract 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 | |
---|---|
Type | Description |
String |
The fulfillmentText. |
getFulfillmentTextBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString |
The bytes for fulfillmentText. |
getIntent()
public abstract 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;
Returns | |
---|---|
Type | Description |
Intent |
The intent. |
getIntentDetectionConfidence()
public abstract 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 | |
---|---|
Type | Description |
float |
The intentDetectionConfidence. |
getIntentOrBuilder()
public abstract 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;
Returns | |
---|---|
Type | Description |
IntentOrBuilder |
getLanguageCode()
public abstract String getLanguageCode()
The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.
string language_code = 15;
Returns | |
---|---|
Type | Description |
String |
The languageCode. |
getLanguageCodeBytes()
public abstract ByteString getLanguageCodeBytes()
The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.
string language_code = 15;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for languageCode. |
getOutputContexts(int index)
public abstract 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;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Context |
getOutputContextsCount()
public abstract 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;
Returns | |
---|---|
Type | Description |
int |
getOutputContextsList()
public abstract 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;
Returns | |
---|---|
Type | Description |
List<Context> |
getOutputContextsOrBuilder(int index)
public abstract 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;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ContextOrBuilder |
getOutputContextsOrBuilderList()
public abstract 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;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.dialogflow.v2.ContextOrBuilder> |
getParameters()
public abstract 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 | |
---|---|
Type | Description |
Struct |
The parameters. |
getParametersOrBuilder()
public abstract 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;
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getQueryText()
public abstract 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 | |
---|---|
Type | Description |
String |
The queryText. |
getQueryTextBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString |
The bytes for queryText. |
getSentimentAnalysisResult()
public abstract 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;
Returns | |
---|---|
Type | Description |
SentimentAnalysisResult |
The sentimentAnalysisResult. |
getSentimentAnalysisResultOrBuilder()
public abstract SentimentAnalysisResultOrBuilder getSentimentAnalysisResultOrBuilder()
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;
Returns | |
---|---|
Type | Description |
SentimentAnalysisResultOrBuilder |
getSpeechRecognitionConfidence()
public abstract 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 | |
---|---|
Type | Description |
float |
The speechRecognitionConfidence. |
getWebhookPayload()
public abstract 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 | |
---|---|
Type | Description |
Struct |
The webhookPayload. |
getWebhookPayloadOrBuilder()
public abstract 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;
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getWebhookSource()
public abstract 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 | |
---|---|
Type | Description |
String |
The webhookSource. |
getWebhookSourceBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString |
The bytes for webhookSource. |
hasDiagnosticInfo()
public abstract 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 | |
---|---|
Type | Description |
boolean |
Whether the diagnosticInfo field is set. |
hasIntent()
public abstract 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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the intent field is set. |
hasParameters()
public abstract 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 | |
---|---|
Type | Description |
boolean |
Whether the parameters field is set. |
hasSentimentAnalysisResult()
public abstract 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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the sentimentAnalysisResult field is set. |
hasWebhookPayload()
public abstract 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 | |
---|---|
Type | Description |
boolean |
Whether the webhookPayload field is set. |