Class InterpretationStructure (0.10.9)

InterpretationStructure(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

NameDescription
visualization_types MutableSequence[google.cloud.dataqna_v1alpha.types.InterpretationStructure.VisualizationType]
List of possible visualization types to apply for this interpretation. The order has no relevance.
column_info MutableSequence[google.cloud.dataqna_v1alpha.types.InterpretationStructure.ColumnInfo]
Information about the output columns, that is, the columns that will be returned by the backend.

Classes

ColumnInfo

ColumnInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information about a column.

VisualizationType

VisualizationType(value)

Enumeration of visualzation types to use for query response data.

Values: VISUALIZATION_TYPE_UNSPECIFIED (0): No visualization type was specified. TABLE (1): Show a table. BAR_CHART (2): Show a bar chart <https://developers.google.com/chart/interactive/docs/gallery/barchart>. COLUMN_CHART (3): Show a column chart <https://developers.google.com/chart/interactive/docs/gallery/columnchart>. TIMELINE (4): Show a timeline <https://developers.google.com/chart/interactive/docs/gallery/timeline>. SCATTER_PLOT (5): Show a scatter plot <https://developers.google.com/chart/interactive/docs/gallery/scatterchart>. PIE_CHART (6): Show a pie chart <https://developers.google.com/chart/interactive/docs/gallery/piechart>. LINE_CHART (7): Show a line chart <https://developers.google.com/chart/interactive/docs/gallery/linechart>. AREA_CHART (8): Show an area chart <https://developers.google.com/chart/interactive/docs/gallery/areachart>. COMBO_CHART (9): Show a combo chart <https://developers.google.com/chart/interactive/docs/gallery/combochart>. HISTOGRAM (10): Show a histogram <https://developers.google.com/chart/interactive/docs/gallery/histogram>__. GENERIC_CHART (11): This denotes queries when the user has not specified the particular type of chart and has mentioned only a generic chart name such as "Chart", "Plot", "Graph", etc. This will differentiate it from specific charting terms such as "Bar chart", "Pie chart", etc. CHART_NOT_UNDERSTOOD (12): The user tried to specify a chart type, but the interpreter could not understand the type. The client should display a generic chart and may give a hint to the user that the requested type was not understood.