El proyecto por dentro¶
Lo que crea init tiene dueños distintos. Saber de quién es cada fichero dice qué se puede
editar y qué se regenera.
mi-repo/
├── .env compartido: lo leen el chatbot y database/
├── database/ tai-sql, del repositorio
│ ├── schemas/auth.py usuarios, roles, permisos y sesiones
│ └── schemas/chatbot.py conversaciones, mensajes, catálogo y consumo
└── chatbot/
├── .taichatproject el marcador: por él te encuentran los comandos
├── config.yaml la declaración del chatbot
├── marca/ sus logos
├── .env.compose derivado: los puertos del compose
├── api/ tai-api
│ ├── rbac/chatbot.py los roles del chatbot
│ └── api/
│ ├── .config.json derivado: el agente, los WebSocket y el consumo
│ ├── database/ generado: el cliente de datos (DAOs y DTOs)
│ └── routers/
│ ├── database/ generado: el CRUD de cada tabla
│ ├── auth/ generado: login, sesión y permisos
│ └── custom/assistant/ el asistente: tuyo
├── app/front/ React
│ └── src/
│ ├── api/ generado: el cliente TypeScript de tai-api
│ │ └── custom/ las llamadas a /assistant y /rbac: tuyo
│ └── marca/ derivado: nombre, logos, colores e idioma
└── docker-compose.yaml
De quién es cada cosa¶
| De quién | Se edita | Se regenera con | |
|---|---|---|---|
config.yaml, marca/ |
Tuyo | Sí | — |
api/rbac/chatbot.py |
Tuyo | Sí | — |
database/schemas/*.py |
Tuyo (tai-sql) | Sí | — |
routers/custom/assistant/ (el asistente) |
Tuyo | Sí | — |
app/front/src/ salvo api y marca, y src/api/custom/ |
Tuyo | Sí | — |
.config.json, src/marca/, .env.compose |
Derivado de config.yaml |
No | tai-chat config generate |
api/database/, routers/database/, routers/auth/ |
tai-api | No | tai-chat api generate |
src/api/, salvo custom/ |
tai-api | No | tai-chat api generate |
Lo derivado lleva una marca —«Generado por…»— y se sobrescribe sin preguntar. Si un derivado no dice lo que quieres, se cambia su declaración.
Lo que copia init es tuyo¶
El asistente, el front y config.yaml se copian una vez. A partir de ahí son del proyecto: una
versión nueva de tai-chat no los toca. Lo que tenga que hacer un proyecto ya creado para tener lo de
una versión nueva está en Migraciones.
Desde cualquier carpeta¶
Los comandos buscan el proyecto por su marcador (.taichatproject) hacia arriba y entre los hijos,
así que funcionan desde la raíz, desde database/ o desde chatbot/api/. Si hay más de un chatbot
en el repositorio, se elige con -p <nombre>.
Las otras herramientas¶
tai-chat presta los CLI de las dos librerías, resueltos contra el proyecto:
tai-chat sql push -s chatbot # tai-sql: llevar un schema a la base de datos
tai-chat api generate # tai-api: regenerar la API y el cliente TypeScript
tai-chat api rbac push -r chatbot # tai-api: llevar los roles
Y tai-api también funciona a mano, indicándole dónde está su proyecto: