콘텐츠로 이동

벡터 저장소에서 문서 목록 가져오기

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

List all documents in a vector store.

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

Responses

  • 200 — 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"

Info

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

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

Info

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

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

Info

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

경로 매개변수

매개변수 유형 설명
vector-store-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"
  },
  {
    "id": 1235,
    "name": "기술 사양.docx",
    "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "vector_store": "vs_abc123",
    "size": 125000,
    "status": "색인됨",
    "processing_status": "완료됨",
    "indexed_on": "2023-06-15T11:45:00Z",
    "status_error_message": null,
    "created": "2023-06-15T11:30:00Z",
    "modified": "2023-06-15T11:45:00Z"
  }
]

인증

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

오류 응답

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

이 엔드포인트는 지정된 벡터 저장소에 저장된 모든 문서의 목록을 검색합니다. 각 문서에 대한 메타데이터를 제공하며, 여기에는 문서의 처리 상태, 크기 및 인덱스된 타임스탬프가 포함됩니다. 이 정보는 벡터 저장소의 내용을 모니터링하고 문서 처리 상태를 확인하는 데 유용합니다.