ベクターストア内の文書のリストを取得
get
List all documents in a vector store.
Path parameters
vector-store-idstringRequired
The ID of the vector store.
Header parameters
x-api-keystringRequired
The API key for authentication.
Responses
200
A list of documents.
application/json
get
/vector-stores/{vector-store-id}/documents200
A list of documents.
例のリクエスト
curl -X GET \
https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents \
-H "x-api-key: YOUR_API_KEY"const getVectorStoreDocuments = async (vectorStoreId) => {
const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents`, {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY'
}
});
const data = await response.json();
console.log(data);
};
getVectorStoreDocuments('vs_abc123');import requests
def get_vector_store_documents(vector_store_id):
headers = {
"x-api-key": "YOUR_API_KEY"
}
response = requests.get(
f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents",
headers=headers
)
data = response.json()
print(data)
get_vector_store_documents('vs_abc123')パスパラメータ
パラメータ
タイプ
説明
vector-store-id
文字列
必須。 ドキュメントをリストするためのベクターストアのID。
レスポンスフォーマット
認証
このエンドポイントは、x-api-key ヘッダーを使用して API キーによる認証を必要とします。
エラー応答
ステータスコード
説明
401
認証エラー - 無効または欠落しているAPIキー
404
未検出 - ベクトルストアが見つかりません
500
サーバ内部エラー
このエンドポイントは、指定されたベクトルストアに保存されているすべてのドキュメントのリストを取得します。各ドキュメントに関するメタデータを提供し、ドキュメントの処理状況、サイズ、およびインデックス作成されたタイムスタンプを含みます。この情報は、ベクトルストアの内容を監視し、ドキュメントの処理状況を確認するのに役立ちます。
Last updated