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

高度なキーワード候補を使用してユーザーの入力を補完します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

訪問者をトラッキングするための一意の識別子。たとえば、これは HTTP Cookie で実装できます。これにより、1 台のデバイス上の訪問者を一意に識別できます。この一意の識別子は、訪問者がウェブサイトに対してログインまたはログアウトしても変更されません。

このフィールドには、unknown_visitor などの固定値は設定しないでください。

これは、UserEvent.user_pseudo_id および SearchRequest.user_pseudo_id と同じ識別子にする必要があります。

このフィールドは、長さの上限が 128 の UTF-8 でエンコードされた文字列にする必要があります。
userInfo

object (UserInfo)

省略可。エンドユーザーに関する情報。

これは、UserEvent.user_info および SearchRequest.user_info と同じ識別子情報にする必要があります。
includeTailSuggestions

boolean

完全なクエリに一致する候補がない場合に、末尾の候補を返すかどうかを示します。true に設定されている場合でも、クエリ全体に一致する候補がある場合は、それらの候補が返され、末尾の候補は返されません。
boostSpec

object (BoostSpec)

省略可。条件に一致する候補をブーストする仕様。
suggestionTypes[]

enum (SuggestionType)

省略可。返される候補のタイプ。空または指定されていない場合は、クエリ候補が返されます。現時点では、提案タイプは 1 つのみサポートされています。
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 のドキュメントをご覧ください。