Custom Search Site Restricted JSON API から移行する

プログラム可能検索エンジンの カスタム検索サイト制限付き JSON API を使用している場合は、Vertex AI Search を使用して、Google 品質のサイト制限付き検索を数分で作成してデプロイできます。アプリをデプロイするには、検索ウィジェットを使用して、Google Cloud コンソールからコードをウェブページに直接コピーします。コーディングは必要ありません。また、API デプロイを実装して、ウェブサイト上の検索機能の表示方法を制御することもできます。API の使用方法については、ウェブサイト データを使用してアプリの検索結果を取得するの REST タブと、REST リファレンスの servingConfigs.search メソッドをご覧ください。

Vertex AI Search が検索結果とともに返す標準の短いスニペットに加えて、検索に高度な機能を追加できます。たとえば、生成された検索結果の概要、フォローアップの質問を許可するコンテキスト対応検索のフォローアップ付き検索、各検索結果とともに返される抽出テキストの抽出回答などがあります。ウェブ検索でこれらの高度な機能を利用するには、ドメインの所有権の証明が必要であり、追加のインデックス登録料金が発生します。

検索結果をフィルタまたは並べ替えし、プロモート コントロールを適用して、リンクをプロモート結果として表示することもできます。

詳細については、Vertex AI Agent Builder の料金のページをご覧ください。

Vertex AI Search を設定する

Vertex AI Search を設定する手順は次のとおりです。

  1. Google Cloud コンソールのプロジェクト セレクタ ページで、カスタム検索サイト限定 JSON API に使用しているプロジェクトを選択します。

  2. Vertex AI Agent Builder を有効にする。

検索アプリを作成する

検索アプリを作成する手順は次のとおりです。

  1. Google Cloud コンソールで、[Agent Builder] ページに移動します。

    Agent Builder

  2. [アプリを作成] をクリックします。

  3. [アプリの作成] ページの [ウェブサイトを検索] で、[作成] をクリックします。

  4. [Enterprise エディションの機能] がオンになっていることを確認します。これはウェブサイト検索に必要です。詳細については、Enterprise エディションの機能をご覧ください。

  5. [高度な LLM 機能] をオフにします。これをオフにすると、プログラム可能検索エンジンのカスタム検索サイト制限付き JSON API に似た機能が提供されます。検索の要約やフォローアップ付きの検索が不要な場合は、この機能をオフにします。詳細については、高度な LLM 機能をご覧ください。

  6. [アプリ名] フィールドに、アプリの名前を入力します。

  7. [会社または組織の表示名] フィールドに、会社または組織の一般名を入力します。

  8. アプリのロケーションとして [global (Global)] を選択し、[続行] をクリックします。

  9. [データストア] ページで、[データストアを作成] をクリックします。

  10. [データソースを選択] ペインで、[ウェブサイトのコンテンツ] を選択します。

  11. ウェブサイトの高度なインデックス登録のインデックス登録をオフにします。これをオフにすると、プログラム可能検索エンジンのカスタム検索サイト制限付き JSON API に似た機能が提供されます。検索の要約やフォローアップ付きの検索が不要な場合や、指定したドメインを所有していない場合は、この機能をオフにします。詳しくは、「ウェブサイトの高度なインデックス登録」をご覧ください。

  12. [インデックスに登録する URL パターンを指定してください] ペインの [追加するサイト] フィールドに、検索するウェブサイトの URL パターンを入力し、[続行] をクリックします。

  13. [データストアの構成] ペインで、データストアの名前を入力してから、[作成] をクリックします。

  14. [データストア] ページで新しいデータストアを選択してから、[作成] をクリックします。

検索アプリをデプロイする

Vertex AI Search 検索アプリの認証方法（OAuth 2.0 または API キー）を決定します。各方法の長所と短所については、認証についてをご覧ください。

検索アプリをデプロイする（OAuth 2.0）

OAuth 2.0 認証を使用して検索アプリをデプロイする手順は次のとおりです。

  1. OAuth 2.0 を設定するには、Vertex AI Agent Builder に対して認証するの Google Cloud でをご覧ください。サービス アカウントに Discovery Engine ユーザーまたは Discovery Engine 閲覧者のロールがあることを確認してください。

  2. 次のいずれかの方法で検索アプリをデプロイします。

検索アプリをデプロイする（API キー）

認証に API キーを使用して検索アプリをデプロイする手順は次のとおりです。

  1. API キーを作成します。

    1. Google Cloud コンソールで、[認証情報] ページに移動します。

      Credentials

    2. プロジェクトにまだ移動していない場合は、Google Cloud コンソール ページの上部にあるプロジェクト リストでプロジェクトを選択します。

    3. [認証情報を作成] をクリックして [API キー] を選択します。リファラー制限を追加しないでください。一部のユーザーのプライバシー設定では、参照 URL が渡されません。

      • 生成された API キーをメモします。このキーは、searchLite メソッドを呼び出すときに使用します。

    4. セキュリティを強化するには、API キーに HTTP 制限を追加して、https://discoveryengine.googleapis.com/* での Vertex AI Agent Builder サービスへのアクセスを制限します。

  2. API を使用して検索アプリをデプロイします。ウェブサイト データを含むアプリの検索結果を取得する（API キー）と、REST リファレンスの servingConfigs.searchLite メソッドをご覧ください。ウェブ検索クエリの結果を並べ替えるには、ウェブ検索結果を並べ替えるをご覧ください。

認証について

プログラム可能検索エンジンの Custom Search Site Restricted JSON API は、API キーを使用して認証します。ただし、いくつかの例外を除き、Vertex AI Search では OAuth 2.0 が必要です。認証に API キーを引き続き使用する場合は、API 呼び出しで searchLite メソッドを使用する必要があります。

OAuth 2.0 を介して認証する場合は、search メソッドと answer メソッドを使用してウェブサイトをクエリする必要があります。また、ノーコード検索ウィジェットを使用して検索アプリをデプロイすることもできます。

次の表に、API キー認証で searchLite メソッドを使用する場合と、OAuth 2.0 認証で search メソッドと answer メソッドを使用する場合の違いを示します。

機能/メソッド searchLite メソッド search メソッド
認証 API キー OAuth 2.0
検索ウィジェットを利用可能 ✘ ✔
検索のサマリー ✔ ✔
一般公開されているウェブサイトを検索する ✔ ✔

次のステップ