Interface ChatRequestOrBuilder (0.21.0) 

public interface ChatRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getClientManagedResourceContext()

public abstract ClientManagedResourceContext getClientManagedResourceContext()

Optional. Context with client managed resources. Some clients may not use GDA managed resources including conversations and agents, instead they create and manage their own conversations and agents resources.

.google.cloud.geminidataanalytics.v1.ClientManagedResourceContext client_managed_resource_context = 105 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientManagedResourceContext

The clientManagedResourceContext.

getClientManagedResourceContextOrBuilder()

public abstract ClientManagedResourceContextOrBuilder getClientManagedResourceContextOrBuilder()

Optional. Context with client managed resources. Some clients may not use GDA managed resources including conversations and agents, instead they create and manage their own conversations and agents resources.

.google.cloud.geminidataanalytics.v1.ClientManagedResourceContext client_managed_resource_context = 105 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientManagedResourceContextOrBuilder

getContextProviderCase()

public abstract ChatRequest.ContextProviderCase getContextProviderCase()
Returns
Type Description
ChatRequest.ContextProviderCase

getConversationReference()

public abstract ConversationReference getConversationReference()

Optional. Reference to a persisted conversation and agent context. Use this to chat with an Agent using managed conversation persistence.

.google.cloud.geminidataanalytics.v1.ConversationReference conversation_reference = 103 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationReference

The conversationReference.

getConversationReferenceOrBuilder()

public abstract ConversationReferenceOrBuilder getConversationReferenceOrBuilder()

Optional. Reference to a persisted conversation and agent context. Use this to chat with an Agent using managed conversation persistence.

.google.cloud.geminidataanalytics.v1.ConversationReference conversation_reference = 103 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationReferenceOrBuilder

getCredentials()

public abstract Credentials getCredentials()

Optional. The credentials to use when calling the data source(s) specified in the context.

This field can be used to provide credentials for various data sources. For example, when connecting to Looker, it currently supports both OAuth token and API key-based credentials, as described in Authentication with an SDK.

.google.cloud.geminidataanalytics.v1.Credentials credentials = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Credentials

The credentials.

getCredentialsOrBuilder()

public abstract CredentialsOrBuilder getCredentialsOrBuilder()

Optional. The credentials to use when calling the data source(s) specified in the context.

This field can be used to provide credentials for various data sources. For example, when connecting to Looker, it currently supports both OAuth token and API key-based credentials, as described in Authentication with an SDK.

.google.cloud.geminidataanalytics.v1.Credentials credentials = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CredentialsOrBuilder

getDataAgentContext()

public abstract DataAgentContext getDataAgentContext()

Optional. Context for the chat request. Use this to chat with an Agent statelessly, without managed conversation persistence.

.google.cloud.geminidataanalytics.v1.DataAgentContext data_agent_context = 104 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataAgentContext

The dataAgentContext.

getDataAgentContextOrBuilder()

public abstract DataAgentContextOrBuilder getDataAgentContextOrBuilder()

Optional. Context for the chat request. Use this to chat with an Agent statelessly, without managed conversation persistence.

.google.cloud.geminidataanalytics.v1.DataAgentContext data_agent_context = 104 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataAgentContextOrBuilder

getDatasourceSettingsCase()

public abstract ChatRequest.DatasourceSettingsCase getDatasourceSettingsCase()
Returns
Type Description
ChatRequest.DatasourceSettingsCase

getInlineContext()

public abstract Context getInlineContext()

Optional. Inline context for the chat request. Use this to chat statelessly (without managed conversation persistence and without an Agent) by passing all context inline.

.google.cloud.geminidataanalytics.v1.Context inline_context = 101 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context

The inlineContext.

getInlineContextOrBuilder()

public abstract ContextOrBuilder getInlineContextOrBuilder()

Optional. Inline context for the chat request. Use this to chat statelessly (without managed conversation persistence and without an Agent) by passing all context inline.

.google.cloud.geminidataanalytics.v1.Context inline_context = 101 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ContextOrBuilder

getLookerSettings()

public abstract LookerSettings getLookerSettings()

Optional. Looker specific settings.

.google.cloud.geminidataanalytics.v1.LookerSettings looker_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LookerSettings

The lookerSettings.

getLookerSettingsOrBuilder()

public abstract LookerSettingsOrBuilder getLookerSettingsOrBuilder()

Optional. Looker specific settings.

.google.cloud.geminidataanalytics.v1.LookerSettings looker_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LookerSettingsOrBuilder

getMessages(int index)

public abstract Message getMessages(int index)

Required. Content of current conversation.

repeated .google.cloud.geminidataanalytics.v1.Message messages = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Message

getMessagesCount()

public abstract int getMessagesCount()

Required. Content of current conversation.

repeated .google.cloud.geminidataanalytics.v1.Message messages = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getMessagesList()

public abstract List<Message> getMessagesList()

Required. Content of current conversation.

repeated .google.cloud.geminidataanalytics.v1.Message messages = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Message>

getMessagesOrBuilder(int index)

public abstract MessageOrBuilder getMessagesOrBuilder(int index)

Required. Content of current conversation.

repeated .google.cloud.geminidataanalytics.v1.Message messages = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
MessageOrBuilder

getMessagesOrBuilderList()

public abstract List<? extends MessageOrBuilder> getMessagesOrBuilderList()

Required. Content of current conversation.

repeated .google.cloud.geminidataanalytics.v1.Message messages = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1.MessageOrBuilder>

getModel()

public abstract ChatRequest.Model getModel()

Optional. The model to use for the agent loop when processing the request. This setting only has an effect when context.options.model is not set.

.google.cloud.geminidataanalytics.v1.ChatRequest.Model model = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ChatRequest.Model

The model.

getModelValue()

public abstract int getModelValue()

Optional. The model to use for the agent loop when processing the request. This setting only has an effect when context.options.model is not set.

.google.cloud.geminidataanalytics.v1.ChatRequest.Model model = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for model.

getParent()

public abstract String getParent()

Required. The parent value for chat request. Pattern: projects/{project}/locations/{location}

string parent = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent value for chat request. Pattern: projects/{project}/locations/{location}

string parent = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getThinkingMode()

public abstract ChatRequest.ThinkingMode getThinkingMode()

Optional. The thinking mode to use for the agent loop. Defaults to THINKING_MODE_UNSPECIFIED if not specified.

.google.cloud.geminidataanalytics.v1.ChatRequest.ThinkingMode thinking_mode = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ChatRequest.ThinkingMode

The thinkingMode.

getThinkingModeValue()

public abstract int getThinkingModeValue()

Optional. The thinking mode to use for the agent loop. Defaults to THINKING_MODE_UNSPECIFIED if not specified.

.google.cloud.geminidataanalytics.v1.ChatRequest.ThinkingMode thinking_mode = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for thinkingMode.

hasClientManagedResourceContext()

public abstract boolean hasClientManagedResourceContext()

Optional. Context with client managed resources. Some clients may not use GDA managed resources including conversations and agents, instead they create and manage their own conversations and agents resources.

.google.cloud.geminidataanalytics.v1.ClientManagedResourceContext client_managed_resource_context = 105 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the clientManagedResourceContext field is set.

hasConversationReference()

public abstract boolean hasConversationReference()

Optional. Reference to a persisted conversation and agent context. Use this to chat with an Agent using managed conversation persistence.

.google.cloud.geminidataanalytics.v1.ConversationReference conversation_reference = 103 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the conversationReference field is set.

hasCredentials()

public abstract boolean hasCredentials()

Optional. The credentials to use when calling the data source(s) specified in the context.

This field can be used to provide credentials for various data sources. For example, when connecting to Looker, it currently supports both OAuth token and API key-based credentials, as described in Authentication with an SDK.

.google.cloud.geminidataanalytics.v1.Credentials credentials = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the credentials field is set.

hasDataAgentContext()

public abstract boolean hasDataAgentContext()

Optional. Context for the chat request. Use this to chat with an Agent statelessly, without managed conversation persistence.

.google.cloud.geminidataanalytics.v1.DataAgentContext data_agent_context = 104 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataAgentContext field is set.

hasInlineContext()

public abstract boolean hasInlineContext()

Optional. Inline context for the chat request. Use this to chat statelessly (without managed conversation persistence and without an Agent) by passing all context inline.

.google.cloud.geminidataanalytics.v1.Context inline_context = 101 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inlineContext field is set.

hasLookerSettings()

public abstract boolean hasLookerSettings()

Optional. Looker specific settings.

.google.cloud.geminidataanalytics.v1.LookerSettings looker_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the lookerSettings field is set.