docs: record API discovery deployment
This commit is contained in:
parent
f1cd87c7a0
commit
f765332b2e
7 changed files with 23 additions and 14 deletions
|
|
@ -4,7 +4,7 @@
|
||||||
**Modulo:** RAG
|
**Modulo:** RAG
|
||||||
**Ultima actualizacion:** 2026-09-08
|
**Ultima actualizacion:** 2026-09-08
|
||||||
**Ultima modificacion por:** Agente RAG 2
|
**Ultima modificacion por:** Agente RAG 2
|
||||||
**Estado:** Operativa en produccion; endpoints de descubrimiento pendientes de despliegue
|
**Estado:** Operativa y validada en produccion
|
||||||
|
|
||||||
Esta guia explica como descubrir y consumir la API. El contrato tecnico completo y canonico se publica en OpenAPI 3.1.1; este documento prioriza el camino rapido, las decisiones de uso y los ejemplos habituales.
|
Esta guia explica como descubrir y consumir la API. El contrato tecnico completo y canonico se publica en OpenAPI 3.1.1; este documento prioriza el camino rapido, las decisiones de uso y los ejemplos habituales.
|
||||||
|
|
||||||
|
|
@ -16,8 +16,6 @@ Base URL de produccion:
|
||||||
https://rag.por-correo.com
|
https://rag.por-correo.com
|
||||||
```
|
```
|
||||||
|
|
||||||
Cuando se despliegue esta mejora:
|
|
||||||
|
|
||||||
| Recurso | URL | Uso |
|
| Recurso | URL | Uso |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| Ayuda resumida | `GET /help` | Descubrimiento rapido para personas y agentes |
|
| Ayuda resumida | `GET /help` | Descubrimiento rapido para personas y agentes |
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
# Aviso: migracion del repo a RAG como raiz
|
# Aviso: migracion del repo a RAG como raiz
|
||||||
|
|
||||||
|
**Estado del despliegue:** Verificado el 2026-09-08 con build context `/` en EasyPanel.
|
||||||
|
|
||||||
**Fecha:** 2026-07-21
|
**Fecha:** 2026-07-21
|
||||||
**Originado por:** Agente SerpBot API (ses_07a0ef286ffepXsTZOrCVa95nc) en `serpbot-api/`
|
**Originado por:** Agente SerpBot API (ses_07a0ef286ffepXsTZOrCVa95nc) en `serpbot-api/`
|
||||||
**Commit de migracion:** `b9a37f2 Restructure repo: move RAG content to repo root`
|
**Commit de migracion:** `b9a37f2 Restructure repo: move RAG content to repo root`
|
||||||
|
|
@ -85,11 +87,13 @@ Antes de la migracion, el `Dockerfile` estaba commiteado en el repo como `RAG/Do
|
||||||
|
|
||||||
## Pendiente concreto para el agente de RAG
|
## Pendiente concreto para el agente de RAG
|
||||||
|
|
||||||
1. Verificar y ajustar la configuracion de build de EasyPanel para `rag-service` segun lo descrito arriba.
|
Los puntos de configuracion y despliegue quedaron resueltos el 2026-09-08. EasyPanel debe mantener `Ruta de compilacion` en `/` y usar el `Dockerfile` de la raiz.
|
||||||
2. Hacer un deploy de prueba tras ajustar los paths del Dockerfile si fue necesario.
|
|
||||||
3. Confirmar que `health`, `retrieve` y `answer` siguen respondiendo en produccion.
|
1. Se ajusto el build context de EasyPanel de `/RAG` a `/`.
|
||||||
4. Si todo va bien, borrar el backup `/tmp/opencode/rag-git-backup-1784664617`.
|
2. El deploy del commit `f1cd87c` finalizo correctamente.
|
||||||
5. Registrar la verificacion en `RAG/docs/HISTORIAL_SESIONES.md` cuando quede cerrado.
|
3. Se validaron en produccion `health`, playground, sources, retrieve, `/help` y `/openapi.json`.
|
||||||
|
4. El backup `/tmp/opencode/rag-git-backup-1784664617` se conserva hasta que el usuario decida eliminarlo.
|
||||||
|
5. La verificacion queda registrada en `RAG/docs/HISTORIAL_SESIONES.md`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -142,6 +142,8 @@ Estado actual ya conseguido:
|
||||||
- el repo `paco/rag-service` ya existe en Forgejo
|
- el repo `paco/rag-service` ya existe en Forgejo
|
||||||
- el workspace local ya esta conectado al remote `origin`
|
- el workspace local ya esta conectado al remote `origin`
|
||||||
- la rama `main` ya fue subida correctamente
|
- la rama `main` ya fue subida correctamente
|
||||||
|
- desde la migracion `b9a37f2`, el repositorio tiene `Dockerfile`, `src/` y `package.json` en su raiz
|
||||||
|
- en EasyPanel, `Ruta de compilacion` debe ser `/`; el valor anterior `/RAG` provoca que el build busque una carpeta inexistente
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -81,7 +81,12 @@ Dar continuidad al RAG en `RAG/` a partir del estado actual documentado.
|
||||||
- Correccion del estado obsoleto de playground, logs, cleanup, stack y documentos de diseño.
|
- Correccion del estado obsoleto de playground, logs, cleanup, stack y documentos de diseño.
|
||||||
- Correccion de la metodologia: local se limita a compilacion y comprobaciones estaticas; los flujos HTTP se validan tras publicar en produccion.
|
- Correccion de la metodologia: local se limita a compilacion y comprobaciones estaticas; los flujos HTTP se validan tras publicar en produccion.
|
||||||
- Validacion satisfactoria con `npm run check`, `npm run build`, comprobacion de referencias OpenAPI y contraste automatico entre rutas implementadas y documentadas.
|
- Validacion satisfactoria con `npm run check`, `npm run build`, comprobacion de referencias OpenAPI y contraste automatico entre rutas implementadas y documentadas.
|
||||||
|
- Deteccion del build context obsoleto `/RAG` en EasyPanel tras la migracion del repositorio.
|
||||||
|
- Ajuste por el usuario de `Ruta de compilacion` a `/` y despliegue satisfactorio del commit `f1cd87c`.
|
||||||
|
- Validacion en produccion de health, Qdrant, playground, sources, `/help` y `/openapi.json`.
|
||||||
|
- Regresion satisfactoria de retrieval sobre FacturaTech: 6 resultados, cero fugas de scope y coincidencias `504` en los primeros resultados.
|
||||||
|
|
||||||
**Estado final:**
|
**Estado final:**
|
||||||
- Pendiente 1 implementado en local.
|
- Pendiente 1 completado y validado en `https://rag.por-correo.com`.
|
||||||
- Pendiente commit, push, despliegue y validacion en `https://rag.por-correo.com` antes de marcarlo completado.
|
- La API dispone de descubrimiento rapido y contrato OpenAPI para sus 16 operaciones.
|
||||||
|
- Siguiente prioridad: ciclo de vida del conocimiento.
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ Este documento es la fuente canonica del orden de trabajo pendiente del modulo R
|
||||||
|
|
||||||
## 1. Documentacion y descubrimiento de la API
|
## 1. Documentacion y descubrimiento de la API
|
||||||
|
|
||||||
**Estado:** Implementado; pendiente de publicacion y validacion en produccion.
|
**Estado:** Completado y validado en produccion el 2026-09-08.
|
||||||
|
|
||||||
- Implementar `/help` o una especificacion OpenAPI consultable.
|
- Implementar `/help` o una especificacion OpenAPI consultable.
|
||||||
- Actualizar documentos desfasados que todavia muestran como pendientes funciones ya desplegadas, como playground, logs y cleanup.
|
- Actualizar documentos desfasados que todavia muestran como pendientes funciones ya desplegadas, como playground, logs y cleanup.
|
||||||
|
|
|
||||||
|
|
@ -98,7 +98,7 @@ Estado confirmado:
|
||||||
- soporte funcional para `documental` y `codigo`
|
- soporte funcional para `documental` y `codigo`
|
||||||
- API HTTP operativa con ingesta, upload, cleanup, retrieval, answer, chat, catalogo de fuentes/modelos y logs de evaluacion
|
- API HTTP operativa con ingesta, upload, cleanup, retrieval, answer, chat, catalogo de fuentes/modelos y logs de evaluacion
|
||||||
- playground web operativo en `/playground`
|
- playground web operativo en `/playground`
|
||||||
- contrato OpenAPI y ayuda de descubrimiento implementados, pendientes de despliegue
|
- contrato OpenAPI y ayuda de descubrimiento operativos en produccion
|
||||||
|
|
||||||
Pruebas funcionales ya superadas:
|
Pruebas funcionales ya superadas:
|
||||||
- consulta documental sobre pendientes del workspace
|
- consulta documental sobre pendientes del workspace
|
||||||
|
|
|
||||||
|
|
@ -177,7 +177,7 @@ Endpoints funcionales actuales:
|
||||||
- `POST /logs/manual`
|
- `POST /logs/manual`
|
||||||
- `PATCH /logs/:id`
|
- `PATCH /logs/:id`
|
||||||
|
|
||||||
`/help` y `/openapi.json` estan implementados en codigo y quedaran disponibles en produccion tras el siguiente despliegue.
|
`/help` y `/openapi.json` estan operativos y validados en produccion.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue