Method: projects.locations.dataStores.completeQuery

指定されたユーザー入力をキーワード候補で補完します。

HTTP リクエスト

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

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

パスパラメータ

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

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

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

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

このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、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 のドキュメントをご覧ください。