Saltar a contenido

Obtener una lista de documentos en un Almacén de Vectores

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.

Ejemplos de Solicitudes

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

Info

Reemplaza TU_API_KEY con tu clave API real de Vector Store y vs_abc123 con tu ID de 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': 'TU_API_KEY'
    }
  });

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

getVectorStoreDocuments('vs_abc123');

Info

Reemplaza TU_API_KEY con tu clave API real de Vector Store y vs_abc123 con tu ID de Vector Store.

import requests

def get_vector_store_documents(vector_store_id):
    headers = {
        "x-api-key": "TU_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

Reemplaza TU_API_KEY con tu clave API real de Vector Store y vs_abc123 con tu ID de Vector Store.

Parámetros de Ruta

Parámetro Tipo Descripción
vector-store-id string Requerido. El ID de la tienda de vectores de la que listar documentos.

Formato de Respuesta

[
  {
    "id": 1234,
    "name": "Manual del Producto.pdf",
    "type": "application/pdf",
    "vector_store": "vs_abc123",
    "size": 250000,
    "status": "indexed",
    "processing_status": "completed",
    "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": "Especificaciones Técnicas.docx",
    "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "vector_store": "vs_abc123",
    "size": 125000,
    "status": "indexed",
    "processing_status": "completed",
    "indexed_on": "2023-06-15T11:45:00Z",
    "status_error_message": null,
    "created": "2023-06-15T11:30:00Z",
    "modified": "2023-06-15T11:45:00Z"
  }
]

Autenticación

Este endpoint requiere autenticación utilizando una clave API en el encabezado x-api-key.

Respuestas de Error

Código de Estado Descripción
401 No autorizado - Clave API inválida o faltante
404 No encontrado - Almacén de vectores no encontrado
500 Error interno del servidor

Este endpoint recupera una lista de todos los documentos almacenados en el almacén de vectores especificado. Proporciona metadatos sobre cada documento, incluyendo el estado de procesamiento del documento, tamaño y marca de tiempo indexada. Esta información es útil para monitorear el contenido de su almacén de vectores y verificar el estado de procesamiento de los documentos.