Data Analytics API with Gemini V1 API - Class Google::Cloud::GeminiDataAnalytics::V1::ChatRequest (v0.1.0)

Reference documentation and code samples for the Data Analytics API with Gemini V1 API class Google::Cloud::GeminiDataAnalytics::V1::ChatRequest.

Request for Chat.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#client_managed_resource_context

def client_managed_resource_context() -> ::Google::Cloud::GeminiDataAnalytics::V1::ClientManagedResourceContext

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::ClientManagedResourceContext) — 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.

  Note: The following fields are mutually exclusive: client_managed_resource_context, inline_context, conversation_reference, data_agent_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#client_managed_resource_context=

def client_managed_resource_context=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::ClientManagedResourceContext

Parameter

• value (::Google::Cloud::GeminiDataAnalytics::V1::ClientManagedResourceContext) — 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.

  Note: The following fields are mutually exclusive: client_managed_resource_context, inline_context, conversation_reference, data_agent_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::ClientManagedResourceContext) — 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.

  Note: The following fields are mutually exclusive: client_managed_resource_context, inline_context, conversation_reference, data_agent_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#conversation_reference

def conversation_reference() -> ::Google::Cloud::GeminiDataAnalytics::V1::ConversationReference

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::ConversationReference) — Optional. Reference to a persisted conversation and agent context. Use this to chat with an Agent using managed conversation persistence.

  Note: The following fields are mutually exclusive: conversation_reference, inline_context, data_agent_context, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#conversation_reference=

def conversation_reference=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::ConversationReference

Parameter

• value (::Google::Cloud::GeminiDataAnalytics::V1::ConversationReference) — Optional. Reference to a persisted conversation and agent context. Use this to chat with an Agent using managed conversation persistence.

  Note: The following fields are mutually exclusive: conversation_reference, inline_context, data_agent_context, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::ConversationReference) — Optional. Reference to a persisted conversation and agent context. Use this to chat with an Agent using managed conversation persistence.

  Note: The following fields are mutually exclusive: conversation_reference, inline_context, data_agent_context, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#credentials

def credentials() -> ::Google::Cloud::GeminiDataAnalytics::V1::Credentials

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::Credentials) — 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.

#credentials=

def credentials=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::Credentials

Parameter

• value (::Google::Cloud::GeminiDataAnalytics::V1::Credentials) — 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.

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::Credentials) — 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.

#data_agent_context

def data_agent_context() -> ::Google::Cloud::GeminiDataAnalytics::V1::DataAgentContext

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::DataAgentContext) — Optional. Context for the chat request. Use this to chat with an Agent statelessly, without managed conversation persistence.

  Note: The following fields are mutually exclusive: data_agent_context, inline_context, conversation_reference, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_agent_context=

def data_agent_context=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::DataAgentContext

Parameter

• value (::Google::Cloud::GeminiDataAnalytics::V1::DataAgentContext) — Optional. Context for the chat request. Use this to chat with an Agent statelessly, without managed conversation persistence.

  Note: The following fields are mutually exclusive: data_agent_context, inline_context, conversation_reference, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::DataAgentContext) — Optional. Context for the chat request. Use this to chat with an Agent statelessly, without managed conversation persistence.

  Note: The following fields are mutually exclusive: data_agent_context, inline_context, conversation_reference, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#inline_context

def inline_context() -> ::Google::Cloud::GeminiDataAnalytics::V1::Context

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::Context) — 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.

  Note: The following fields are mutually exclusive: inline_context, conversation_reference, data_agent_context, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#inline_context=

def inline_context=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::Context

Parameter

• value (::Google::Cloud::GeminiDataAnalytics::V1::Context) — 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.

  Note: The following fields are mutually exclusive: inline_context, conversation_reference, data_agent_context, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::Context) — 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.

  Note: The following fields are mutually exclusive: inline_context, conversation_reference, data_agent_context, client_managed_resource_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#looker_settings

def looker_settings() -> ::Google::Cloud::GeminiDataAnalytics::V1::LookerSettings

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::LookerSettings) — Optional. Looker specific settings.

#looker_settings=

def looker_settings=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::LookerSettings

Parameter

• value (::Google::Cloud::GeminiDataAnalytics::V1::LookerSettings) — Optional. Looker specific settings.

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::LookerSettings) — Optional. Looker specific settings.

#messages

def messages() -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::Message>

Returns

• (::Array<::Google::Cloud::GeminiDataAnalytics::V1::Message>) — Required. Content of current conversation.

#messages=

def messages=(value) -> ::Array<::Google::Cloud::GeminiDataAnalytics::V1::Message>

Parameter

• value (::Array<::Google::Cloud::GeminiDataAnalytics::V1::Message>) — Required. Content of current conversation.

Returns

• (::Array<::Google::Cloud::GeminiDataAnalytics::V1::Message>) — Required. Content of current conversation.

#model

def model() -> ::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::Model

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::Model) — 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.

#model=

def model=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::Model

Parameter

• value (::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::Model) — 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.

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::Model) — 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.

#parent

def parent() -> ::String

Returns

• (::String) — Required. The parent value for chat request. Pattern: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — Required. The parent value for chat request. Pattern: projects/{project}/locations/{location}

Returns

• (::String) — Required. The parent value for chat request. Pattern: projects/{project}/locations/{location}

#thinking_mode

def thinking_mode() -> ::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::ThinkingMode

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::ThinkingMode) — Optional. The thinking mode to use for the agent loop. Defaults to THINKING_MODE_UNSPECIFIED if not specified.

#thinking_mode=

def thinking_mode=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::ThinkingMode

Parameter

• value (::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::ThinkingMode) — Optional. The thinking mode to use for the agent loop. Defaults to THINKING_MODE_UNSPECIFIED if not specified.

Returns

• (::Google::Cloud::GeminiDataAnalytics::V1::ChatRequest::ThinkingMode) — Optional. The thinking mode to use for the agent loop. Defaults to THINKING_MODE_UNSPECIFIED if not specified.