Class QueryResult.Builder (4.47.0)

public static final class QueryResult.Builder extends GeneratedMessageV3.Builder<QueryResult.Builder> implements QueryResultOrBuilder

Represents the result of conversational query or event processing.

Protobuf type google.cloud.dialogflow.v2.QueryResult

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllFulfillmentMessages(Iterable<? extends Intent.Message> values)

public QueryResult.Builder addAllFulfillmentMessages(Iterable<? extends Intent.Message> values)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.dialogflow.v2.Intent.Message>
Returns
TypeDescription
QueryResult.Builder

addAllOutputContexts(Iterable<? extends Context> values)

public QueryResult.Builder addAllOutputContexts(Iterable<? extends Context> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.dialogflow.v2.Context>
Returns
TypeDescription
QueryResult.Builder

addFulfillmentMessages(Intent.Message value)

public QueryResult.Builder addFulfillmentMessages(Intent.Message value)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameter
NameDescription
valueIntent.Message
Returns
TypeDescription
QueryResult.Builder

addFulfillmentMessages(Intent.Message.Builder builderForValue)

public QueryResult.Builder addFulfillmentMessages(Intent.Message.Builder builderForValue)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameter
NameDescription
builderForValueIntent.Message.Builder
Returns
TypeDescription
QueryResult.Builder

addFulfillmentMessages(int index, Intent.Message value)

public QueryResult.Builder addFulfillmentMessages(int index, Intent.Message value)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameters
NameDescription
indexint
valueIntent.Message
Returns
TypeDescription
QueryResult.Builder

addFulfillmentMessages(int index, Intent.Message.Builder builderForValue)

public QueryResult.Builder addFulfillmentMessages(int index, Intent.Message.Builder builderForValue)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameters
NameDescription
indexint
builderForValueIntent.Message.Builder
Returns
TypeDescription
QueryResult.Builder

addFulfillmentMessagesBuilder()

public Intent.Message.Builder addFulfillmentMessagesBuilder()

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Returns
TypeDescription
Intent.Message.Builder

addFulfillmentMessagesBuilder(int index)

public Intent.Message.Builder addFulfillmentMessagesBuilder(int index)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
Intent.Message.Builder

addOutputContexts(Context value)

public QueryResult.Builder addOutputContexts(Context value)

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
NameDescription
valueContext
Returns
TypeDescription
QueryResult.Builder

addOutputContexts(Context.Builder builderForValue)

public QueryResult.Builder addOutputContexts(Context.Builder builderForValue)

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
NameDescription
builderForValueContext.Builder
Returns
TypeDescription
QueryResult.Builder

addOutputContexts(int index, Context value)

public QueryResult.Builder addOutputContexts(int index, Context value)

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;

Parameters
NameDescription
indexint
valueContext
Returns
TypeDescription
QueryResult.Builder

addOutputContexts(int index, Context.Builder builderForValue)

public QueryResult.Builder addOutputContexts(int index, Context.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueContext.Builder
Returns
TypeDescription
QueryResult.Builder

addOutputContextsBuilder()

public Context.Builder addOutputContextsBuilder()

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
TypeDescription
Context.Builder

addOutputContextsBuilder(int index)

public Context.Builder addOutputContextsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Context.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QueryResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QueryResult.Builder
Overrides

build()

public QueryResult build()
Returns
TypeDescription
QueryResult

buildPartial()

public QueryResult buildPartial()
Returns
TypeDescription
QueryResult

clear()

public QueryResult.Builder clear()
Returns
TypeDescription
QueryResult.Builder
Overrides

clearAction()

public QueryResult.Builder clearAction()

The action name from the matched intent.

string action = 3;

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

clearAllRequiredParamsPresent()

public QueryResult.Builder clearAllRequiredParamsPresent()

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
TypeDescription
QueryResult.Builder

This builder for chaining.

clearCancelsSlotFilling()

public QueryResult.Builder clearCancelsSlotFilling()

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
TypeDescription
QueryResult.Builder

This builder for chaining.

clearDiagnosticInfo()

public QueryResult.Builder clearDiagnosticInfo()

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
TypeDescription
QueryResult.Builder

clearField(Descriptors.FieldDescriptor field)

public QueryResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
QueryResult.Builder
Overrides

clearFulfillmentMessages()

public QueryResult.Builder clearFulfillmentMessages()

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Returns
TypeDescription
QueryResult.Builder

clearFulfillmentText()

public QueryResult.Builder clearFulfillmentText()

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
TypeDescription
QueryResult.Builder

This builder for chaining.

clearIntent()

public QueryResult.Builder clearIntent()

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
TypeDescription
QueryResult.Builder

clearIntentDetectionConfidence()

public QueryResult.Builder clearIntentDetectionConfidence()

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
TypeDescription
QueryResult.Builder

This builder for chaining.

clearLanguageCode()

public QueryResult.Builder clearLanguageCode()

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
TypeDescription
QueryResult.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public QueryResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
QueryResult.Builder
Overrides

clearOutputContexts()

public QueryResult.Builder clearOutputContexts()

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
TypeDescription
QueryResult.Builder

clearParameters()

public QueryResult.Builder clearParameters()

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
TypeDescription
QueryResult.Builder

clearQueryText()

public QueryResult.Builder clearQueryText()

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
TypeDescription
QueryResult.Builder

This builder for chaining.

clearSentimentAnalysisResult()

public QueryResult.Builder clearSentimentAnalysisResult()

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
TypeDescription
QueryResult.Builder

clearSpeechRecognitionConfidence()

public QueryResult.Builder clearSpeechRecognitionConfidence()

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
TypeDescription
QueryResult.Builder

This builder for chaining.

clearWebhookPayload()

public QueryResult.Builder clearWebhookPayload()

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
TypeDescription
QueryResult.Builder

clearWebhookSource()

public QueryResult.Builder clearWebhookSource()

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
TypeDescription
QueryResult.Builder

This builder for chaining.

clone()

public QueryResult.Builder clone()
Returns
TypeDescription
QueryResult.Builder
Overrides

getAction()

public String getAction()

The action name from the matched intent.

string action = 3;

Returns
TypeDescription
String

The action.

getActionBytes()

public ByteString getActionBytes()

The action name from the matched intent.

string action = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The cancelsSlotFilling.

getDefaultInstanceForType()

public QueryResult getDefaultInstanceForType()
Returns
TypeDescription
QueryResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
Struct

The diagnosticInfo.

getDiagnosticInfoBuilder()

public Struct.Builder getDiagnosticInfoBuilder()

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
TypeDescription
Builder

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;

Returns
TypeDescription
StructOrBuilder

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
NameDescription
indexint
Returns
TypeDescription
Intent.Message

getFulfillmentMessagesBuilder(int index)

public Intent.Message.Builder getFulfillmentMessagesBuilder(int index)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
Intent.Message.Builder

getFulfillmentMessagesBuilderList()

public List<Intent.Message.Builder> getFulfillmentMessagesBuilderList()

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Returns
TypeDescription
List<Builder>

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

Returns
TypeDescription
List<Message>

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
NameDescription
indexint
Returns
TypeDescription
Intent.MessageOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Intent

The intent.

getIntentBuilder()

public Intent.Builder getIntentBuilder()

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
TypeDescription
Intent.Builder

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

Returns
TypeDescription
IntentOrBuilder

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Context

getOutputContextsBuilder(int index)

public Context.Builder getOutputContextsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Context.Builder

getOutputContextsBuilderList()

public List<Context.Builder> getOutputContextsBuilderList()

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
TypeDescription
List<Builder>

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

Returns
TypeDescription
List<Context>

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
NameDescription
indexint
Returns
TypeDescription
ContextOrBuilder

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
TypeDescription
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
TypeDescription
Struct

The parameters.

getParametersBuilder()

public Struct.Builder getParametersBuilder()

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
TypeDescription
Builder

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;

Returns
TypeDescription
StructOrBuilder

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

Returns
TypeDescription
SentimentAnalysisResult

The sentimentAnalysisResult.

getSentimentAnalysisResultBuilder()

public SentimentAnalysisResult.Builder getSentimentAnalysisResultBuilder()

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
TypeDescription
SentimentAnalysisResult.Builder

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;

Returns
TypeDescription
SentimentAnalysisResultOrBuilder

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
TypeDescription
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
TypeDescription
Struct

The webhookPayload.

getWebhookPayloadBuilder()

public Struct.Builder getWebhookPayloadBuilder()

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
TypeDescription
Builder

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;

Returns
TypeDescription
StructOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the webhookPayload field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDiagnosticInfo(Struct value)

public QueryResult.Builder mergeDiagnosticInfo(Struct value)

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;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
QueryResult.Builder

mergeFrom(QueryResult other)

public QueryResult.Builder mergeFrom(QueryResult other)
Parameter
NameDescription
otherQueryResult
Returns
TypeDescription
QueryResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryResult.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public QueryResult.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
QueryResult.Builder
Overrides

mergeIntent(Intent value)

public QueryResult.Builder mergeIntent(Intent value)

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;

Parameter
NameDescription
valueIntent
Returns
TypeDescription
QueryResult.Builder

mergeParameters(Struct value)

public QueryResult.Builder mergeParameters(Struct value)

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;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
QueryResult.Builder

mergeSentimentAnalysisResult(SentimentAnalysisResult value)

public QueryResult.Builder mergeSentimentAnalysisResult(SentimentAnalysisResult value)

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;

Parameter
NameDescription
valueSentimentAnalysisResult
Returns
TypeDescription
QueryResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueryResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QueryResult.Builder
Overrides

mergeWebhookPayload(Struct value)

public QueryResult.Builder mergeWebhookPayload(Struct value)

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;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
QueryResult.Builder

removeFulfillmentMessages(int index)

public QueryResult.Builder removeFulfillmentMessages(int index)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
QueryResult.Builder

removeOutputContexts(int index)

public QueryResult.Builder removeOutputContexts(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
NameDescription
indexint
Returns
TypeDescription
QueryResult.Builder

setAction(String value)

public QueryResult.Builder setAction(String value)

The action name from the matched intent.

string action = 3;

Parameter
NameDescription
valueString

The action to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setActionBytes(ByteString value)

public QueryResult.Builder setActionBytes(ByteString value)

The action name from the matched intent.

string action = 3;

Parameter
NameDescription
valueByteString

The bytes for action to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setAllRequiredParamsPresent(boolean value)

public QueryResult.Builder setAllRequiredParamsPresent(boolean value)

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;

Parameter
NameDescription
valueboolean

The allRequiredParamsPresent to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setCancelsSlotFilling(boolean value)

public QueryResult.Builder setCancelsSlotFilling(boolean value)

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;

Parameter
NameDescription
valueboolean

The cancelsSlotFilling to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setDiagnosticInfo(Struct value)

public QueryResult.Builder setDiagnosticInfo(Struct value)

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;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
QueryResult.Builder

setDiagnosticInfo(Struct.Builder builderForValue)

public QueryResult.Builder setDiagnosticInfo(Struct.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
QueryResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public QueryResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QueryResult.Builder
Overrides

setFulfillmentMessages(int index, Intent.Message value)

public QueryResult.Builder setFulfillmentMessages(int index, Intent.Message value)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameters
NameDescription
indexint
valueIntent.Message
Returns
TypeDescription
QueryResult.Builder

setFulfillmentMessages(int index, Intent.Message.Builder builderForValue)

public QueryResult.Builder setFulfillmentMessages(int index, Intent.Message.Builder builderForValue)

The collection of rich messages to present to the user.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;

Parameters
NameDescription
indexint
builderForValueIntent.Message.Builder
Returns
TypeDescription
QueryResult.Builder

setFulfillmentText(String value)

public QueryResult.Builder setFulfillmentText(String value)

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;

Parameter
NameDescription
valueString

The fulfillmentText to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setFulfillmentTextBytes(ByteString value)

public QueryResult.Builder setFulfillmentTextBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for fulfillmentText to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setIntent(Intent value)

public QueryResult.Builder setIntent(Intent value)

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;

Parameter
NameDescription
valueIntent
Returns
TypeDescription
QueryResult.Builder

setIntent(Intent.Builder builderForValue)

public QueryResult.Builder setIntent(Intent.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueIntent.Builder
Returns
TypeDescription
QueryResult.Builder

setIntentDetectionConfidence(float value)

public QueryResult.Builder setIntentDetectionConfidence(float value)

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;

Parameter
NameDescription
valuefloat

The intentDetectionConfidence to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setLanguageCode(String value)

public QueryResult.Builder setLanguageCode(String value)

The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

string language_code = 15;

Parameter
NameDescription
valueString

The languageCode to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public QueryResult.Builder setLanguageCodeBytes(ByteString value)

The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

string language_code = 15;

Parameter
NameDescription
valueByteString

The bytes for languageCode to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setOutputContexts(int index, Context value)

public QueryResult.Builder setOutputContexts(int index, Context value)

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;

Parameters
NameDescription
indexint
valueContext
Returns
TypeDescription
QueryResult.Builder

setOutputContexts(int index, Context.Builder builderForValue)

public QueryResult.Builder setOutputContexts(int index, Context.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueContext.Builder
Returns
TypeDescription
QueryResult.Builder

setParameters(Struct value)

public QueryResult.Builder setParameters(Struct value)

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;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
QueryResult.Builder

setParameters(Struct.Builder builderForValue)

public QueryResult.Builder setParameters(Struct.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
QueryResult.Builder

setQueryText(String value)

public QueryResult.Builder setQueryText(String value)

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;

Parameter
NameDescription
valueString

The queryText to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setQueryTextBytes(ByteString value)

public QueryResult.Builder setQueryTextBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for queryText to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public QueryResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
QueryResult.Builder
Overrides

setSentimentAnalysisResult(SentimentAnalysisResult value)

public QueryResult.Builder setSentimentAnalysisResult(SentimentAnalysisResult value)

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;

Parameter
NameDescription
valueSentimentAnalysisResult
Returns
TypeDescription
QueryResult.Builder

setSentimentAnalysisResult(SentimentAnalysisResult.Builder builderForValue)

public QueryResult.Builder setSentimentAnalysisResult(SentimentAnalysisResult.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueSentimentAnalysisResult.Builder
Returns
TypeDescription
QueryResult.Builder

setSpeechRecognitionConfidence(float value)

public QueryResult.Builder setSpeechRecognitionConfidence(float value)

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;

Parameter
NameDescription
valuefloat

The speechRecognitionConfidence to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final QueryResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QueryResult.Builder
Overrides

setWebhookPayload(Struct value)

public QueryResult.Builder setWebhookPayload(Struct value)

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;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
QueryResult.Builder

setWebhookPayload(Struct.Builder builderForValue)

public QueryResult.Builder setWebhookPayload(Struct.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
QueryResult.Builder

setWebhookSource(String value)

public QueryResult.Builder setWebhookSource(String value)

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;

Parameter
NameDescription
valueString

The webhookSource to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.

setWebhookSourceBytes(ByteString value)

public QueryResult.Builder setWebhookSourceBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for webhookSource to set.

Returns
TypeDescription
QueryResult.Builder

This builder for chaining.