Google Cloud Gemini Data Analytics V1 Client - Class Context (0.10.0)

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1 Client class Context.

A collection of context to apply to this conversation

Generated from protobuf message google.cloud.geminidataanalytics.v1.Context

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ system_instruction 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.
↳ datasource_references DatasourceReferences

Required. Data sources that are available for answering the question.
↳ options ConversationOptions

Optional. Additional options for the conversation.
↳ example_queries array<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.
↳ looker_golden_queries array<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.
↳ glossary_terms array<GlossaryTerm>

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.
↳ schema_relationships array<Context\SchemaRelationship>

Optional. Relationships between table schema, including referencing and referenced columns.
↳ user_functions UserFunctions

Optional. A collection of user functions to be included in context.

getSystemInstruction

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
Type Description
string

setSystemInstruction

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDatasourceReferences

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

Returns
Type Description
DatasourceReferences|null

hasDatasourceReferences

clearDatasourceReferences

setDatasourceReferences

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

Parameter
Name Description
var DatasourceReferences
Returns
Type Description
$this

getOptions

Optional. Additional options for the conversation.

Returns
Type Description
ConversationOptions|null

hasOptions

clearOptions

setOptions

Optional. Additional options for the conversation.

Parameter
Name Description
var ConversationOptions
Returns
Type Description
$this

getExampleQueries

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
Type Description
Google\Protobuf\RepeatedField<ExampleQuery>

setExampleQueries

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.

Parameter
Name Description
var array<ExampleQuery>
Returns
Type Description
$this

getLookerGoldenQueries

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
Type Description
Google\Protobuf\RepeatedField<LookerGoldenQuery>

setLookerGoldenQueries

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.

Parameter
Name Description
var array<LookerGoldenQuery>
Returns
Type Description
$this

getGlossaryTerms

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

Returns
Type Description
Google\Protobuf\RepeatedField<GlossaryTerm>

setGlossaryTerms

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

Parameter
Name Description
var array<GlossaryTerm>
Returns
Type Description
$this

getSchemaRelationships

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

Returns
Type Description
Google\Protobuf\RepeatedField<Context\SchemaRelationship>

setSchemaRelationships

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

Parameter
Name Description
var array<Context\SchemaRelationship>
Returns
Type Description
$this

getUserFunctions

Optional. A collection of user functions to be included in context.

Returns
Type Description
UserFunctions|null

hasUserFunctions

clearUserFunctions

setUserFunctions

Optional. A collection of user functions to be included in context.

Parameter
Name Description
var UserFunctions
Returns
Type Description
$this