プログラム可能検索エンジンのカスタム検索サイト制限付き JSON API を使用すると、Vertex AI Search を使用して、Google 品質のサイト制限付き検索を数分で作成してデプロイできます。アプリをデプロイするには、 Google Cloud コンソールからコードをコピーしてウェブページに直接貼り付けることで、検索ウィジェットを使用できます。コーディングは必要ありません。また、API デプロイを実装して、ウェブサイトでの検索機能の表示方法を制御することもできます。API の使用方法について詳しくは、ウェブサイトのデータを含むアプリの検索結果を取得するの REST タブと、REST リファレンスの servingConfigs.search
メソッドをご覧ください。
Vertex AI Search が検索結果とともに返す標準の短いスニペットに加えて、検索に高度な機能を追加できます。これには、検索結果の生成された概要、フォローアップの質問を可能にするコンテキスト認識検索のフォローアップ付き検索、各検索結果とともに返される抽出されたテキストの抽出回答が含まれます。ウェブ検索でこれらの高度な機能を利用するには、ドメインの所有権の証明が必要であり、インデックス登録の追加費用が発生します。
検索結果をフィルタしたり、並べ替えたりすることもできます。また、プロモーション コントロールを適用して、リンクをプロモーション結果として表示することもできます。
詳細については、AI アプリケーションの料金ページをご覧ください。
Vertex AI Search を設定する
Vertex AI Search を設定する手順は次のとおりです。
Google Cloud コンソールのプロジェクト セレクタ ページで、Custom Search Site Restricted JSON API に使用しているプロジェクトを選択します。
[AI アプリケーションを有効にする] をオンにします。
検索アプリを作成する
検索アプリを作成する手順は次のとおりです。
Google Cloud コンソールで、[AI アプリケーション] ページに移動します。
[アプリを作成] をクリックします。
[アプリの作成] ページの [AI モードでのサイト内検索] で [作成] をクリックします。
[Enterprise エディションの機能] がオンになっていることを確認します。ウェブサイト検索には必須です。詳細については、Enterprise エディションの機能をご覧ください。
[高度な LLM 機能] をオフにします。これをオフにすると、プログラム可能検索エンジンのカスタム検索サイト制限付き JSON API に似た機能が提供されます。検索の要約やフォローアップ付きの検索が不要な場合は、この機能をオフにします。詳しくは、高度な LLM 機能をご覧ください。
[アプリ名] フィールドに、アプリの名前を入力します。
[会社または組織の表示名] フィールドに、会社または組織の一般名を入力します。
アプリのロケーションとして [global (Global)] を選択し、[続行] をクリックします。
[データストア] ページで、[データストアを作成] をクリックします。
[データソースを選択] ペインで、[ウェブサイトのコンテンツ] を選択します。
[ウェブサイトの高度なインデックス登録] のインデックス登録をオフにします。これをオフにすると、プログラム可能検索エンジンのカスタム検索サイト制限付き JSON API に似た機能が提供されます。検索の要約やフォローアップ付きの検索が不要な場合、または指定したドメインを所有していない場合は、この機能をオフにします。詳しくは、「ウェブサイトの高度なインデックス登録」をご覧ください。
[インデックスに登録する URL パターンを指定してください] ペインの [追加するサイト] フィールドに、検索するウェブサイトの URL パターンを入力し、[続行] をクリックします。
[データストアの構成] ペインで、データストアの名前を入力してから、[作成] をクリックします。
[データストア] ページで新しいデータストアを選択してから、[作成] をクリックします。
検索アプリをデプロイする
OAuth 2.0 または API キーを使用して、Vertex AI Search 検索アプリを認証する方法を決定します。各方法のメリットとデメリットについては、認証についてをご覧ください。
検索アプリをデプロイする(OAuth 2.0)
OAuth 2.0 認証を使用して検索アプリをデプロイする手順は次のとおりです。
OAuth 2.0 を設定するには、AI アプリケーションに対する認証を行うの Google Cloud でをご覧ください。サービス アカウントに Discovery Engine ユーザーまたは Discovery Engine 閲覧者のロールを追加してください。
次のいずれかの方法で検索アプリをデプロイします。
検索ウィジェットを使用。コーディングなしで検索アプリをデプロイします。詳細については、検索ウィジェットをウェブページに追加するをご覧ください。
API を使用する。API を使用して、ウェブサイトでの検索機能の表示方法を制御します。詳細については、ウェブサイトのデータを使用してアプリの検索結果を取得するの [REST] タブと、REST リファレンスの
servingConfigs.search
メソッドをご覧ください。ウェブ検索クエリの結果を並べ替えるには、ウェブ検索結果を並べ替えるをご覧ください。
検索アプリをデプロイする(API キー)
認証に API キーを使用して検索アプリをデプロイする手順は次のとおりです。
API キーを作成します。
Google Cloud コンソールで、[認証情報] ページに移動します。
プロジェクトにまだアクセスしていない場合は、 Google Cloud コンソール ページの上部にあるプロジェクト リストでプロジェクトを選択します。
[認証情報を作成] をクリックして [API キー] を選択します。リファラー制限を追加しないでください。一部のユーザーのプライバシー設定では、参照 URL が渡されません。
- 生成された API キーをメモします。このキーは、
searchLite
メソッドを呼び出すときに使用します。
- 生成された API キーをメモします。このキーは、
セキュリティを強化するには、API キーに HTTP 制限を追加して、
https://discoveryengine.googleapis.com/*
での AI Applications サービスへのアクセスを制限します。
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 |
検索ウィジェットを利用可能 | ✘ | ✔ |
検索のサマリー | ✔ | ✔ |
一般公開されているウェブサイトを検索する | ✔ | ✔ |
次のステップ
検索結果をフィルタする必要がある場合は、基本的なウェブサイト検索のフィルタ式をご覧ください。
画像検索を提供する必要がある場合は、ウェブサイトで画像を検索するをご覧ください。
検索結果を日付などで並べ替える必要がある場合は、基本的なウェブサイト検索で検索結果を並べ替えるをご覧ください。
複数ターンの検索が必要な場合は、フォローアップ質問のコマンドをご覧ください。