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

予測入力候補の照合順序。たとえば、out-of-order が指定された sh で構成されるクエリでは women's shoes が候補として表示されますが、exact-prefix が指定された red s で構成されるクエリでは 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 - 予測入力バックエンドが、さまざまなモデルの候補を自動的に選択または混合します。
  • document - ユーザーがインポートしたドキュメントから生成された候補を使用しています。
  • search-history - SearchService.Search API 呼び出しの過去の履歴から生成された候補を使用します。Search API のトラフィックがない場合は使用しないでください。
  • user-event - ユーザーがインポートした検索イベントから生成された候補を使用します。
  • document-completable - 完了可能としてマークされたユーザーがインポートしたドキュメント フィールドから直接取得した候補を使用します。

クエリモデルが空の場合、サービングはデフォルトで「自動」モデルを適用します。
queryFrequencyThreshold

integer

このフィールドは、ユーザー イベントまたは検索履歴から生成された候補に対してのみ意味があります。検索語句の検索数がこのしきい値を下回っている場合、その検索語句は検索される頻度が低いため、候補として生成されない可能性があります。このフィールドは、PII クエリが候補にならないようにするのに役立ちます。PII クエリは通常、一意に検索されるためです。設定しない場合、生成パイプラインで使用されるデフォルト値の 8 が使用されます。
numUniqueUsersThreshold

integer

このフィールドは、ユーザー ID が付加されている可能性があるユーザー イベントまたは検索履歴から生成された候補に対してのみ意味があります。クエリを検索したユニーク ユーザーの数がこのしきい値を下回る場合、そのクエリは候補として生成されません。このフィールドは、PII クエリが候補にならないようにするのに役立ちます。PII クエリは通常、一意に検索されるためです。設定しない場合、生成パイプラインで使用されるデフォルト値の 3 が使用されます。
shouldServeContentSuggestions

boolean

おすすめのコンテンツを生成して提供するかどうか。これにより、クエリ候補に加えてコンテンツ候補も表示されるようになります。
filterPiiSuggestionsUsingDlp

boolean

true の場合、特定の種類の PII 情報を含む候補を検出して削除するよう、ベスト エフォートで試みます。この検出は、内部で DLP によって実行されます。
enableMode

enum (EnableMode)

予測入力生成パイプラインの有効モード。このフィールドが設定されていない場合、サーバーの動作はデフォルトで CompletionConfig.EnableMode.AUTOMATIC になります。DataStore のみに適用されます。Engine では無視されます。

EnableMode

自動補完生成パイプラインの有効モードを指定します。

列挙型
ENABLE_MODE_UNSPECIFIED AutoComplete の有効モードが指定されていない場合、デフォルトで AUTOMATIC モードになります。
AUTOMATIC データストアが条件を満たすと、予測入力が有効になります。
MANUAL UCS のデータ要件に関係なく、AutoComplete が有効になります。