QueryResult (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.dialogflow.v2.QueryResult

All Implemented Interfaces:

QueryResultOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable
```
public final class QueryResult
extends GeneratedMessageV3
implements QueryResultOrBuilder
```
```
 Represents the result of conversational query or event processing.
 
```
Protobuf type google.cloud.dialogflow.v2.QueryResult
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QueryResult.Builder
Represents the result of conversational query or event processing.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryResult.Builder` Represents the result of conversational query or event processing.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTION_FIELD_NUMBER`
`static int`	`ALL_REQUIRED_PARAMS_PRESENT_FIELD_NUMBER`
`static int`	`DIAGNOSTIC_INFO_FIELD_NUMBER`
`static int`	`FULFILLMENT_MESSAGES_FIELD_NUMBER`
`static int`	`FULFILLMENT_TEXT_FIELD_NUMBER`
`static int`	`INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER`
`static int`	`INTENT_FIELD_NUMBER`
`static int`	`LANGUAGE_CODE_FIELD_NUMBER`
`static int`	`OUTPUT_CONTEXTS_FIELD_NUMBER`
`static int`	`PARAMETERS_FIELD_NUMBER`
`static int`	`QUERY_TEXT_FIELD_NUMBER`
`static int`	`SPEECH_RECOGNITION_CONFIDENCE_FIELD_NUMBER`
`static int`	`WEBHOOK_PAYLOAD_FIELD_NUMBER`
`static int`	`WEBHOOK_SOURCE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.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.
`static QueryResult`	`getDefaultInstance()`
`QueryResult`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Struct`	`getDiagnosticInfo()` The free-form diagnostic info.
`StructOrBuilder`	`getDiagnosticInfoOrBuilder()` The free-form diagnostic info.
`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.
`java.util.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.
`java.util.List<? extends Intent.MessageOrBuilder>`	`getFulfillmentMessagesOrBuilderList()` The collection of rich messages to present to the user.
`java.lang.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.
`java.lang.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.
`java.util.List<Context>`	`getOutputContextsList()` The collection of output contexts.
`ContextOrBuilder`	`getOutputContextsOrBuilder(int index)` The collection of output contexts.
`java.util.List<? extends ContextOrBuilder>`	`getOutputContextsOrBuilderList()` The collection of output contexts.
`Struct`	`getParameters()` The collection of extracted parameters.
`StructOrBuilder`	`getParametersOrBuilder()` The collection of extracted parameters.
`Parser<QueryResult>`	`getParserForType()`
`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.
`ByteString`	`getQueryTextBytes()` The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input.
`int`	`getSerializedSize()`
`float`	`getSpeechRecognitionConfidence()` The Speech recognition confidence between 0.0 and 1.0.
`UnknownFieldSet`	`getUnknownFields()`
`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.
`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.
`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()` The free-form diagnostic info.
`int`	`hashCode()`
`boolean`	`hasIntent()` The intent that matched the conversational query.
`boolean`	`hasParameters()` The collection of extracted parameters.
`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.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static QueryResult.Builder`	`newBuilder()`
`static QueryResult.Builder`	`newBuilder(QueryResult prototype)`
`QueryResult.Builder`	`newBuilderForType()`
`protected QueryResult.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`static QueryResult`	`parseDelimitedFrom(java.io.InputStream input)`
`static QueryResult`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static QueryResult`	`parseFrom(byte[] data)`
`static QueryResult`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static QueryResult`	`parseFrom(java.nio.ByteBuffer data)`
`static QueryResult`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static QueryResult`	`parseFrom(ByteString data)`
`static QueryResult`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static QueryResult`	`parseFrom(CodedInputStream input)`
`static QueryResult`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static QueryResult`	`parseFrom(java.io.InputStream input)`
`static QueryResult`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<QueryResult>`	`parser()`
`QueryResult.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- QUERY_TEXT_FIELD_NUMBER
```
public static final int QUERY_TEXT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LANGUAGE_CODE_FIELD_NUMBER
```
public static final int LANGUAGE_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SPEECH_RECOGNITION_CONFIDENCE_FIELD_NUMBER
```
public static final int SPEECH_RECOGNITION_CONFIDENCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ACTION_FIELD_NUMBER
```
public static final int ACTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARAMETERS_FIELD_NUMBER
```
public static final int PARAMETERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALL_REQUIRED_PARAMS_PRESENT_FIELD_NUMBER
```
public static final int ALL_REQUIRED_PARAMS_PRESENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FULFILLMENT_TEXT_FIELD_NUMBER
```
public static final int FULFILLMENT_TEXT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FULFILLMENT_MESSAGES_FIELD_NUMBER
```
public static final int FULFILLMENT_MESSAGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WEBHOOK_SOURCE_FIELD_NUMBER
```
public static final int WEBHOOK_SOURCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WEBHOOK_PAYLOAD_FIELD_NUMBER
```
public static final int WEBHOOK_PAYLOAD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OUTPUT_CONTEXTS_FIELD_NUMBER
```
public static final int OUTPUT_CONTEXTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INTENT_FIELD_NUMBER
```
public static final int INTENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER
```
public static final int INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIAGNOSTIC_INFO_FIELD_NUMBER
```
public static final int DIAGNOSTIC_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getQueryText

public 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 an event was provided as input, `query_text` is not set.

string query_text = 1;

Specified by:: getQueryText in interface QueryResultOrBuilder

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 an event was provided as input, `query_text` is not set.

string query_text = 1;

Specified by:: getQueryTextBytes in interface QueryResultOrBuilder

getLanguageCode

public java.lang.String getLanguageCode()

 The language that was triggered during intent detection.
 See [Language Support](https://dialogflow.com/docs/reference/language)
 for a list of the currently supported language codes.

string language_code = 15;

Specified by:: getLanguageCode in interface QueryResultOrBuilder

getLanguageCodeBytes

public ByteString getLanguageCodeBytes()

 The language that was triggered during intent detection.
 See [Language Support](https://dialogflow.com/docs/reference/language)
 for a list of the currently supported language codes.

string language_code = 15;

Specified by:: getLanguageCodeBytes in interface QueryResultOrBuilder

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.
 You should not rely on this field as it isn't guaranteed to be accurate, or
 even set. In particular this field isn't set in Webhook calls and for
 StreamingDetectIntent since the streaming endpoint has separate confidence
 estimates per portion of the audio in StreamingRecognitionResult.

float speech_recognition_confidence = 2;

Specified by:: getSpeechRecognitionConfidence in interface QueryResultOrBuilder

getAction

public java.lang.String getAction()

 The action name from the matched intent.

string action = 3;

Specified by:: getAction in interface QueryResultOrBuilder

getActionBytes
```
public ByteString getActionBytes()
```
```
 The action name from the matched intent.
 
```
string action = 3;
Specified by:

getActionBytes in interface QueryResultOrBuilder

hasParameters
```
public boolean hasParameters()
```
```
 The collection of extracted parameters.
 
```
.google.protobuf.Struct parameters = 4;
Specified by:

hasParameters in interface QueryResultOrBuilder

getParameters
```
public Struct getParameters()
```
```
 The collection of extracted parameters.
 
```
.google.protobuf.Struct parameters = 4;
Specified by:

getParameters in interface QueryResultOrBuilder

getParametersOrBuilder
```
public StructOrBuilder getParametersOrBuilder()
```
```
 The collection of extracted parameters.
 
```
.google.protobuf.Struct parameters = 4;
Specified by:

getParametersOrBuilder in interface QueryResultOrBuilder

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;

Specified by:: getAllRequiredParamsPresent in interface QueryResultOrBuilder

getFulfillmentText

public java.lang.String getFulfillmentText()

 The text to be pronounced to the user or shown on the screen.

string fulfillment_text = 6;

Specified by:: getFulfillmentText in interface QueryResultOrBuilder

getFulfillmentTextBytes
```
public ByteString getFulfillmentTextBytes()
```
```
 The text to be pronounced to the user or shown on the screen.
 
```
string fulfillment_text = 6;
Specified by:

getFulfillmentTextBytes in interface QueryResultOrBuilder

getFulfillmentMessagesList
```
public java.util.List<Intent.Message> getFulfillmentMessagesList()
```
```
 The collection of rich messages to present to the user.
 
```
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
Specified by:

getFulfillmentMessagesList in interface QueryResultOrBuilder

getFulfillmentMessagesOrBuilderList
```
public java.util.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;
Specified by:

getFulfillmentMessagesOrBuilderList in interface QueryResultOrBuilder

getFulfillmentMessagesCount
```
public int getFulfillmentMessagesCount()
```
```
 The collection of rich messages to present to the user.
 
```
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
Specified by:

getFulfillmentMessagesCount in interface QueryResultOrBuilder

getFulfillmentMessages
```
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;
Specified by:

getFulfillmentMessages in interface QueryResultOrBuilder

getFulfillmentMessagesOrBuilder
```
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;
Specified by:

getFulfillmentMessagesOrBuilder in interface QueryResultOrBuilder

getWebhookSource

public 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;

Specified by:: getWebhookSource in interface QueryResultOrBuilder

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;

Specified by:: getWebhookSourceBytes in interface QueryResultOrBuilder

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;

Specified by:: hasWebhookPayload in interface QueryResultOrBuilder

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;

Specified by:: getWebhookPayload in interface QueryResultOrBuilder

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;

Specified by:: getWebhookPayloadOrBuilder in interface QueryResultOrBuilder