Data Analytics API with Gemini V1BETA API - Class Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataResponse (v1.2.0)

Reference documentation and code samples for the Data Analytics API with Gemini V1BETA API class Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataResponse.

Response containing the generated query and related information.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#disambiguation_question

def disambiguation_question() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#disambiguation_question=

def disambiguation_question=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.

#generated_query

def generated_query() -> ::String
Returns
  • (::String) — Generated query for the given user prompt.

#generated_query=

def generated_query=(value) -> ::String
Parameter
  • value (::String) — Generated query for the given user prompt.
Returns
  • (::String) — Generated query for the given user prompt.

#intent_explanation

def intent_explanation() -> ::String
Returns
  • (::String) — A natural language explanation of the generated query. Populated if options.generate_explanation was true in the request.

#intent_explanation=

def intent_explanation=(value) -> ::String
Parameter
  • value (::String) — A natural language explanation of the generated query. Populated if options.generate_explanation was true in the request.
Returns
  • (::String) — A natural language explanation of the generated query. Populated if options.generate_explanation was true in the request.

#natural_language_answer

def natural_language_answer() -> ::String
Returns
  • (::String) — 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.

#natural_language_answer=

def natural_language_answer=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#pipeline_debug_info

def pipeline_debug_info() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Detailed step-by-step pipeline execution information. Populated only if generation_options.generate_debug_info was true. Provided for debugging and transparency purposes only. The structure and content of this object is not guaranteed and may change at any time without notice. Do not write production code or business logic depending on the fields in this object.

#pipeline_debug_info=

def pipeline_debug_info=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Detailed step-by-step pipeline execution information. Populated only if generation_options.generate_debug_info was true. Provided for debugging and transparency purposes only. The structure and content of this object is not guaranteed and may change at any time without notice. Do not write production code or business logic depending on the fields in this object.
Returns
  • (::Google::Protobuf::Struct) — Detailed step-by-step pipeline execution information. Populated only if generation_options.generate_debug_info was true. Provided for debugging and transparency purposes only. The structure and content of this object is not guaranteed and may change at any time without notice. Do not write production code or business logic depending on the fields in this object.

#query_result

def query_result() -> ::Google::Cloud::GeminiDataAnalytics::V1beta::ExecutedQueryResult
Returns

#query_result=

def query_result=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1beta::ExecutedQueryResult
Parameter
Returns

#token_usage

def token_usage() -> ::Google::Cloud::GeminiDataAnalytics::V1beta::TokenUsage
Returns

#token_usage=

def token_usage=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1beta::TokenUsage
Parameter
Returns