Method: projects.locations.collections.engines.assistants.assist

協助使用者查詢。

HTTP 要求

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

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

路徑參數

參數
name

string

這是必要旗標，Assistant 的資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

要求主體

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

JSON 表示法 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
欄位
query

object (Query)

選用。目前的使用者查詢。

只有在提供 fileIds 時，系統才支援空白查詢。在這種情況下，系統會根據這些脈絡檔案生成回覆。
session

string

選用。要求使用的工作階段。如果指定，助理就能存取工作階段記錄，並將查詢和答案儲存在該處。

如果將 - 指定為工作階段 ID，或將其留空，系統會建立新的工作階段，並自動產生 ID。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assistSkippingMode

enum (AssistSkippingMode)

選用。判斷助理不會回覆查詢的案例。如果跳過回答，原因會列在 AssistAnswer.assist_skipped_reasons 的 AssistResponse.answer 中。
fileIds[]

string

選用。用於回答要求的檔案 ID。上傳檔案時，系統會在 AddContextFileResponse.file_id 中傳回檔案 ID。
userMetadata

object (AssistUserMetadata)

選用。發起查詢的使用者相關資訊。
languageCode

string

選用。如果語言偵測失敗，系統會使用此語言回覆。無論語言偵測結果為何，動作建立的錯誤訊息都會使用這個語言。
webGroundingEnabled

boolean

選用。如設為 true，則會啟用「以網頁搜尋強化事實基礎」功能。只有在 Assistant.web_grounding_type 為 WEB_GROUNDING_TYPE_GOOGLE_SEARCH 或 WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH 時，這項屬性才會生效。
dataStoreSpecs[]

object (DataStoreSpec)

選用。定義 DataStore 的規格，可在搜尋呼叫中進行篩選，以及這些資料儲存庫的設定。只有在Engine有多個資料儲存庫時，系統才會考慮這項因素。

如果未設定這個欄位，系統會使用引擎中的所有資料儲存庫，但 ignoreDataStores 設為 true 時除外。
assistGenerationConfig

object (AssistGenerationConfig)

選用。要求層級生成設定。這項設定可用於在引擎層級覆寫預設的生成設定。
googleSearchGroundingEnabled
(deprecated)

boolean

選用。已淘汰，請改用 webGroundingEnabled。

回應主體

AssistantService.Assist 方法的回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string,
  "invocationTools": [
    string
  ],
  "invokedSkills": [
    {
      object (InvokedSkill)
    }
  ],
  "connectorAuthErrors": [
    {
      object (ConnectorAuthError)
    }
  ]
}
欄位
answer

object (AssistAnswer)

系統會根據查詢產生 AssistAnswer 資源。
sessionInfo

object (SessionInfo)

工作階段資訊。
assistToken

string

全域不重複 ID，用於識別目前的要求/回應配對。用於意見回饋和支援。
invocationTools[]

string

叫用工具的工具名稱。
invokedSkills[]

object (InvokedSkill)

回合期間執行的技能。
connectorAuthErrors[]

object (ConnectorAuthError)

要求期間發生每個連接器的驗證錯誤。當一或多個連接器驗證失敗，但要求繼續使用其餘連接器時，就會顯示這項資訊。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • discoveryengine.assistants.assist

詳情請參閱 IAM 說明文件。

AssistSkippingMode

可略過的輔助要求。

列舉
ASSIST_SKIPPING_MODE_UNSPECIFIED 預設值。如果查詢並非尋求協助，可以略過答案。
REQUEST_ASSIST 要求 Google 助理回答。如果查詢未通過政策檢查，系統仍可能會略過答案。

SessionInfo

工作階段的相關資訊。

JSON 表示法 
{
  "session": string,
  "queryId": string
}
欄位
session

string

新生成或接續的工作階段名稱。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
queryId

string

與這項輔助 API 呼叫相應的查詢 ID。一個工作階段可以有多個輪次，每個輪次都有專屬的查詢 ID。

在 assistants.assist API 呼叫中指定工作階段名稱和這個查詢 ID，即可在這次搜尋呼叫的搜尋結果脈絡中提出輔助要求。

InvokedSkill

代表在輔助通話期間使用的技能。

JSON 表示法 
{
  "name": string,
  "displayName": string
}
欄位
name

string

技能的資源名稱。
displayName

string

技能的顯示名稱。

ConnectorAuthError

說明特定資料連接器的驗證錯誤。

JSON 表示法 
{
  "dataConnector": string,
  "errorMessage": string
}
欄位
dataConnector

string

無法通過驗證的資料連接器資源名稱。
errorMessage

string

使用者可理解的錯誤訊息，說明驗證失敗的原因。