docs / IntroducciónIntroduction
mini-format#
Crea un formato de salida compacto para los JSON de tu dominio. Entrega muestras
representativas una vez y obtén contrato, prompts, parser, validador y herramientas
de reparación. Pide .mini a la IA y recupera la estructura JSON original.
Sitio · Documentación · Descargas · English
Descargar e instalar#
Descarga el kit completo y descomprímelo. Necesitas Python 3.9 o posterior; el paquete se instala sin conexión y no tiene dependencias de ejecución:
python -m pip install --no-index mini_format-1.1.0-py3-none-any.whl
mini build examples/phones.json examples/phones-extra.json --prefix phone --out .mini
También puedes instalar directamente desde la web:
python -m pip install https://mini-format.pmoluna.com/downloads/mini_format-1.1.0-py3-none-any.whl
El ZIP contiene el paquete Python, un paquete Node, ejemplos, documentación y licencia MIT. Las sumas SHA-256 y el código fuente están en la misma web. No necesitas una cuenta de GitHub.
Construye una vez y reutiliza#
mini build combina las muestras para reconocer orden de campos, tipos, objetos
anidados, listas y valores opcionales. Cuanto más representativas sean, más casos
cubren; las muestras no garantizan conocer todos los valores futuros del dominio.
La carpeta .mini/ contiene el contrato, prompts en español e inglés, un parser
Python autónomo, validación, diagnóstico, reparación y ejemplos de ida y vuelta.
El sistema receptor puede ejecutar ese parser sin instalar mini-format.
mini from-json examples/phones.json --contract .mini/contract.json --out phones.mini
mini validate phones.mini --contract .mini/contract.json
mini to-json phones.mini --contract .mini/contract.json --out phones.roundtrip.json
mini diagnose phones.mini --contract .mini/contract.json
Incorpora el prompt a las instrucciones del modelo. La reparación corrige formato inequívoco y prepara una regeneración dirigida para los errores restantes; no inventa datos del negocio. Consulta la guía de integración.
Python y TypeScript#
Se conservan 14 familias del núcleo para evaluación, tarjetas, lecciones, rúbricas, encuestas, programación, eventos, catálogos y otros dominios.
from minifmt import Registry, parse, dumps
contrato = Registry.load().get("a")
documento = parse(texto, contrato)
json_canonico = documento.to_canonical()
Node 22.6+ puede instalar el paquete ESM compilado, con tipos TypeScript y las mismas familias:
npm install ./mini-format-core-1.1.0.tgz
import { Registry, parse, createReader } from '@mini-format/core';
const contrato = Registry.load().get('a');
const documento = parse(texto, contrato);
js/mini.js ofrece un port para navegador sin dependencias. El kit de dominio
generado incluye su propio runtime autónomo y el perfil explícito mini-domain/1.
Las familias existentes conservan SPEC 1.0. Consulta el
perfil de dominio y el protocolo de familias.
Eficiencia medida#
El contrato compartido evita repetir nombres de campo. El ahorro depende de la estructura, escapes, valores repetidos y tokenizador. El benchmark público compara JSON completos y reversibles con JSON compacto e indentado, TOON oficial anidado y aplanado, YAML, XML y CSV. Los costos del contrato y del prompt se muestran por separado. El benchmark original de 14 dominios sigue siendo un experimento independiente del núcleo. Reducir tokens no demuestra por sí solo exactitud del modelo, menor latencia ni ahorro para cualquier JSON.
Desarrollo#
Descomprime el código fuente y ejecuta:
python -m pip install -e ".[bench,release]"
python -m unittest discover -s tests
python conformance/run_python.py
node tests/test_js_port.mjs
node --experimental-strip-types --test ts/test/*.test.ts
mini check-forks
python tools/build_release.py --output dist
python sitio/construir.py
Construir las descargas requiere Node 22.13+. El núcleo y el parser Python generado
usan la biblioteca estándar. El extra opcional bench instala tokenización exacta
(tiktoken y respaldo local con regex), YAML y gráficos; release instala las
herramientas de empaquetado. Consulta contribución y
cambios.
Investigación y licencia#
A. E. J. Palma Obispo y E. J. Palomino Santa Cruz, Universidad Peruana de Ciencias Aplicadas, 2026. Asesores: Jorge Luis Mayta Guillermo y Ronald Mejía Tarazona.
MIT. Los vocabularios, TOON oficial 4.1.1 y datasets conservan sus licencias y la procedencia documentada junto a cada recurso.
mini-format#
Build a compact output format for your JSON domain. Supply representative samples
once; get a reusable contract, prompts, parser, validator and repair tools. Ask
your model for .mini, then recover your original JSON structure.
Website · Documentation · Downloads · Español
Download and install#
Download the complete toolkit and extract it. Python 3.9 or later is required; the wheel installs offline without runtime dependencies:
python -m pip install --no-index mini_format-1.1.0-py3-none-any.whl
mini build examples/phones.json examples/phones-extra.json --prefix phone --out .mini
Or install directly from the site:
python -m pip install https://mini-format.pmoluna.com/downloads/mini_format-1.1.0-py3-none-any.whl
The ZIP contains the Python wheel, a Node package, examples, documentation and the MIT license. SHA-256 checksums and source code are available on the same site. No GitHub account is required.
Build once, reuse#
mini build combines samples to infer field order, types, nested objects, arrays
and optional values. More representative examples cover more cases in your domain;
samples cannot guarantee that every possible future value has been observed.
The generated .mini/ folder includes a contract, English/Spanish prompts, a
standalone Python parser, validation, diagnostics, repair tools and example
round-trips. The receiving system can run the parser without installing mini-format.
mini from-json examples/phones.json --contract .mini/contract.json --out phones.mini
mini validate phones.mini --contract .mini/contract.json
mini to-json phones.mini --contract .mini/contract.json --out phones.roundtrip.json
mini diagnose phones.mini --contract .mini/contract.json
Put the generated prompt in your model instructions. Repair fixes only unambiguous formatting and prepares targeted regeneration for unresolved errors; it never invents missing business data. See the integration guide.
Python and TypeScript#
Fourteen predefined core families remain available for assessments, flashcards, lessons, rubrics, surveys, code exercises, logs, catalogues and other domains.
from minifmt import Registry, parse, dumps
contract = Registry.load().get("a")
document = parse(text, contract)
canonical_json = document.to_canonical()
Node 22.6+ can install the compiled ESM package, including TypeScript source types and the same families:
npm install ./mini-format-core-1.1.0.tgz
import { Registry, parse, createReader } from '@mini-format/core';
const contract = Registry.load().get('a');
const document = parse(text, contract);
A dependency-free browser port is in js/mini.js. The generated domain toolkit
uses its own standalone runtime and explicit mini-domain/1 profile. Existing
core families keep SPEC 1.0; see the domain profile
and forking protocol.
Measured efficiency#
A shared contract removes repeated field names. Savings depend on record shape, escaping, repeated values and tokenizer. The public benchmark compares complete, reversible JSON against compact/pretty JSON, official nested and flattened TOON, YAML, XML and CSV, reporting contract/prompt overhead separately. The original 14-domain results remain a separate core-format experiment. Token savings alone do not establish model accuracy, lower latency or an advantage for every possible JSON document.
Development#
Extract the source archive, then run:
python -m pip install -e ".[bench,release]"
python -m unittest discover -s tests
python conformance/run_python.py
node tests/test_js_port.mjs
node --experimental-strip-types --test ts/test/*.test.ts
mini check-forks
python tools/build_release.py --output dist
python sitio/construir.py
Release construction requires Node 22.13+. The core and generated Python parser
use the standard library. The optional bench extra installs exact tokenization
(tiktoken and a local regex fallback), YAML and plotting; release installs
build tools. See contributing and changes.
Research and license#
A. E. J. Palma Obispo and E. J. Palomino Santa Cruz, Universidad Peruana de Ciencias Aplicadas, 2026. Advisors: Jorge Luis Mayta Guillermo and Ronald Mejía Tarazona.
MIT. Tokenizer vocabularies, official TOON 4.1.1 and public datasets retain their own licenses and provenance recorded alongside each resource.