Class: Google::Cloud::DataQnA::V1alpha::InterpretationStructure

Inherits:

Object

Object
Google::Cloud::DataQnA::V1alpha::InterpretationStructure

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/dataqna/v1alpha/question.rb

Overview

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

Defined Under Namespace

Modules: VisualizationType Classes: ColumnInfo

Instance Attribute Summary collapse

#column_info ⇒ ::Array<::Google::Cloud::DataQnA::V1alpha::InterpretationStructure::ColumnInfo>
Information about the output columns, that is, the columns that will be returned by the backend.
#visualization_types ⇒ ::Array<::Google::Cloud::DataQnA::V1alpha::InterpretationStructure::VisualizationType>
List of possible visualization types to apply for this interpretation.

Instance Attribute Details

#column_info ⇒ `::Array<::Google::Cloud::DataQnA::V1alpha::InterpretationStructure::ColumnInfo>`

Information about the output columns, that is, the columns that will be returned by the backend.

Returns:

(::Array<::Google::Cloud::DataQnA::V1alpha::InterpretationStructure::ColumnInfo>) —
Information about the output columns, that is, the columns that will be returned by the backend.

# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 280

class InterpretationStructure
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Information about a column.
  # @!attribute [rw] output_alias
  #   @return [::String]
  #     The alias of the output column as used by the backend. For example, the
  #     field name in the schema provided in the query response in BigQuery.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Human readable name of the output column.
  class ColumnInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of visualzation types to use for query response data.
  module VisualizationType
    # No visualization type was specified.
    VISUALIZATION_TYPE_UNSPECIFIED = 0

    # Show a table.
    TABLE = 1

    # Show a [bar
    # chart](https://developers.google.com/chart/interactive/docs/gallery/barchart).
    BAR_CHART = 2

    # Show a [column
    # chart](https://developers.google.com/chart/interactive/docs/gallery/columnchart).
    COLUMN_CHART = 3

    # Show a
    # [timeline](https://developers.google.com/chart/interactive/docs/gallery/timeline).
    TIMELINE = 4

    # Show a [scatter
    # plot](https://developers.google.com/chart/interactive/docs/gallery/scatterchart).
    SCATTER_PLOT = 5

    # Show a [pie
    # chart](https://developers.google.com/chart/interactive/docs/gallery/piechart).
    PIE_CHART = 6

    # Show a [line
    # chart](https://developers.google.com/chart/interactive/docs/gallery/linechart).
    LINE_CHART = 7

    # Show an [area
    # chart](https://developers.google.com/chart/interactive/docs/gallery/areachart).
    AREA_CHART = 8

    # Show a [combo
    # chart](https://developers.google.com/chart/interactive/docs/gallery/combochart).
    COMBO_CHART = 9

    # Show a
    # [histogram](https://developers.google.com/chart/interactive/docs/gallery/histogram).
    HISTOGRAM = 10

    # 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.
    GENERIC_CHART = 11

    # 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.
    CHART_NOT_UNDERSTOOD = 12
  end
end

#visualization_types ⇒ `::Array<::Google::Cloud::DataQnA::V1alpha::InterpretationStructure::VisualizationType>`

Returns List of possible visualization types to apply for this interpretation. The order has no relevance.