Ir para o conteúdo

Obter uma lista de documentos em um Armazenamento Vetorial

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.

Exemplo de Solicitações

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

Info

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store e vs_abc123 pelo seu ID do Vector Store.

const getVectorStoreDocuments = async (vectorStoreId) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents`, {
    method: 'GET',
    headers: {
      'x-api-key': 'SUA_CHAVE_API'
    }
  });

  const data = await response.json();
  console.log(data);
};

getVectorStoreDocuments('vs_abc123');

Info

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store e vs_abc123 pelo seu ID do Vector Store.

import requests

def get_vector_store_documents(vector_store_id):
    headers = {
        "x-api-key": "SUA_CHAVE_API"
    }

    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

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store e vs_abc123 pelo seu ID do Vector Store.

Parâmetros de Caminho

Parâmetro Tipo Descrição
vector-store-id string Obrigatório. O ID da loja de vetores de onde listar documentos.

Formato de Resposta

[
  {
    "id": 1234,
    "name": "Manual do Produto.pdf",
    "type": "application/pdf",
    "vector_store": "vs_abc123",
    "size": 250000,
    "status": "indexado",
    "processing_status": "concluído",
    "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": "Especificações Técnicas.docx",
    "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "vector_store": "vs_abc123",
    "size": 125000,
    "status": "indexado",
    "processing_status": "concluído",
    "indexed_on": "2023-06-15T11:45:00Z",
    "status_error_message": null,
    "created": "2023-06-15T11:30:00Z",
    "modified": "2023-06-15T11:45:00Z"
  }
]

Autenticação

Este endpoint requer autenticação usando uma chave de API no cabeçalho x-api-key.

Respostas de Erro

Código de Status Descrição
401 Não Autorizado - Chave de API inválida ou ausente
404 Não Encontrado - Armazenamento de Vetores não encontrado
500 Erro Interno do Servidor

Este endpoint recupera uma lista de todos os documentos armazenados no armazenamento de vetores especificado. Ele fornece metadados sobre cada documento, incluindo o status de processamento do documento, tamanho e timestamp indexado. Essas informações são úteis para monitorar o conteúdo do seu armazenamento de vetores e verificar o status de processamento dos documentos.