Interface ContextOrBuilder (0.9.0)

public interface ContextOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDatasourceReferences()

public abstract DatasourceReferences getDatasourceReferences()

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

.google.cloud.geminidataanalytics.v1beta.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatasourceReferences

The datasourceReferences.

getDatasourceReferencesOrBuilder()

public abstract DatasourceReferencesOrBuilder getDatasourceReferencesOrBuilder()

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

.google.cloud.geminidataanalytics.v1beta.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatasourceReferencesOrBuilder

getExampleQueries(int index)

public abstract ExampleQuery getExampleQueries(int index)

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.

repeated .google.cloud.geminidataanalytics.v1beta.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ExampleQuery

getExampleQueriesCount()

public abstract int getExampleQueriesCount()

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.

repeated .google.cloud.geminidataanalytics.v1beta.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getExampleQueriesList()

public abstract List<ExampleQuery> getExampleQueriesList()

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.

repeated .google.cloud.geminidataanalytics.v1beta.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ExampleQuery>

getExampleQueriesOrBuilder(int index)

public abstract ExampleQueryOrBuilder getExampleQueriesOrBuilder(int index)

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.

repeated .google.cloud.geminidataanalytics.v1beta.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ExampleQueryOrBuilder

getExampleQueriesOrBuilderList()

public abstract List<? extends ExampleQueryOrBuilder> getExampleQueriesOrBuilderList()

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.

repeated .google.cloud.geminidataanalytics.v1beta.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1beta.ExampleQueryOrBuilder>

getGlossaryTerms(int index)

public abstract GlossaryTerm getGlossaryTerms(int index)

Optional. Term definitions (currently, only user authored)

repeated .google.cloud.geminidataanalytics.v1beta.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
GlossaryTerm

getGlossaryTermsCount()

public abstract int getGlossaryTermsCount()

Optional. Term definitions (currently, only user authored)

repeated .google.cloud.geminidataanalytics.v1beta.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getGlossaryTermsList()

public abstract List<GlossaryTerm> getGlossaryTermsList()

Optional. Term definitions (currently, only user authored)

repeated .google.cloud.geminidataanalytics.v1beta.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<GlossaryTerm>

getGlossaryTermsOrBuilder(int index)

public abstract GlossaryTermOrBuilder getGlossaryTermsOrBuilder(int index)

Optional. Term definitions (currently, only user authored)

repeated .google.cloud.geminidataanalytics.v1beta.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
GlossaryTermOrBuilder

getGlossaryTermsOrBuilderList()

public abstract List<? extends GlossaryTermOrBuilder> getGlossaryTermsOrBuilderList()

Optional. Term definitions (currently, only user authored)

repeated .google.cloud.geminidataanalytics.v1beta.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1beta.GlossaryTermOrBuilder>

getOptions()

public abstract ConversationOptions getOptions()

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1beta.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationOptions

The options.

getOptionsOrBuilder()

public abstract ConversationOptionsOrBuilder getOptionsOrBuilder()

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1beta.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationOptionsOrBuilder

getSchemaRelationships(int index)

public abstract Context.SchemaRelationship getSchemaRelationships(int index)

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

repeated .google.cloud.geminidataanalytics.v1beta.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.SchemaRelationship

getSchemaRelationshipsCount()

public abstract int getSchemaRelationshipsCount()

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

repeated .google.cloud.geminidataanalytics.v1beta.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSchemaRelationshipsList()

public abstract List<Context.SchemaRelationship> getSchemaRelationshipsList()

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

repeated .google.cloud.geminidataanalytics.v1beta.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SchemaRelationship>

getSchemaRelationshipsOrBuilder(int index)

public abstract Context.SchemaRelationshipOrBuilder getSchemaRelationshipsOrBuilder(int index)

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

repeated .google.cloud.geminidataanalytics.v1beta.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.SchemaRelationshipOrBuilder

getSchemaRelationshipsOrBuilderList()

public abstract List<? extends Context.SchemaRelationshipOrBuilder> getSchemaRelationshipsOrBuilderList()

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

repeated .google.cloud.geminidataanalytics.v1beta.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1beta.Context.SchemaRelationshipOrBuilder>

getSystemInstruction()

public abstract String 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.

string system_instruction = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The systemInstruction.

getSystemInstructionBytes()

public abstract ByteString getSystemInstructionBytes()

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.

string system_instruction = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for systemInstruction.

hasDatasourceReferences()

public abstract boolean hasDatasourceReferences()

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

.google.cloud.geminidataanalytics.v1beta.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the datasourceReferences field is set.

hasOptions()

public abstract boolean hasOptions()

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1beta.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the options field is set.