Method: projects.locations.chat

產生 Message 物件串流,回答資料相關問題。

HTTP 要求

POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}:chat

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標,即時通訊要求的父項值。圖案:projects/{project}/locations/{location}

要求主體

要求主體包含下列結構的資料:

JSON 表示法
{
  "project": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "credentials": {
    object (Credentials)
  },
  "thinkingMode": enum (ThinkingMode),
  "model": enum (Model),

  // Union field context_provider can be only one of the following:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of list of possible types for union field context_provider.

  // Union field datasource_settings can be only one of the following:
  "lookerSettings": {
    object (LookerSettings)
  }
  // End of list of possible types for union field datasource_settings.
}
欄位
project
(deprecated)

string

選用。已淘汰:請改用 parent 欄位。用於配額和帳單的 Google Cloud 專案。

messages[]

object (Message)

這是必要旗標,當前對話的內容。

credentials

object (Credentials)

選用。呼叫內容中指定的資料來源時要使用的憑證。

這個欄位可用於提供各種資料來源的憑證。舉例來說,連線至 Looker 時,目前支援 OAuth 權杖和 API 金鑰型憑證,如「使用 SDK 進行驗證」一文所述。

thinkingMode

enum (ThinkingMode)

選用。代理迴圈要使用的思考模式。如未指定,則預設為 THINKING_MODE_UNSPECIFIED。

model

enum (Model)

選用。處理要求時,用於代理程式迴圈的模型。只有在未設定 context.options.model 時,這項設定才會生效。

聯集欄位 context_provider。即時通訊要求的脈絡供應者。可以是 inline_context (要求中提供的內嵌背景資訊)、data_agent (資料代理程式資源的參照),或是 conversation_reference (使用 conversation_id 和 agent_id 參照持續性對話和背景資訊)。context_provider 只能是下列其中一個設定:
inlineContext

object (Context)

選用。即時通訊要求的內嵌脈絡。您可以透過內嵌傳遞所有脈絡,使用這項功能進行無狀態對話 (不含受管理的對話持續性,也不含代理程式)。

conversationReference

object (ConversationReference)

選用。參照持續進行的對話和代理程式脈絡。使用這項功能,透過受管理對話持續性與服務專員進行即時通訊。

dataAgentContext

object (DataAgentContext)

選用。即時通訊要求的背景資訊。使用這項功能與代理程式進行無狀態對話,不必管理對話保留時間。

clientManagedResourceContext

object (ClientManagedResourceContext)

選用。使用用戶端管理的資源時,部分客戶可能不會使用 GDA 管理的資源 (包括對話和代理程式),而是自行建立及管理對話和代理程式資源。

聯集欄位 datasource_settings。可自訂要求行為的選用設定,適用於目標資料來源。datasource_settings 只能是下列其中一個設定:
lookerSettings

object (LookerSettings)

選用。Looker 專屬設定。

回應主體

如果成功,回應主體會包含 Message 例項的串流。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱Authentication Overview

ConversationReference

參照持續進行的對話和代理程式脈絡。

JSON 表示法
{
  "conversation": string,
  "dataAgentContext": {
    object (DataAgentContext)
  }
}
欄位
conversation

string

這是必要旗標,對話資源的名稱。格式:projects/{project}/locations/{location}/conversations/{conversationId}

dataAgentContext

object (DataAgentContext)

這是必要旗標,使用資料代理程式的對話要求背景資訊。

DataAgentContext

使用資料代理程式的對話要求背景資訊。

JSON 表示法
{
  "dataAgent": string,
  "credentials": {
    object (Credentials)
  },
  "contextVersion": enum (ContextVersion)
}
欄位
dataAgent

string

這是必要旗標,資料代理程式資源的名稱。

credentials
(deprecated)

object (Credentials)

選用。已淘汰:請在 ChatRequest 中使用憑證。呼叫 Looker 資料來源時要使用的憑證。

目前支援 OAuth 權杖和 API 金鑰型憑證,詳情請參閱「使用 SDK 進行驗證」。

contextVersion

enum (ContextVersion)

選用。DCS 要使用的內容版本 (例如 STAGING、PUBLISHED)

ContextVersion

DCS 支援的內容版本清單。情境有兩個版本。這是為了維護資料代理程式的版本管理。

列舉
CONTEXT_VERSION_UNSPECIFIED 未指定或無法辨識。
STAGING 使用這個版本時,DCS 會將最新的暫存環境用於資料代理程式。
PUBLISHED 使用這個版本時,DCS 會將最新發布的內容用於資料代理程式。

ClientManagedResourceContext

使用用戶端管理的資源時,部分客戶可能不會使用 GDA 管理的資源 (包括對話和代理程式),而是自行建立及管理對話和代理程式資源。

JSON 表示法
{
  "inlineContext": {
    object (Context)
  },
  "conversationId": string,
  "agentId": string
}
欄位
inlineContext

object (Context)

這是必要旗標,即時通訊要求的背景資訊。使用這個方法,即可傳遞所有內嵌內容,在沒有 GDA API 管理的對話和服務專員持續性下進行即時通訊。

conversationId

string

選用。用戶端管理的對話 ID。

agentId

string

選用。客戶管理的代理商 ID。

LookerSettings

訊息,用於保留 Looker 專屬的自訂設定。

JSON 表示法
{
  "enableDevMode": boolean
}
欄位
enableDevMode

boolean

選用。是否要在 Looker 的開發模式下運作。如果為 true,API 工作階段會切換至「dev」工作區,允許與使用者開發分支中的 LookML 變更互動。如果設為 False 或未設定,工作階段會維持預設狀態 (正式環境模式)。請參閱 https://cloud.google.com/looker/docs/dev-mode-prod-mode

ThinkingMode

代理的思考模式。

列舉
THINKING_MODE_UNSPECIFIED 未指定思考模式,代理程式預設會使用 THINKING 模式,但 BigQuery 使用者預設會使用 FAST 模式。
FAST 快速模式:快速提供答案。
THINKING 思考模式,可解決複雜問題。

型號

BigQuery 使用者可為代理程式選取模型。

列舉
MODEL_UNSPECIFIED 未指定模型。您可以使用預覽版或非預覽版模型。
LATEST_GA_MODEL 使用最新版的非預先發布模型。這可能會限制特定要求層級設定。