CompletionConfig

設定可自訂引擎和資料儲存庫的 Autocomplete API 回應。部分欄位僅適用於其中一個。

JSON 表示法 
{
  "name": string,
  "matchingOrder": string,
  "maxSuggestions": integer,
  "minPrefixLength": integer,
  "queryModel": string,
  "queryFrequencyThreshold": integer,
  "numUniqueUsersThreshold": integer,
  "shouldServeContentSuggestions": boolean,
  "filterPiiSuggestionsUsingDlp": boolean,
  "enableMode": enum (EnableMode)
}
欄位
name

string

這是必要旗標，不可變動。完整名稱 projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

自動完成建議的相符順序，例如，如果查詢包含 sh，且指定 out-of-order，系統會建議 women's shoes；如果查詢包含 red s，且指定 exact-prefix，系統會建議 red shoes。目前支援的值：

  • out-of-order
  • exact-prefix

預設值為 exact-prefix。
maxSuggestions

integer

每個字詞傳回的自動完成建議數量上限。

maxSuggestions 必須介於 [1, 20] 範圍內。如未設定或設為 0，系統會將預設值設為 20 個建議。
minPrefixLength

integer

取得建議所需的最低字元數。

minPrefixLength 必須介於 [1, 20] 範圍內。如果未設定或設為 0，則會設為預設值 1 個字元。
queryModel

string

用於提供查詢建議的資料模型。

目前支援的值：

  • automatic - autocomplete 後端會自動選取或混合不同模型的建議。
  • document - 使用從使用者匯入文件生成的建議。
  • search-history - 使用根據 SearchService.Search API 呼叫記錄產生的建議。如果沒有 Search API 流量，請勿使用。
  • user-event - 使用從使用者匯入的搜尋事件產生的建議。
  • document-completable - 使用直接從使用者匯入的文件欄位取得的建議，這些欄位標示為可完成。

如果查詢模型為空白，服務預設會套用「自動」模型。
queryFrequencyThreshold

integer

這個欄位只對使用者事件或搜尋記錄產生的建議有意義。如果查詢的顯示次數低於這個門檻，可能表示該查詢很少被搜尋，因此不會產生建議。這個欄位有助於防止系統將個人識別資訊查詢做為建議，因為這類查詢通常是獨一無二的。如未設定，系統會在生成管道中使用預設值 8。
numUniqueUsersThreshold

integer

這個欄位只適用於根據使用者事件或搜尋記錄產生的建議，這類建議可能附有使用者 ID。如果搜尋查詢的不重複使用者人數少於這個門檻，系統就不會產生該查詢的建議。這個欄位有助於防止系統將個人識別資訊查詢做為建議，因為這類查詢通常是獨一無二的。如未設定，系統會在生成管道中使用預設值 3。
shouldServeContentSuggestions

boolean

是否要生成及放送內容建議。這樣除了查詢建議，系統還會提供內容建議。
filterPiiSuggestionsUsingDlp

boolean

如果是，請盡量偵測並移除含有特定類型 PII 資訊的建議。這項偵測作業會在幕後由 DLP 執行。
enableMode

enum (EnableMode)

自動完成生成管道的啟用模式。如未設定這個欄位，伺服器行為會預設為 CompletionConfig.EnableMode.AUTOMATIC。僅適用於 DataStore。引擎會忽略這項設定。

EnableMode

指定自動完成生成管道的啟用模式。

列舉
ENABLE_MODE_UNSPECIFIED 如果未指定 AutoComplete 啟用模式，系統會預設為 AUTOMATIC 模式。
AUTOMATIC 資料儲存庫符合條件時，系統就會啟用自動完成功能。
MANUAL 無論 UCS 資料需求為何，系統都會啟用自動完成功能。