Package types (0.4.0)

API documentation for dataqna_v1alpha.types package.

Classes

AnnotatedString

Describes string annotation from both semantic and formatting perspectives. Example:

User Query:

top countries by population in Africa

0 4 14 17 28 31 37

Table Data:

"country" - dimension
"population" - metric
"Africa" - value in the "continent" column

text_formatted = "top countries by population in Africa"

html_formatted = "top countries by population in Africa"

markups = [ {DIMENSION, 4, 12}, // 'countries' {METRIC, 17, 26}, // 'population' {FILTER, 31, 36} // 'Africa' ]

Note that html formattings for 'DIMENSION' and 'METRIC' are the same, while semantic markups are different.

BigQueryJob

BigQuery job information. This can be used to query the BigQuery API and retrieve the current job's status (using jobs.get <https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get>__).

Representation of the data query for the backend. This is provided for informational purposes only. Clients should not use it to send it to the backend directly, but rather use the execute RPC to trigger the execution. Using the execute RPC is needed in order to track the state of a question and report on it correctly to the data administrators.

DebugFlags

Configuriation of debug flags.

ExecuteQuestionRequest

Request to execute an interpretation.

ExecutionInfo

Information about the backend status (such as BigQuery) of the execution.

GetQuestionRequest

A request to get a previously created question.

GetUserFeedbackRequest

Request to get user feedback.

HumanReadable

Human readable interpretation.

InterpretEntity

Query entities of an interpretation.

InterpretError

Details on the failure to interpret the question.

Interpretation

An interpretation of a natural language query.

InterpretationStructure

Information about the interpretation structure that helps to understand and visualize the response.

Question

The question resource represents a natural language query, its settings, understanding generated by the system, and answer retrieval status. A question cannot be modified.