Google Cloud Gemini Data Analytics V1beta Client - Class ChatRequest (0.11.0)

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

Request for Chat.

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

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

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

↳ conversation_reference
ConversationReference

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

↳ data_agent_context
DataAgentContext

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

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

↳ looker_settings
LookerSettings

Optional. Looker specific settings.

↳ project
string

Optional. Deprecated: Use parent field instead. The Google Cloud project to be used for quota and billing.

↳ parent
string

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

↳ messages
array< Message >

Required. Content of current conversation.

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

↳ thinking_mode
int

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

↳ model
int

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.

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.

Returns
Type
Description
Context |null

hasInlineContext

setInlineContext

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.

Parameter
Name
Description
var
Returns
Type
Description
$this

getConversationReference

Optional. Reference to a persisted conversation and agent context.

Use this to chat with an Agent using managed conversation persistence.

Returns
Type
Description

hasConversationReference

setConversationReference

Optional. Reference to a persisted conversation and agent context.

Use this to chat with an Agent using managed conversation persistence.

Parameter
Name
Description
Returns
Type
Description
$this

getDataAgentContext

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

Returns
Type
Description

hasDataAgentContext

setDataAgentContext

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

Parameter
Name
Description
Returns
Type
Description
$this

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.

Returns
Type
Description

hasClientManagedResourceContext

setClientManagedResourceContext

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.

Parameter
Name
Description
Returns
Type
Description
$this

getLookerSettings

Optional. Looker specific settings.

Returns
Type
Description

hasLookerSettings

setLookerSettings

Optional. Looker specific settings.

Parameter
Name
Description
Returns
Type
Description
$this

getProject

Optional. Deprecated: Use parent field instead.

The Google Cloud project to be used for quota and billing.

Returns
Type
Description
string

setProject

Optional. Deprecated: Use parent field instead.

The Google Cloud project to be used for quota and billing.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getParent

Required. The parent value for chat request.

Pattern: projects/{project}/locations/{location}

Returns
Type
Description
string

setParent

Required. The parent value for chat request.

Pattern: projects/{project}/locations/{location}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getMessages

Required. Content of current conversation.

Returns
Type
Description

setMessages

Required. Content of current conversation.

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

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 .

Returns
Type
Description
Credentials |null

hasCredentials

clearCredentials

setCredentials

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 .

Parameter
Name
Description
Returns
Type
Description
$this

getThinkingMode

Optional. The thinking mode to use for the agent loop.

Defaults to THINKING_MODE_UNSPECIFIED if not specified.

Returns
Type
Description
int
Enum of type ThinkingMode .

setThinkingMode

Optional. The thinking mode to use for the agent loop.

Defaults to THINKING_MODE_UNSPECIFIED if not specified.

Parameter
Name
Description
var
int

Enum of type ThinkingMode .

Returns
Type
Description
$this

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.

Returns
Type
Description
int
Enum of type Model .

setModel

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.

Parameter
Name
Description
var
int

Enum of type Model .

Returns
Type
Description
$this

getContextProvider

Returns
Type
Description
string

getDatasourceSettings

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: