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 \ V1betaMethods
__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. |
↳ project |
string
Optional. The Google Cloud project to be used for quota and billing. |
↳ parent |
string
Required. The parent value for chat request. Pattern: |
↳ messages |
array<Message>
Required. Content of current conversation. |
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 |
Context
|
| 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 |
ConversationReference|null |
|
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 |
var |
ConversationReference
|
| 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 |
DataAgentContext|null |
|
hasDataAgentContext
setDataAgentContext
Optional. Context for the chat request. Use this to chat with an Agent statelessly, without managed conversation persistence.
| Parameter | |
|---|---|
| Name | Description |
var |
DataAgentContext
|
| 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 |
ClientManagedResourceContext|null |
|
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 |
var |
ClientManagedResourceContext
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProject
Optional. The Google Cloud project to be used for quota and billing.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProject
Optional. 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 |
Google\Protobuf\Internal\RepeatedField |
|
setMessages
Required. Content of current conversation.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Message>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContextProvider
| Returns | |
|---|---|
| Type | Description |
string |
|