Add enriquecimiento data structure to README
- Documents all enrichment fields available - Shows interaction with extraccion.tags_sugeridos - Explains mutability rules - Links to contratos-comunes schema
This commit is contained in:
47
README.md
47
README.md
@@ -40,6 +40,53 @@ FELDMAN ─────────────────┘
|
|||||||
| Novato | Usa mucho este espacio |
|
| Novato | Usa mucho este espacio |
|
||||||
| Avanzado | Paso casi automático |
|
| Avanzado | Paso casi automático |
|
||||||
|
|
||||||
|
## Estructura de Datos
|
||||||
|
|
||||||
|
MASON trabaja con la seccion `enriquecimiento` del contenedor (ver [esquema completo](https://git.tzzr.me/tzzr/contratos-comunes/src/branch/main/architecture/06-contenedor-schema.md)):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"enriquecimiento": {
|
||||||
|
"notas": "Pendiente de pago",
|
||||||
|
"campos_personalizados": {
|
||||||
|
"proyecto": "Proyecto Alpha",
|
||||||
|
"responsable": "Juan Garcia"
|
||||||
|
},
|
||||||
|
"tags_confirmados": ["sha256-tag1", "sha256-tag2"],
|
||||||
|
"tags_rechazados": ["sha256-tag3"],
|
||||||
|
"correcciones": {
|
||||||
|
"texto": null,
|
||||||
|
"entidades": null
|
||||||
|
},
|
||||||
|
"editado_por": "usuario-id",
|
||||||
|
"editado_at": "2025-01-15T11:00:00Z"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Campos disponibles
|
||||||
|
|
||||||
|
| Campo | Tipo | Descripcion |
|
||||||
|
|-------|------|-------------|
|
||||||
|
| `notas` | String | Texto libre del usuario |
|
||||||
|
| `campos_personalizados` | Object | Campos key-value definidos por usuario |
|
||||||
|
| `tags_confirmados` | Array | h_maestro de tags sugeridos aceptados |
|
||||||
|
| `tags_rechazados` | Array | h_maestro de tags sugeridos descartados |
|
||||||
|
| `correcciones.texto` | String | Texto corregido si OCR fallo |
|
||||||
|
| `correcciones.entidades` | Object | Entidades corregidas |
|
||||||
|
|
||||||
|
### Interaccion con extraccion
|
||||||
|
|
||||||
|
MASON muestra los `tags_sugeridos` de la seccion `extraccion` para que el usuario:
|
||||||
|
- Confirme (se mueven a `enriquecimiento.tags_confirmados`)
|
||||||
|
- Rechace (se mueven a `enriquecimiento.tags_rechazados`)
|
||||||
|
|
||||||
|
### Mutabilidad
|
||||||
|
|
||||||
|
- `enriquecimiento` es **mutable** mientras el registro esta en MASON
|
||||||
|
- Una vez enviado a FELDMAN, se congela
|
||||||
|
- Si FELDMAN devuelve el registro, vuelve a ser editable
|
||||||
|
|
||||||
## Arquitectura
|
## Arquitectura
|
||||||
|
|
||||||
Ver documentación completa en [contratos-comunes/architecture](https://git.tzzr.me/tzzr/contratos-comunes/src/branch/main/architecture/03-mason.md)
|
Ver documentación completa en [contratos-comunes/architecture](https://git.tzzr.me/tzzr/contratos-comunes/src/branch/main/architecture/03-mason.md)
|
||||||
|
|||||||
Reference in New Issue
Block a user