Google Cloud Gemini Data Analytics V1beta Client - Class Context (0.4.0)

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

A collection of context to apply to this conversation

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

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

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.

↳ glossary_terms
array< GlossaryTerm >

Optional. Term definitions (currently, only user authored)

↳ schema_relationships
array< Context\SchemaRelationship >

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

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

hasDatasourceReferences

clearDatasourceReferences

setDatasourceReferences

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

Parameter
Name
Description
Returns
Type
Description
$this

getOptions

Optional. Additional options for the conversation.

Returns
Type
Description

hasOptions

clearOptions

setOptions

Optional. Additional options for the conversation.

Parameter
Name
Description
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.

Returns
Type
Description

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.

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

getGlossaryTerms

Optional. Term definitions (currently, only user authored)

Returns
Type
Description

setGlossaryTerms

Optional. Term definitions (currently, only user authored)

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

getSchemaRelationships

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

Returns
Type
Description

setSchemaRelationships

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

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: