Saltar a contenido

Obtener la información de un documento

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.

Ejemplos de Solicitudes

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

Info

Reemplaza TU_API_KEY con tu clave API real de Vector Store, vs_abc123 con tu ID de Vector Store, y 1234 con el ID del documento.

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': 'TU_API_KEY'
    }
  });

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

getDocumentInfo('vs_abc123', 1234);

Info

Reemplaza TU_API_KEY con tu clave API real de Vector Store, vs_abc123 con tu ID de Vector Store, y 1234 con el ID del documento.

import requests

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

Reemplaza TU_API_KEY con tu clave API real de Vector Store, vs_abc123 con tu ID de Vector Store, y 1234 con el ID del documento.

Parámetros de Ruta

Parámetro Tipo Descripción
vector-store-id cadena Requerido. El ID de la tienda de vectores que contiene el documento.
document-id entero Requerido. El ID del documento a recuperar.

Formato de Respuesta

{
  "id": 1234,
  "name": "Manual del Producto.pdf",
  "type": "application/pdf",
  "vector_store": "vs_abc123",
  "size": 250000,
  "status": "indexado",
  "processing_status": "completado",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:30: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 o documento no encontrado
500 Error Interno del Servidor

Este endpoint recupera información detallada sobre un documento específico en el almacén de vectores. Es útil para verificar el estado de procesamiento de documentos individuales y recuperar metadatos como tipo de archivo, tamaño y marcas de tiempo. Esto puede ser particularmente útil al solucionar problemas con el procesamiento de documentos o cuando necesitas verificar que un documento fue indexado correctamente.