Class Context (0.1.0)

public final class Context extends GeneratedMessageV3 implements ContextOrBuilder

A collection of context to apply to this conversation

Protobuf type google.cloud.geminidataanalytics.v1beta.Context

Implements

ContextOrBuilder

Static Fields

DATASOURCE_REFERENCES_FIELD_NUMBER

public static final int DATASOURCE_REFERENCES_FIELD_NUMBER
Field Value
Type Description
int

EXAMPLE_QUERIES_FIELD_NUMBER

public static final int EXAMPLE_QUERIES_FIELD_NUMBER
Field Value
Type Description
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

SYSTEM_INSTRUCTION_FIELD_NUMBER

public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Context getDefaultInstance()
Returns
Type Description
Context

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Context.Builder newBuilder()
Returns
Type Description
Context.Builder

newBuilder(Context prototype)

public static Context.Builder newBuilder(Context prototype)
Parameter
Name Description
prototype Context
Returns
Type Description
Context.Builder

parseDelimitedFrom(InputStream input)

public static Context parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Context parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Context parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Context parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Context parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Context parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Context> parser()
Returns
Type Description
Parser<Context>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatasourceReferences()

public 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 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

getDefaultInstanceForType()

public Context getDefaultInstanceForType()
Returns
Type Description
Context

getExampleQueries(int index)

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

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 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.

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

Returns
Type Description
int

getExampleQueriesList()

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

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

Returns
Type Description
List<ExampleQuery>

getExampleQueriesOrBuilder(int index)

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

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 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.

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>

getOptions()

public 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 ConversationOptionsOrBuilder getOptionsOrBuilder()

Optional. Additional options for the conversation.

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

Returns
Type Description
ConversationOptionsOrBuilder

getParserForType()

public Parser<Context> getParserForType()
Returns
Type Description
Parser<Context>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSystemInstruction()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Context.Builder newBuilderForType()
Returns
Type Description
Context.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Context.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Context.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Context.Builder toBuilder()
Returns
Type Description
Context.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException