Method: projects.locations.collections.dataStores.servingConfigs.answer

Answer 查詢方法。

HTTP 要求

POST https://discoveryengine.googleapis.com/v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:answer

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

路徑參數

參數
servingConfig

string

這是必要旗標，供應設定的資源名稱。搜尋供應設定的資源名稱，例如 projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config 或 projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config。這個欄位用於識別供應設定名稱，也就是用於進行搜尋的一組模型。

要求主體

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

JSON 表示法 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
欄位
query

object (Query)

這是必要旗標，目前的使用者查詢。
session

string

工作階段資源名稱。非必要。

如未設定工作階段欄位，API 會處於無工作階段模式。

我們支援自動工作階段模式：使用者可以將萬用字元 - 設為工作階段 ID。系統會自動產生並指派新的 ID。
safetySpec

object (SafetySpec)

模型規格。
relatedQuestionsSpec

object (RelatedQuestionsSpec)

相關問題規格。
groundingSpec

object (GroundingSpec)

(選用步驟) 接地規格。
answerGenerationSpec

object (AnswerGenerationSpec)

生成答案的規格。
searchSpec

object (SearchSpec)

servingConfigs.search 規格。
queryUnderstandingSpec

object (QueryUnderstandingSpec)

查詢解讀規格。
asynchronousMode
(deprecated)

boolean

已淘汰：這個欄位已淘汰，支援 Streaming Answer API。

非同步模式控制。

啟用後，系統會傳回回應，其中包含答案/工作階段資源名稱，但不含最終答案。API 使用者需要呼叫 ConversationalSearchService.GetAnswer 或 ConversationalSearchService.GetSession 方法進行輪詢，才能取得答案/工作階段的最新狀態。
userPseudoId

string

用於追蹤訪客的專屬 ID。舉例來說，這項功能可以透過 HTTP Cookie 實作，應能識別單一裝置上的訪客。訪客登入或登出網站時，這個專屬 ID 不應變更。

這個欄位「不得」有固定值，例如 unknown_visitor。

這個欄位必須是 UTF-8 編碼的字串，長度上限為 128 個字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。
userLabels

map (key: string, value: string)

套用於資源的使用者標籤必須符合下列規定：

  • 每項資源可以有多個標籤，上限為 64 個。
  • 每個標籤都必須是鍵/值組合。
  • 鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個字元。
  • 鍵和值只能使用小寫字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。
  • 標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。
  • 鍵的開頭必須是小寫字母或國際字元。

詳情請參閱 Google Cloud 文件。
endUserSpec

object (EndUserSpec)

(選用步驟) 使用者規格。

回應主體

如果成功，回應主體會包含 AnswerQueryResponse 的執行個體。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • discoveryengine.servingConfigs.answer

詳情請參閱 IAM 說明文件。