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

例のリクエスト

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

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

const getVectorStoreInfo = async () => {
  const response = await fetch('https://api.rememberizer.ai/api/v1/vector-stores/me', {
    method: 'GET',
    headers: {
      'x-api-key': 'YOUR_API_KEY'
    }
  });
  
  const data = await response.json();
  console.log(data);
};

getVectorStoreInfo();

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

import requests

def get_vector_store_info():
    headers = {
        "x-api-key": "YOUR_API_KEY"
    }
    
    response = requests.get(
        "https://api.rememberizer.ai/api/v1/vector-stores/me",
        headers=headers
    )
    
    data = response.json()
    print(data)

get_vector_store_info()

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

レスポンス形式

{
  "id": "vs_abc123",
  "name": "My Vector Store",
  "description": "製品ドキュメント用のベクターストア",
  "embedding_model": "sentence-transformers/all-mpnet-base-v2",
  "indexing_algorithm": "ivfflat",
  "vector_dimension": 128,
  "search_metric": "cosine_distance",
  "created": "2023-06-01T10:30:00Z",
  "modified": "2023-06-15T14:45:00Z"
}

認証

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

エラー応答

ステータスコード

説明

401

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

404

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

500

サーバ内部エラー

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

Previous文書の情報を取得 Nextベクターストア内の文書を削除

Last updated 22 days ago