Method: projects.locations.collections.dataStores.conversations.converse

結束對話。

HTTP 要求

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse

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

路徑參數

參數
name

string

這是必要旗標，要取得的對話資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}。使用 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- 啟動自動工作階段模式，系統會在 conversations.converse 工作階段中自動建立新對話。

要求主體

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

JSON 表示法 
{
  "query": {
    object (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
欄位
query

object (TextInput)

這是必要旗標，目前的使用者輸入內容。
servingConfig

string

要使用的供應設定資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId}如果未設定，系統會使用預設的供應設定。
conversation

object (Conversation)

對話只能由自動工作階段使用。系統會自動為自動工作階段中的對話指派新名稱，因此會忽略名稱欄位。
userLabels

map (key: string, value: string)

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

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

詳情請參閱 Google Cloud 文件。
summarySpec

object (SummarySpec)

用於設定回應中傳回摘要的規格。
filter

string

篩選器語法包含運算式語言，可從要篩選的文件的一或多個欄位建構述詞。篩選運算式會區分大小寫。這項資訊會用於篩選搜尋結果，可能會影響摘要回覆。

如果無法辨識這個欄位，系統會傳回 INVALID_ARGUMENT。

如要在 Vertex AI Search 中進行篩選，請將 LHS 篩選鍵對應至 Vertex AI Search 後端定義的鍵屬性，這項對應是由客戶在結構定義中定義。舉例來說，媒體客戶的結構定義中可能會有「name」欄位。在本例中，篩選器會如下所示：filter --> name:'ANY("king kong")'

如要進一步瞭解篩選功能，包括語法和篩選運算子，請參閱「篩選」
boostSpec

object (BoostSpec)

提升規格，在搜尋結果中提升特定文件，這可能會影響對話回應。如要進一步瞭解加成，請參閱「加成」一文。

回應主體

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

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • discoveryengine.conversations.converse

詳情請參閱 IAM 說明文件。