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 <b>countries</b> by <b>population</b> in <i>Africa</i>"
::
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>__).
CreateQuestionRequest
Request to create a question resource. .. attribute:: parent
Required. The name of the project this data source reference
belongs to. Example: projects/foo/locations/bar
:type: str
DataQuery
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. .. attribute:: include_va_query
Whether to include the original VAQuery.
:type: bool
ExecuteQuestionRequest
Request to execute an interpretation. .. attribute:: name
Required. The unique identifier for the question. Example:
projects/foo/locations/bar/questions/1234
:type: str
ExecutionInfo
Information about the backend status (such as BigQuery) of the execution.
GetQuestionRequest
A request to get a previously created question. .. attribute:: name
Required. The unique identifier for the question. Example:
projects/foo/locations/bar/questions/1234
:type: str
GetUserFeedbackRequest
Request to get user feedback. .. attribute:: name
Required. The unique identifier for the user feedback. User
feedback is a singleton resource on a Question. Example:
projects/foo/locations/bar/questions/1234/userFeedback
:type: str
HumanReadable
Human readable interpretation. .. attribute:: generated_interpretation
Generated query explaining the interpretation.
InterpretEntity
Query entities of an interpretation.
InterpretError
Details on the failure to interpret the question. .. attribute:: message
Error message explaining why this question could not be interpreted.
:type: str
Interpretation
An interpretation of a natural language query. .. attribute:: data_sources
List of data sources used in the current understanding.
:type: Sequence[str]
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.
SuggestQueriesRequest
Request for query suggestions. .. attribute:: parent
Required. The parent of the suggestion query is the resource denoting the project and location.
:type: str
SuggestQueriesResponse
Response to SuggestQueries. .. attribute:: suggestions
A list of suggestions.
:type: Sequence[google.cloud.dataqna_v1alpha.types.Suggestion]
Suggestion
A suggestion for a query with a ranking score. .. attribute:: suggestion_info
Detailed information about the suggestion.
SuggestionInfo
Detailed information about the suggestion. .. attribute:: annotated_suggestion
Annotations for the suggestion. This provides information about which part of the suggestion corresponds to what semantic meaning (e.g. a metric).
SuggestionType
The type of suggestion.
UpdateUserFeedbackRequest
Request to updates user feedback. .. attribute:: user_feedback
Required. The user feedback to update. This can be called even if there is no user feedback so far. The feedback's name field is used to identify the user feedback (and the corresponding question) to update.
UserFeedback
Feedback provided by a user. .. attribute:: name
Required. The unique identifier for the user feedback. User
feedback is a singleton resource on a Question. Example:
projects/foo/locations/bar/questions/1234/userFeedback
:type: str