Method: projects.locations.dataStores.completeQuery

以建議的關鍵字完成指定的使用者輸入內容。

HTTP 要求

GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery

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

路徑參數

參數
dataStore

string

這是必要旗標，要執行完成作業的父項資料儲存庫資源名稱，例如 projects/*/locations/global/collections/default_collection/dataStores/default_data_store。

查詢參數

參數
query

string

這是必要旗標，用於擷取建議的自動完成輸入內容。長度上限為 128 個半形字元。
queryModel

string

指定自動完成資料模型。這會覆寫 Cloud 控制台「設定」>「自動完成」部分中指定的任何模型。目前支援的值：

  • document - 使用從使用者匯入文件生成的建議。
  • search-history - 使用根據 SearchService.Search API 呼叫記錄產生的建議。如果沒有 Search API 流量，請勿使用。
  • user-event - 使用從使用者匯入的搜尋事件產生的建議。
  • document-completable - 使用直接從使用者匯入的文件欄位取得的建議，這些欄位標示為可完成。

預設值：

  • document 是常規資料儲存區的預設模型。
  • search-history 是網站搜尋資料儲存區的預設模型。
userPseudoId

string

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

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

這個 ID 應與 UserEvent.user_pseudo_id 和 SearchRequest.user_pseudo_id 相同。

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

boolean

指出在沒有與完整查詢相符的建議時，是否應傳回尾部建議。即使設為 true，如果系統找到與完整查詢相符的建議，就會傳回這些建議，不會傳回尾部建議。

要求主體

要求主體必須為空白。

回應主體

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

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • discoveryengine.dataStores.completeQuery

詳情請參閱 IAM 說明文件。