public final class QueryResult extends GeneratedMessageV3 implements QueryResultOrBuilder
Represents the result of conversational query or event processing.
Protobuf type google.cloud.dialogflow.v2.QueryResult
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ALL_REQUIRED_PARAMS_PRESENT_FIELD_NUMBER
public static final int ALL_REQUIRED_PARAMS_PRESENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CANCELS_SLOT_FILLING_FIELD_NUMBER
public static final int CANCELS_SLOT_FILLING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIAGNOSTIC_INFO_FIELD_NUMBER
public static final int DIAGNOSTIC_INFO_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FULFILLMENT_MESSAGES_FIELD_NUMBER
public static final int FULFILLMENT_MESSAGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FULFILLMENT_TEXT_FIELD_NUMBER
public static final int FULFILLMENT_TEXT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER
public static final int INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INTENT_FIELD_NUMBER
public static final int INTENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OUTPUT_CONTEXTS_FIELD_NUMBER
public static final int OUTPUT_CONTEXTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
QUERY_TEXT_FIELD_NUMBER
public static final int QUERY_TEXT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SENTIMENT_ANALYSIS_RESULT_FIELD_NUMBER
public static final int SENTIMENT_ANALYSIS_RESULT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SPEECH_RECOGNITION_CONFIDENCE_FIELD_NUMBER
public static final int SPEECH_RECOGNITION_CONFIDENCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WEBHOOK_PAYLOAD_FIELD_NUMBER
public static final int WEBHOOK_PAYLOAD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WEBHOOK_SOURCE_FIELD_NUMBER
public static final int WEBHOOK_SOURCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static QueryResult getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static QueryResult.Builder newBuilder()
newBuilder(QueryResult prototype)
public static QueryResult.Builder newBuilder(QueryResult prototype)
public static QueryResult parseDelimitedFrom(InputStream input)
public static QueryResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static QueryResult parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static QueryResult parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(CodedInputStream input)
public static QueryResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(InputStream input)
public static QueryResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static QueryResult parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<QueryResult> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAction()
public String getAction()
The action name from the matched intent.
string action = 3;
| Returns |
|---|
| Type | Description |
String | The action.
|
getActionBytes()
public ByteString getActionBytes()
The action name from the matched intent.
string action = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for action.
|
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;
| Returns |
|---|
| Type | Description |
boolean | 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.
bool cancels_slot_filling = 21;
| Returns |
|---|
| Type | Description |
boolean | The cancelsSlotFilling.
|
getDefaultInstanceForType()
public QueryResult getDefaultInstanceForType()
getDiagnosticInfo()
public 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 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;
getFulfillmentMessages(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
getFulfillmentMessagesCount()
public 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 List<Intent.Message> getFulfillmentMessagesList()
The collection of rich messages to present to the user.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
getFulfillmentMessagesOrBuilder(int index)
public 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
|
getFulfillmentMessagesOrBuilderList()
public 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 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 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 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 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 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;
getLanguageCode()
public 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 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 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
|
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;
| Returns |
|---|
| Type | Description |
int | |
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;
getOutputContextsOrBuilder(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.v2.ContextOrBuilder> | |
getParameters()
public 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 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;
getParserForType()
public Parser<QueryResult> getParserForType()
Overrides
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;
| Returns |
|---|
| Type | Description |
String | The queryText.
|
getQueryTextBytes()
public 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 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;
getSentimentAnalysisResultOrBuilder()
public 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;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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;
| Returns |
|---|
| Type | Description |
float | The speechRecognitionConfidence.
|
getWebhookPayload()
public 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 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;
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;
| Returns |
|---|
| Type | Description |
String | The webhookSource.
|
getWebhookSourceBytes()
public 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 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 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 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public QueryResult.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public QueryResult.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
