Class: Google::Cloud::GeminiDataAnalytics::V1beta::Context

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/geminidataanalytics/v1beta/context.rb

Overview

A collection of context to apply to this conversation

Defined Under Namespace

Classes: SchemaRelationship

Instance Attribute Summary collapse

Instance Attribute Details

#datasource_references ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::DatasourceReferences

Returns Required. Data sources that are available for answering the question.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/geminidataanalytics/v1beta/context.rb', line 51

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

  # The relationship between two tables, including referencing and referenced
  # columns. This is a derived context retrieved from Dataplex Dataset
  # Insights.
  # @!attribute [rw] left_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the first table.
  #     The size of this list must be the same as `right_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `right_schema_paths` list.
  # @!attribute [rw] right_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the second table.
  #     The size of this list must be the same as `left_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `left_schema_paths` list.
  # @!attribute [rw] sources
  #   @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::Source>]
  #     Sources which generated the schema relation edge.
  # @!attribute [rw] confidence_score
  #   @return [::Float]
  #     A confidence score for the suggested relationship.
  #     Manually added edges have the highest confidence score.
  class SchemaRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an ordered set of paths within the table schema.
    # @!attribute [rw] table_fqn
    #   @return [::String]
    #     The service-qualified full resource name of the table
    #     Ex:
    #     bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
    # @!attribute [rw] paths
    #   @return [::Array<::String>]
    #     The ordered list of paths within the table schema.
    class SchemaPaths
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Source which generated the schema relation edge.
    module Source
      # The source of the schema relationship is unspecified.
      SOURCE_UNSPECIFIED = 0

      # The source of the schema relationship is BigQuery job history.
      BIGQUERY_JOB_HISTORY = 1

      # The source of the schema relationship is LLM suggested.
      LLM_SUGGESTED = 2

      # The source of the schema relationship is BigQuery table constraints.
      BIGQUERY_TABLE_CONSTRAINTS = 3
    end
  end
end

#example_queries ⇒ ::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::ExampleQuery>

Returns Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/geminidataanalytics/v1beta/context.rb', line 51

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

  # The relationship between two tables, including referencing and referenced
  # columns. This is a derived context retrieved from Dataplex Dataset
  # Insights.
  # @!attribute [rw] left_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the first table.
  #     The size of this list must be the same as `right_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `right_schema_paths` list.
  # @!attribute [rw] right_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the second table.
  #     The size of this list must be the same as `left_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `left_schema_paths` list.
  # @!attribute [rw] sources
  #   @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::Source>]
  #     Sources which generated the schema relation edge.
  # @!attribute [rw] confidence_score
  #   @return [::Float]
  #     A confidence score for the suggested relationship.
  #     Manually added edges have the highest confidence score.
  class SchemaRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an ordered set of paths within the table schema.
    # @!attribute [rw] table_fqn
    #   @return [::String]
    #     The service-qualified full resource name of the table
    #     Ex:
    #     bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
    # @!attribute [rw] paths
    #   @return [::Array<::String>]
    #     The ordered list of paths within the table schema.
    class SchemaPaths
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Source which generated the schema relation edge.
    module Source
      # The source of the schema relationship is unspecified.
      SOURCE_UNSPECIFIED = 0

      # The source of the schema relationship is BigQuery job history.
      BIGQUERY_JOB_HISTORY = 1

      # The source of the schema relationship is LLM suggested.
      LLM_SUGGESTED = 2

      # The source of the schema relationship is BigQuery table constraints.
      BIGQUERY_TABLE_CONSTRAINTS = 3
    end
  end
end

#glossary_terms ⇒ ::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::GlossaryTerm>

Returns Optional. Term definitions (currently, only user authored).

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/geminidataanalytics/v1beta/context.rb', line 51

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

  # The relationship between two tables, including referencing and referenced
  # columns. This is a derived context retrieved from Dataplex Dataset
  # Insights.
  # @!attribute [rw] left_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the first table.
  #     The size of this list must be the same as `right_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `right_schema_paths` list.
  # @!attribute [rw] right_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the second table.
  #     The size of this list must be the same as `left_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `left_schema_paths` list.
  # @!attribute [rw] sources
  #   @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::Source>]
  #     Sources which generated the schema relation edge.
  # @!attribute [rw] confidence_score
  #   @return [::Float]
  #     A confidence score for the suggested relationship.
  #     Manually added edges have the highest confidence score.
  class SchemaRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an ordered set of paths within the table schema.
    # @!attribute [rw] table_fqn
    #   @return [::String]
    #     The service-qualified full resource name of the table
    #     Ex:
    #     bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
    # @!attribute [rw] paths
    #   @return [::Array<::String>]
    #     The ordered list of paths within the table schema.
    class SchemaPaths
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Source which generated the schema relation edge.
    module Source
      # The source of the schema relationship is unspecified.
      SOURCE_UNSPECIFIED = 0

      # The source of the schema relationship is BigQuery job history.
      BIGQUERY_JOB_HISTORY = 1

      # The source of the schema relationship is LLM suggested.
      LLM_SUGGESTED = 2

      # The source of the schema relationship is BigQuery table constraints.
      BIGQUERY_TABLE_CONSTRAINTS = 3
    end
  end
end

#options ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::ConversationOptions

Returns Optional. Additional options for the conversation.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/geminidataanalytics/v1beta/context.rb', line 51

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

  # The relationship between two tables, including referencing and referenced
  # columns. This is a derived context retrieved from Dataplex Dataset
  # Insights.
  # @!attribute [rw] left_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the first table.
  #     The size of this list must be the same as `right_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `right_schema_paths` list.
  # @!attribute [rw] right_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the second table.
  #     The size of this list must be the same as `left_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `left_schema_paths` list.
  # @!attribute [rw] sources
  #   @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::Source>]
  #     Sources which generated the schema relation edge.
  # @!attribute [rw] confidence_score
  #   @return [::Float]
  #     A confidence score for the suggested relationship.
  #     Manually added edges have the highest confidence score.
  class SchemaRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an ordered set of paths within the table schema.
    # @!attribute [rw] table_fqn
    #   @return [::String]
    #     The service-qualified full resource name of the table
    #     Ex:
    #     bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
    # @!attribute [rw] paths
    #   @return [::Array<::String>]
    #     The ordered list of paths within the table schema.
    class SchemaPaths
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Source which generated the schema relation edge.
    module Source
      # The source of the schema relationship is unspecified.
      SOURCE_UNSPECIFIED = 0

      # The source of the schema relationship is BigQuery job history.
      BIGQUERY_JOB_HISTORY = 1

      # The source of the schema relationship is LLM suggested.
      LLM_SUGGESTED = 2

      # The source of the schema relationship is BigQuery table constraints.
      BIGQUERY_TABLE_CONSTRAINTS = 3
    end
  end
end

#schema_relationships ⇒ ::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship>

Returns Optional. Relationships between table schema, including referencing and referenced columns.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/geminidataanalytics/v1beta/context.rb', line 51

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

  # The relationship between two tables, including referencing and referenced
  # columns. This is a derived context retrieved from Dataplex Dataset
  # Insights.
  # @!attribute [rw] left_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the first table.
  #     The size of this list must be the same as `right_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `right_schema_paths` list.
  # @!attribute [rw] right_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the second table.
  #     The size of this list must be the same as `left_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `left_schema_paths` list.
  # @!attribute [rw] sources
  #   @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::Source>]
  #     Sources which generated the schema relation edge.
  # @!attribute [rw] confidence_score
  #   @return [::Float]
  #     A confidence score for the suggested relationship.
  #     Manually added edges have the highest confidence score.
  class SchemaRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an ordered set of paths within the table schema.
    # @!attribute [rw] table_fqn
    #   @return [::String]
    #     The service-qualified full resource name of the table
    #     Ex:
    #     bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
    # @!attribute [rw] paths
    #   @return [::Array<::String>]
    #     The ordered list of paths within the table schema.
    class SchemaPaths
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Source which generated the schema relation edge.
    module Source
      # The source of the schema relationship is unspecified.
      SOURCE_UNSPECIFIED = 0

      # The source of the schema relationship is BigQuery job history.
      BIGQUERY_JOB_HISTORY = 1

      # The source of the schema relationship is LLM suggested.
      LLM_SUGGESTED = 2

      # The source of the schema relationship is BigQuery table constraints.
      BIGQUERY_TABLE_CONSTRAINTS = 3
    end
  end
end

#system_instruction ⇒ ::String

Returns Optional. The basic entry point for data owners creating domain knowledge for Agent.

Why: Business jargon (e.g., YTD revenue is calculated as…, Retirement Age is 65 in the USA, etc) and system instructions (e.g., answer like a Pirate) can help the model understand the business context around a user question.

Returns:

  • (::String) —

    Optional. The basic entry point for data owners creating domain knowledge for Agent.

    Why: Business jargon (e.g., YTD revenue is calculated as…, Retirement Age is 65 in the USA, etc) and system instructions (e.g., answer like a Pirate) can help the model understand the business context around a user question.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/geminidataanalytics/v1beta/context.rb', line 51

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

  # The relationship between two tables, including referencing and referenced
  # columns. This is a derived context retrieved from Dataplex Dataset
  # Insights.
  # @!attribute [rw] left_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the first table.
  #     The size of this list must be the same as `right_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `right_schema_paths` list.
  # @!attribute [rw] right_schema_paths
  #   @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::SchemaPaths]
  #     An ordered list of fields for the join from the second table.
  #     The size of this list must be the same as `left_schema_paths`.
  #     Each field at index i in this list must correspond to a field at the same
  #     index in the `left_schema_paths` list.
  # @!attribute [rw] sources
  #   @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::Source>]
  #     Sources which generated the schema relation edge.
  # @!attribute [rw] confidence_score
  #   @return [::Float]
  #     A confidence score for the suggested relationship.
  #     Manually added edges have the highest confidence score.
  class SchemaRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an ordered set of paths within the table schema.
    # @!attribute [rw] table_fqn
    #   @return [::String]
    #     The service-qualified full resource name of the table
    #     Ex:
    #     bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
    # @!attribute [rw] paths
    #   @return [::Array<::String>]
    #     The ordered list of paths within the table schema.
    class SchemaPaths
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Source which generated the schema relation edge.
    module Source
      # The source of the schema relationship is unspecified.
      SOURCE_UNSPECIFIED = 0

      # The source of the schema relationship is BigQuery job history.
      BIGQUERY_JOB_HISTORY = 1

      # The source of the schema relationship is LLM suggested.
      LLM_SUGGESTED = 2

      # The source of the schema relationship is BigQuery table constraints.
      BIGQUERY_TABLE_CONSTRAINTS = 3
    end
  end
end