Saltar a contenido

Documentos

Cómo entra el contenido en Renbase, qué se hace con él y cómo mantenerlo al día.

Subir

curl -X POST $RENBASE_API/v1/documents \
  -H "Authorization: Bearer $RENBASE_KEY" \
  -F file=@manual.pdf \
  -F collection=soporte \
  -F 'meta={"lang":"es","category":"politicas"}'

Formatos admitidos: PDF, DOCX, PPTX, XLSX, HTML, Markdown y texto plano. Los PDF escaneados se leen con reconocimiento de texto; los digitales se leen directamente de su capa de texto, que es más fiel.

La llamada devuelve un trabajo de inmediato en vez de retener la conexión:

{ "id": "9f3c…", "status": "pending", "stage": "queued" }

Añade ?wait=30 si prefieres bloquear hasta que termine el procesamiento o venza el tiempo: cómodo en scripts, poco recomendable con ficheros grandes.

Metadatos

El campo meta adjunta pares clave-valor al documento. Sirven después como filtros al preguntar:

-d '{"query": "política de facturas", "filters": {"lang": "es", "category": ["politicas", "facturacion"]}}'

Los filtros combinan con AND entre claves y OR dentro de los valores de una clave, con coincidencia exacta.

Seguir el progreso

Un trabajo pasa por pending → running → done, con una stage que describe qué está haciendo (queued, fetching, parsing, chunking, indexing).

curl $RENBASE_API/v1/jobs/9f3c… -H "Authorization: Bearer $RENBASE_KEY"

Para una vista en vivo —una barra de progreso en tu propia interfaz, por ejemplo— suscríbete al flujo de eventos en lugar de consultar en bucle:

curl -N $RENBASE_API/v1/jobs/events -H "Authorization: Bearer $RENBASE_KEY"

Si un trabajo falla, lleva un motivo corto. Un administrador puede reencolarlo sin volver a subir el fichero:

curl -X POST $RENBASE_API/v1/jobs/9f3c…/retry -H "Authorization: Bearer $ADMIN_TOKEN"

Esa ventana no es indefinida: los bytes subidos se guardan siete días después del procesamiento, y pasados esos días reintentar exige subir el fichero otra vez.

Listar e inspeccionar

# Listado paginado, filtrable por colección y texto libre
curl "$RENBASE_API/v1/documents?collection=soporte&q=devolucion" \
  -H "Authorization: Bearer $RENBASE_KEY"

# Un documento, con su tamaño, colección y número de fragmentos
curl $RENBASE_API/v1/documents/{id} -H "Authorization: Bearer $RENBASE_KEY"

# Cómo se troceó para la búsqueda — útil cuando una respuesta se deja algo
curl $RENBASE_API/v1/documents/{id}/chunks -H "Authorization: Bearer $RENBASE_KEY"

Mirar los fragmentos es la forma más rápida de diagnosticar una respuesta decepcionante: si el pasaje relevante quedó mal partido o una tabla perdió su cabecera, se ve de inmediato.

Actualizar y retirar

Volver a subir un fichero con el mismo contenido no cambia nada: Renbase lo reconoce y se ahorra el trabajo. Subirlo modificado crea una versión nueva y la anterior deja de citarse.

# Retira el documento y saca su contenido de las respuestas
curl -X DELETE $RENBASE_API/v1/documents/{id} -H "Authorization: Bearer $ADMIN_TOKEN"

# Rehace sus entradas de búsqueda sin volver a subirlo
curl -X POST $RENBASE_API/v1/documents/{id}/reindex -H "Authorization: Bearer $ADMIN_TOKEN"

Reindexar rehace las entradas del documento a partir del contenido guardado. No vuelve a leer el fichero original, así que no cambia cómo se troceó; para eso hay que subirlo de nuevo.

Colecciones

curl $RENBASE_API/v1/collections -H "Authorization: Bearer $RENBASE_KEY"

Devuelve cada colección con su número de documentos. Los nombres que empiezan por __ están reservados.

Límites

Límite Valor
Tamaño máximo de un documento 50 MB
Documentos procesándose a la vez, por organización 2
Retención de los bytes subidos tras procesarlos 7 días

Las subidas que superan el límite de concurrencia no se rechazan: esperan en la cola y arrancan según terminan las anteriores.