ウェブサイトで画像を検索する

Vertex AI Search を使用すると、ウェブサイトのデータを含むアプリを使用して画像を検索できます。テキスト文字列または画像の形式でクエリを指定し、default_config.search メソッドがそのクエリの画像を返します。

始める前に

次の前提条件を満たしていることを確認してください。要件は、テキストクエリと画像クエリのどちらを使用して検索するかによって異なります。

ウェブサイト検索アプリでテキストクエリを使用して検索する場合は、Enterprise エディションの機能がオンになっていることを確認してください。
ウェブサイト検索アプリで画像クエリを使用して検索する場合は、次の機能がオンになっていることを確認してください。
- Enterprise エディションの機能
- ウェブサイトの高度なインデックス登録

プレビュー画像検索

コマンドラインを使用してウェブサイトの画像結果をプレビューするには、engines.servingConfigs.search メソッドを使用します。

注: アプリ内を検索するには engines.servingConfigs.search メソッドを使用し、データストア内を検索するには dataStores.servingConfigs.search メソッドを使用します。次の手順では、engines.servingConfigs.search メソッドを使用して検索することをおすすめします。

アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。
1. Google Cloud コンソールで、[Agent Builder] ページに移動します。
  
  [アプリ] に移動
2. [アプリ] ページでアプリの名前を見つけ、[ID] 列からアプリの ID を取得します。
search_type に 1 を指定して、engines.servingConfigs.search メソッドを呼び出します。クエリがテキストバイトか画像バイトかによって、メソッド構文を選択します。

キーワード: Vertex AI Search では、API のコンテキストでアプリという用語とエンジンという用語を同じ意味で使用できます。
クエリがテキスト文字列である
```
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_config:search" \
-d '{
"servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
"query": "QUERY",
"pageSize": "PAGE_SIZE",
"offset": "OFFSET",
"params": {"search_type": 1}
}'
```
クエリが画像である
```
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
-d '{
"servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
"imageQuery": {"imageBytes":"IMAGE_BYTES"},
"pageSize": "PAGE_SIZE",
"offset": "OFFSET",
"params": {"search_type": 1}
}'
```
- PROJECT_ID: プロジェクトの ID。
- APP_ID: アプリの ID。
- QUERY: 検索クエリのテキスト。たとえば、「丸いヘッドライトの車」や「ストライプのドレスを表示」などです。
- IMAGE_BYTES: Base64 でエンコードされたバイト形式の画像。サポートされている形式は JPEG、PNG、BMP です。
- PAGE_SIZE: 省略可。検索で返された結果の数。ウェブサイト検索のデフォルト値は 10 です。
  - 0 未満の値はエラーになります。
  - 100 を超える値は 100 に設定されます。
- OFFSET: 省略可。結果の開始インデックス。デフォルト値は 0 です。
  
  たとえば、オフセットが 2 でページサイズが 10 の場合、結果 2 から 11 が返されます。

回答を確認します。フィールドの説明については、次の表をご覧ください。

項目	説明
`title`	画像を含むウェブページの書式なしテキストのタイトル
`htmlTitle`	画像を含むウェブページの HTML 形式のタイトル
`displayLink`	この検索結果の URL の省略形、通常はドメイン名（例: `www.example.com`）
`link`	画像の URL
`image.contextLink`	コンテキストリンク: 画像を含むウェブページを指す URL
`image.byteSize`	画像のサイズ（バイト単位）
`image.width`	画像の幅（ピクセル単位）
`image.height`	画像の高さ（ピクセル単位）
`image.thumbnailWidth`	画像の幅（ピクセル単位）
`image.thumbnailHeight`	画像の高さ（ピクセル単位）
`image.thumbnailLink`	サムネイル画像の URL
`mime`	画像の MIME タイプ
`fileFormat`	画像のファイル形式

ウェブサイトで画像を検索する

始める前に

プレビュー画像検索

クエリがテキスト文字列である

クエリが画像である