Vector Search API

Vector Search API は、次世代のベクトル検索、レコメンデーション、生成 AI アプリケーションを強化するために設計された、フルマネージドで高パフォーマンス、スケーラブルなベクトル データベースを提供します。シンプルで直感的なインターフェースを介して、データとそれに対応するベクトル エンベディングを保存、インデックス登録、クエリできます。ベクトル検索を使用すると、データのカスタム スキーマを定義し、関連するメタデータを含むオブジェクトを挿入し、データからエンベディングを自動的に生成し、高速な近似最近傍（ANN）検索を実行して、意味的に類似したアイテムを大規模に検索できます。

サービス: vectorsearch.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械で読み取り可能仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次のディスカバリ ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://vectorsearch.googleapis.com

REST リソース: v1.projects.locations

メソッド
get GET /v1/{name}
ロケーションに関する情報を取得します。
list GET /v1/{name}/locations
このサービスでサポートされているロケーションに関する情報のリストを取得します。

REST リソース: v1.projects.locations.collections

メソッド
create POST /v1/{parent}/collections
指定されたプロジェクトとロケーションで新しい Collection を作成します。
delete DELETE /v1/{name}
1 つのコレクションを削除します。
exportDataObjects POST /v1/{name}:exportDataObjects
コレクションから DataObject をエクスポートする長時間実行オペレーションを開始します。
get GET /v1/{name}
単一の Collection の詳細を取得します。
importDataObjects POST /v1/{name}:importDataObjects
長時間実行オペレーションを開始して、DataObjects を Collection にインポートします。
list GET /v1/{parent}/collections
指定されたプロジェクトとロケーションの Collection を一覧表示します。
patch PATCH /v1/{collection.name}
単一の Collection のパラメータを更新します。

REST リソース: v1.projects.locations.collections.dataObjects

メソッド
aggregate POST /v1/{parent}/dataObjects:aggregate
データ オブジェクトを集計します。
batchCreate POST /v1/{parent}/dataObjects:batchCreate
dataObject のバッチを作成します。
batchDelete POST /v1/{parent}/dataObjects:batchDelete
dataObjects を一括で削除します。
batchSearch POST /v1/{parent}/dataObjects:batchSearch
データ オブジェクトをバッチ検索します。
batchUpdate POST /v1/{parent}/dataObjects:batchUpdate
dataObjects を一括で更新します。
create POST /v1/{parent}/dataObjects
dataObject を作成します。
delete DELETE /v1/{name}
dataObject を削除します。
get GET /v1/{name}
データ オブジェクトを取得します。
patch PATCH /v1/{dataObject.name}
dataObject を更新します。
query POST /v1/{parent}/dataObjects:query
データ オブジェクトをクエリします。
search POST /v1/{parent}/dataObjects:search
データ オブジェクトを検索します。

REST リソース: v1.projects.locations.collections.indexes

メソッド
create POST /v1/{parent}/indexes
指定されたプロジェクトとロケーションで新しい Index を作成します。
delete DELETE /v1/{name}
1 つのインデックスを削除します。
get GET /v1/{name}
1 つのインデックスの詳細を取得します。
list GET /v1/{parent}/indexes
指定されたプロジェクトとロケーションのインデックスを一覧表示します。
patch PATCH /v1/{index.name}
単一のインデックスのパラメータを更新します。

REST リソース: v1.projects.locations.operations

メソッド
cancel POST /v1/{name}:cancel
長時間実行オペレーションの非同期キャンセルを開始します。
delete DELETE /v1/{name}
長時間実行オペレーションを削除します。
get GET /v1/{name}
長時間実行オペレーションの最新状態を取得します。
list GET /v1/{name}/operations
リクエスト内の指定したフィルタに一致するオペレーションを一覧表示します。

REST リソース: v1beta.projects.locations

メソッド
get GET /v1beta/{name}
ロケーションに関する情報を取得します。
list GET /v1beta/{name}/locations
このサービスでサポートされているロケーションに関する情報のリストを取得します。

REST リソース: v1beta.projects.locations.collections

メソッド
create POST /v1beta/{parent}/collections
指定されたプロジェクトとロケーションで新しい Collection を作成します。
delete DELETE /v1beta/{name}
1 つのコレクションを削除します。
exportDataObjects POST /v1beta/{name}:exportDataObjects
コレクションから DataObject をエクスポートする長時間実行オペレーションを開始します。
get GET /v1beta/{name}
単一の Collection の詳細を取得します。
importDataObjects POST /v1beta/{name}:importDataObjects
長時間実行オペレーションを開始して、DataObjects を Collection にインポートします。
list GET /v1beta/{parent}/collections
指定されたプロジェクトとロケーションの Collection を一覧表示します。
patch PATCH /v1beta/{collection.name}
単一の Collection のパラメータを更新します。

REST リソース: v1beta.projects.locations.collections.dataObjects

メソッド
aggregate POST /v1beta/{parent}/dataObjects:aggregate
データ オブジェクトを集計します。
batchCreate POST /v1beta/{parent}/dataObjects:batchCreate
dataObject のバッチを作成します。
batchDelete POST /v1beta/{parent}/dataObjects:batchDelete
dataObjects を一括で削除します。
batchSearch POST /v1beta/{parent}/dataObjects:batchSearch
データ オブジェクトをバッチ検索します。
batchUpdate POST /v1beta/{parent}/dataObjects:batchUpdate
dataObjects を一括で更新します。
create POST /v1beta/{parent}/dataObjects
dataObject を作成します。
delete DELETE /v1beta/{name}
dataObject を削除します。
get GET /v1beta/{name}
データ オブジェクトを取得します。
patch PATCH /v1beta/{dataObject.name}
dataObject を更新します。
query POST /v1beta/{parent}/dataObjects:query
データ オブジェクトをクエリします。
search POST /v1beta/{parent}/dataObjects:search
データ オブジェクトを検索します。

REST リソース: v1beta.projects.locations.collections.indexes

メソッド
create POST /v1beta/{parent}/indexes
指定されたプロジェクトとロケーションで新しい Index を作成します。
delete DELETE /v1beta/{name}
1 つのインデックスを削除します。
get GET /v1beta/{name}
1 つのインデックスの詳細を取得します。
list GET /v1beta/{parent}/indexes
指定されたプロジェクトとロケーションのインデックスを一覧表示します。
patch PATCH /v1beta/{index.name}
単一のインデックスのパラメータを更新します。

REST リソース: v1beta.projects.locations.dataStores

メソッド
create POST /v1beta/{parent}/dataStores
指定されたプロジェクトとロケーションで新しい DataStore を作成します。
delete DELETE /v1beta/{name}
単一の DataStore を削除します。
get GET /v1beta/{name}
単一の DataStore の詳細を取得します。
importDocuments POST /v1beta/{name}:importDocuments
長時間実行オペレーションを開始して、ドキュメントを DataStore にインポートします。
list GET /v1beta/{parent}/dataStores
指定されたプロジェクトとロケーションの DataStore を一覧表示します。
patch PATCH /v1beta/{dataStore.name}
単一の DataStore のパラメータを更新します。
purgeDocuments POST /v1beta/{name}:purgeDocuments
長時間実行オペレーションを開始して、DataStore からドキュメントを削除します。

REST リソース: v1beta.projects.locations.dataStores.documents

メソッド
get GET /v1beta/{name}
Document を取得します。
list GET /v1beta/{parent}/documents
DataStore 内のドキュメントを一覧表示します。
search POST /v1beta/{parent}/documents:search
1 つの DataStore のドキュメントを検索します。

REST リソース: v1beta.projects.locations.operations

メソッド
cancel POST /v1beta/{name}:cancel
長時間実行オペレーションの非同期キャンセルを開始します。
delete DELETE /v1beta/{name}
長時間実行オペレーションを削除します。
get GET /v1beta/{name}
長時間実行オペレーションの最新状態を取得します。
list GET /v1beta/{name}/operations
リクエスト内の指定したフィルタに一致するオペレーションを一覧表示します。