문서 정보 가져오기

GET /vector-stores/{vector-store-id}/documents/{document-id}

Retrieve the information of a document in a Vector Store.

Parameter	In	Type	Required	Description
vector-store-id	path	string	yes	The ID of the vector store.
document-id	path	integer	yes	The ID of the document.
x-api-key	header	string	yes	The API key for authentication.

Responses

• 200 — Document details retrieved successfully.

예제 요청

cURLJavaScriptPython

curl -X GET   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234   
  -H "x-api-key: YOUR_API_KEY"

Info

YOUR_API_KEY를 실제 Vector Store API 키로, vs_abc123를 Vector Store ID로, 1234를 문서 ID로 교체하세요.

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);

Info

YOUR_API_KEY를 실제 Vector Store API 키로, vs_abc123를 Vector Store ID로, 1234를 문서 ID로 교체하세요.

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)

Info

YOUR_API_KEY를 실제 Vector Store API 키로, vs_abc123를 Vector Store ID로, 1234를 문서 ID로 교체하세요.

경로 매개변수

매개변수	유형	설명
vector-store-id	문자열	필수. 문서를 포함하는 벡터 저장소의 ID입니다.
document-id	정수	필수. 검색할 문서의 ID입니다.

응답 형식

{
  "id": 1234,
  "name": "제품 매뉴얼.pdf",
  "type": "application/pdf",
  "vector_store": "vs_abc123",
  "size": 250000,
  "status": "색인됨",
  "processing_status": "완료됨",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:30:00Z"
}

인증

이 엔드포인트는 x-api-key 헤더에 API 키를 사용하여 인증이 필요합니다.

오류 응답

상태 코드	설명
401	권한 없음 - 잘못되었거나 누락된 API 키
404	찾을 수 없음 - 벡터 저장소 또는 문서를 찾을 수 없음
500	내부 서버 오류

이 엔드포인트는 벡터 저장소의 특정 문서에 대한 자세한 정보를 검색합니다. 개별 문서의 처리 상태를 확인하고 파일 유형, 크기 및 타임스탬프와 같은 메타데이터를 검색하는 데 유용합니다. 이는 문서 처리 문제를 해결하거나 문서가 제대로 색인화되었는지 확인해야 할 때 특히 도움이 될 수 있습니다.