Reference documentation and code samples for the Data Analytics API with Gemini V1 API class Google::Cloud::GeminiDataAnalytics::V1::Context.
A collection of context to apply to this conversation
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#datasource_references
def datasource_references() -> ::Google::Cloud::GeminiDataAnalytics::V1::DatasourceReferences
Returns
- (::Google::Cloud::GeminiDataAnalytics::V1::DatasourceReferences) — Required. Data sources that are available for answering the question.
#datasource_references=
def datasource_references=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::DatasourceReferences
Parameter
- value (::Google::Cloud::GeminiDataAnalytics::V1::DatasourceReferences) — Required. Data sources that are available for answering the question.
Returns
- (::Google::Cloud::GeminiDataAnalytics::V1::DatasourceReferences) — Required. Data sources that are available for answering the question.
#example_queries
def example_queries() -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::ExampleQuery>
Returns
- (::Array<::Google::Cloud::GeminiDataAnalytics::V1::ExampleQuery>) — 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 and databases (alloydb, cloudsql, spanner) data sources.
#example_queries=
def example_queries=(value) -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::ExampleQuery>
Parameter
- value (::Array<::Google::Cloud::GeminiDataAnalytics::V1::ExampleQuery>) — 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 and databases (alloydb, cloudsql, spanner) data sources.
Returns
- (::Array<::Google::Cloud::GeminiDataAnalytics::V1::ExampleQuery>) — 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 and databases (alloydb, cloudsql, spanner) data sources.
#glossary_terms
def glossary_terms() -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::GlossaryTerm>
Returns
- (::Array<::Google::Cloud::GeminiDataAnalytics::V1::GlossaryTerm>) — Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.
#glossary_terms=
def glossary_terms=(value) -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::GlossaryTerm>
Parameter
- value (::Array<::Google::Cloud::GeminiDataAnalytics::V1::GlossaryTerm>) — Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.
Returns
- (::Array<::Google::Cloud::GeminiDataAnalytics::V1::GlossaryTerm>) — Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.
#looker_golden_queries
def looker_golden_queries() -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::LookerGoldenQuery>
Returns
- (::Array<::Google::Cloud::GeminiDataAnalytics::V1::LookerGoldenQuery>) — Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.
#looker_golden_queries=
def looker_golden_queries=(value) -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::LookerGoldenQuery>
Parameter
- value (::Array<::Google::Cloud::GeminiDataAnalytics::V1::LookerGoldenQuery>) — Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.
Returns
- (::Array<::Google::Cloud::GeminiDataAnalytics::V1::LookerGoldenQuery>) — Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.
#options
def options() -> ::Google::Cloud::GeminiDataAnalytics::V1::ConversationOptions
Returns
- (::Google::Cloud::GeminiDataAnalytics::V1::ConversationOptions) — Optional. Additional options for the conversation.
#options=
def options=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::ConversationOptions
Parameter
- value (::Google::Cloud::GeminiDataAnalytics::V1::ConversationOptions) — Optional. Additional options for the conversation.
Returns
- (::Google::Cloud::GeminiDataAnalytics::V1::ConversationOptions) — Optional. Additional options for the conversation.
#schema_relationships
def schema_relationships() -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::Context::SchemaRelationship>
Returns
- (::Array<::Google::Cloud::GeminiDataAnalytics::V1::Context::SchemaRelationship>) — Optional. Relationships between table schema, including referencing and referenced columns.
#schema_relationships=
def schema_relationships=(value) -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::Context::SchemaRelationship>
Parameter
- value (::Array<::Google::Cloud::GeminiDataAnalytics::V1::Context::SchemaRelationship>) — Optional. Relationships between table schema, including referencing and referenced columns.
Returns
- (::Array<::Google::Cloud::GeminiDataAnalytics::V1::Context::SchemaRelationship>) — Optional. Relationships between table schema, including referencing and referenced columns.
#system_instruction
def system_instruction() -> ::String
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.
#system_instruction=
def system_instruction=(value) -> ::String
Parameter
-
value (::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.
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.
#user_functions
def user_functions() -> ::Google::Cloud::GeminiDataAnalytics::V1::UserFunctions
Returns
- (::Google::Cloud::GeminiDataAnalytics::V1::UserFunctions) — Optional. A collection of user functions to be included in context.
#user_functions=
def user_functions=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::UserFunctions
Parameter
- value (::Google::Cloud::GeminiDataAnalytics::V1::UserFunctions) — Optional. A collection of user functions to be included in context.
Returns
- (::Google::Cloud::GeminiDataAnalytics::V1::UserFunctions) — Optional. A collection of user functions to be included in context.