文書の情報を取得
get
Retrieve the information of a document in a Vector Store.
Path parameters
vector-store-idstringRequired
The ID of the vector store.
document-idintegerRequired
The ID of the document.
Header parameters
x-api-keystringRequired
The API key for authentication.
Responses
200
Document details retrieved successfully.
application/json
get
/vector-stores/{vector-store-id}/documents/{document-id}200
Document details retrieved successfully.
例リクエスト
curl -X GET \
https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234 \
-H "x-api-key: YOUR_API_KEY"const getDocumentInfo = async (vectorStoreId, documentId) => {
const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/${documentId}`, {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY'
}
});
const data = await response.json();
console.log(data);
};
getDocumentInfo('vs_abc123', 1234);import requests
def get_document_info(vector_store_id, document_id):
headers = {
"x-api-key": "YOUR_API_KEY"
}
response = requests.get(
f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents/{document_id}",
headers=headers
)
data = response.json()
print(data)
get_document_info('vs_abc123', 1234)パスパラメータ
パラメータ
タイプ
説明
vector-store-id
文字列
必須。 ドキュメントを含むベクトルストアのID。
document-id
整数
必須。 取得するドキュメントのID。
レスポンス形式
認証
このエンドポイントは、x-api-key ヘッダーを使用して API キーによる認証を必要とします。
エラー応答
ステータスコード
説明
401
認証エラー - 無効または欠落しているAPIキー
404
未検出 - ベクターストアまたはドキュメントが見つかりません
500
内部サーバーエラー
このエンドポイントは、ベクターストア内の特定のドキュメントに関する詳細情報を取得します。これは、個々のドキュメントの処理状況を確認したり、ファイルタイプ、サイズ、タイムスタンプなどのメタデータを取得するのに役立ちます。これは、ドキュメント処理の問題をトラブルシューティングする際や、ドキュメントが正しくインデックスされていることを確認する必要がある場合に特に便利です。
Last updated