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

get

Retrieve information about the vector store associated with the API key.

Header parameters
x-api-keystringRequired

The API key for authentication.

Responses
chevron-right
200

Vector store information retrieved successfully.

application/json
idstringOptional

The ID of the vector store.

namestringOptional

The name of the vector store.

descriptionstringOptional

Description of the vector store.

embedding_modelstringOptional

The embedding model used.

indexing_algorithmstringOptional

The indexing algorithm used.

vector_dimensionintegerOptional

The dimension of the vectors.

search_metricstringOptional

The search metric used.

createdstring · date-timeOptional

Creation timestamp.

modifiedstring · date-timeOptional

Modification timestamp.

get
/vector-stores/me
200

Vector store information retrieved successfully.

例のリクエスト

curl -X GET \
  https://api.rememberizer.ai/api/v1/vector-stores/me \
  -H "x-api-key: YOUR_API_KEY"
circle-info

YOUR_API_KEYを実際のVector Store APIキーに置き換えてください。

レスポンス形式

認証

このエンドポイントは、x-api-key ヘッダーを使用して API キーによる認証を必要とします。

エラー応答

ステータスコード
説明

401

認証エラー - 無効または欠落しているAPIキー

404

未検出 - ベクトルストアが見つかりません

500

サーバ内部エラー

このエンドポイントは、提供されたAPIキーに関連付けられたベクトルストアに関する情報を取得します。これは、埋め込みモデル、次元数、および使用されている検索メトリックを含む構成の詳細を確認するのに役立ちます。この情報は、検索クエリの最適化やベクトルストアの機能を理解するために貴重です。

Last updated