Interface QueryDataResponseOrBuilder (0.9.0)

public interface QueryDataResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisambiguationQuestion(int index)

public abstract String getDisambiguationQuestion(int index)

If ambiguity was detected in the natural language query and options.generate_disambiguation_question was true, this field contains a question to the user for clarification. The returned represents the service's best effort based on the ambiguous input.

repeated string disambiguation_question = 5;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The disambiguationQuestion at the given index.

getDisambiguationQuestionBytes(int index)

public abstract ByteString getDisambiguationQuestionBytes(int index)

If ambiguity was detected in the natural language query and options.generate_disambiguation_question was true, this field contains a question to the user for clarification. The returned represents the service's best effort based on the ambiguous input.

repeated string disambiguation_question = 5;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the disambiguationQuestion at the given index.

getDisambiguationQuestionCount()

public abstract int getDisambiguationQuestionCount()

If ambiguity was detected in the natural language query and options.generate_disambiguation_question was true, this field contains a question to the user for clarification. The returned represents the service's best effort based on the ambiguous input.

repeated string disambiguation_question = 5;

Returns
Type Description
int

The count of disambiguationQuestion.

getDisambiguationQuestionList()

public abstract List<String> getDisambiguationQuestionList()

If ambiguity was detected in the natural language query and options.generate_disambiguation_question was true, this field contains a question to the user for clarification. The returned represents the service's best effort based on the ambiguous input.

repeated string disambiguation_question = 5;

Returns
Type Description
List<String>

A list containing the disambiguationQuestion.

getGeneratedQuery()

public abstract String getGeneratedQuery()

Generated query for the given user prompt.

string generated_query = 1;

Returns
Type Description
String

The generatedQuery.

getGeneratedQueryBytes()

public abstract ByteString getGeneratedQueryBytes()

Generated query for the given user prompt.

string generated_query = 1;

Returns
Type Description
ByteString

The bytes for generatedQuery.

getIntentExplanation()

public abstract String getIntentExplanation()

A natural language explanation of the generated query. Populated if options.generate_explanation was true in the request.

string intent_explanation = 2;

Returns
Type Description
String

The intentExplanation.

getIntentExplanationBytes()

public abstract ByteString getIntentExplanationBytes()

A natural language explanation of the generated query. Populated if options.generate_explanation was true in the request.

string intent_explanation = 2;

Returns
Type Description
ByteString

The bytes for intentExplanation.

getNaturalLanguageAnswer()

public abstract String getNaturalLanguageAnswer()

A natural language answer to the query, based on the query_result. Populated if options.generate_natural_language_answer was true in the request and query execution was successful based in the response from executeSql API.

string natural_language_answer = 4;

Returns
Type Description
String

The naturalLanguageAnswer.

getNaturalLanguageAnswerBytes()

public abstract ByteString getNaturalLanguageAnswerBytes()

A natural language answer to the query, based on the query_result. Populated if options.generate_natural_language_answer was true in the request and query execution was successful based in the response from executeSql API.

string natural_language_answer = 4;

Returns
Type Description
ByteString

The bytes for naturalLanguageAnswer.

getQueryResult()

public abstract ExecutedQueryResult getQueryResult()

The result of executing the query. Populated if options.generate_query_result or options.generate_natural_language_answer was true in the request, and execution was successful or attempted.

.google.cloud.geminidataanalytics.v1beta.ExecutedQueryResult query_result = 3;

Returns
Type Description
ExecutedQueryResult

The queryResult.

getQueryResultOrBuilder()

public abstract ExecutedQueryResultOrBuilder getQueryResultOrBuilder()

The result of executing the query. Populated if options.generate_query_result or options.generate_natural_language_answer was true in the request, and execution was successful or attempted.

.google.cloud.geminidataanalytics.v1beta.ExecutedQueryResult query_result = 3;

Returns
Type Description
ExecutedQueryResultOrBuilder

hasQueryResult()

public abstract boolean hasQueryResult()

The result of executing the query. Populated if options.generate_query_result or options.generate_natural_language_answer was true in the request, and execution was successful or attempted.

.google.cloud.geminidataanalytics.v1beta.ExecutedQueryResult query_result = 3;

Returns
Type Description
boolean

Whether the queryResult field is set.