ベクターストアAPI

ベクトルストアAPIを使用すると、Rememberizerでベクトルストアを作成、管理、検索できます。ベクトルストアは、意味的類似性検索を使用して文書を保存および取得することを可能にします。

利用可能なベクトルストアエンドポイント

管理エンドポイント

• ベクターストアの情報を取得する

• ベクターストア内のドキュメントのリストを取得する

• ドキュメントの情報を取得する

ドキュメント操作

• ベクトルストアに新しいテキストドキュメントを追加

• ファイルをベクトルストアにアップロード

• ベクトルストアのファイル内容を更新

• ベクトルストアからドキュメントを削除

検索操作

• セマンティック類似性によるベクトルストアドキュメントの検索

ベクターストアの作成

新しいベクターストアを作成するには、次のエンドポイントを使用します：

POST /api/v1/vector-stores/

リクエストボディ

{
  "name": "ストア名",
  "description": "ストアの説明",
  "embedding_model": "sentence-transformers/all-mpnet-base-v2",
  "indexing_algorithm": "ivfflat",
  "vector_dimension": 128,
  "search_metric": "cosine_distance"
}

レスポンス

{
  "id": "store_id",
  "name": "ベクターストア名",
  "description": "ストアの説明",
  "created": "2023-05-01T00:00:00Z",
  "modified": "2023-05-01T00:00:00Z"
}

ベクトルストアの設定

利用可能なベクトルストアの設定を取得するには、次のようにします：

GET /api/v1/vector-stores/configs

これにより、ベクトルストアを作成または設定する際に使用できる埋め込みモデル、インデックス作成アルゴリズム、および検索メトリックが返されます。

認証

すべてのベクターストアエンドポイントは、次のいずれかを使用して認証を必要とします：

• 管理操作のためのJWTトークン

• ドキュメントおよび検索操作のためのAPIキー