Method: projects.locations.collections.engines.completionConfig.completeQuery

以進階關鍵字建議完成使用者輸入內容。

HTTP 要求

POST https://discoveryengine.googleapis.com/v1alpha/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery

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

路徑參數

參數
completionConfig

string

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

要求主體

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

JSON 表示法 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
欄位
query

string

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

大多數建議類型都不能留空。如果為空，系統會傳回 INVALID_ARGUMENT 錯誤。但如果 suggestionTypes 只包含 RECENT_SEARCH 類型，查詢可以是空字串。這項功能稱為「零前置字元」，可根據空白查詢傳回使用者最近搜尋的查詢。
queryModel

string

指定自動完成查詢模型，僅適用於 QUERY SuggestionType。這會覆寫 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 個字元
userInfo

object (UserInfo)

(選用步驟) 使用者的相關資訊。

這項資訊應與 UserEvent.user_info 和 SearchRequest.user_info 的 ID 資訊相同。
includeTailSuggestions

boolean

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

object (BoostSpec)

(選用步驟) 規格，可提升符合條件的建議。
suggestionTypes[]

enum (SuggestionType)

(選用步驟) 要傳回的建議類型。如果留空或未指定，系統會傳回查詢建議。目前僅支援一種建議類型。
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

(選用步驟) 各建議類型的規格。
experimentIds[]

string

選用。此要求的實驗 ID。

回應主體

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

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • discoveryengine.completionConfigs.completeQuery

詳情請參閱 IAM 說明文件。