bijux-rag¶
bijux-rag preserves the earlier distribution, import, and command names for
bijux-canon-ingest. The canonical package owns source identity,
normalization, chunking, deterministic preparation results, and typed ingest
failures.
Despite the preserved “RAG” name, this bridge does not own vector retrieval, claim reasoning, or orchestration. Those decisions belong to index, reason, and agent respectively.
Choose The Actual Capability¶
| Need | Package | Ownership boundary |
|---|---|---|
preserve a deployed bijux-rag dependency, import, or command |
bijux-rag |
compatibility identity only |
| normalize and chunk source material | bijux-canon-ingest |
deterministic preparation |
| execute vector search and rank results | bijux-canon-index |
retrieval execution and evidence |
| construct and verify claims | bijux-canon-reason |
reasoning and provenance |
| coordinate roles or whole flows | bijux-canon-agent or bijux-canon-runtime |
orchestration or run lifecycle |
Identity Contract¶
| Surface | Preserved identity | Canonical identity |
|---|---|---|
| distribution | bijux-rag |
bijux-canon-ingest |
| Python root | bijux_rag |
bijux_canon_ingest |
| console command | bijux-rag |
bijux-canon-ingest |
| nested CLI module | bijux_rag.interfaces.cli.entrypoint |
bijux_canon_ingest.interfaces.cli.entrypoint |
| representative nested type | bijux_rag.core.types.RawDoc |
bijux_canon_ingest.core.types.RawDoc |
flowchart LR
source["source bytes or records"]
legacy["bijux-rag identity"]
bridge["same-version ingest bridge"]
output["canonical prepared output"]
downstream["index, reason, or application"]
source --> legacy --> bridge --> output --> downstream
The built bridge depends on exactly the same version of
bijux-canon-ingest. Its public root follows the canonical facade, nested
module aliases return canonical module objects, and its command routes directly
to the ingest entrypoint.
How Code And Data Boundaries Relate¶
The bijux_rag root forwards the canonical package's declared exports. Its
alias finder maps non-local nested paths to the same suffix under
bijux_canon_ingest, retaining the canonical module and class identities.
sequenceDiagram
participant P as Preparation pipeline
participant B as bijux_rag facade
participant I as bijux_canon_ingest
participant D as Downstream consumer
P->>B: import RawDoc or call bijux-rag
B->>I: resolve canonical code
I-->>P: prepared result or typed failure
P->>D: pass canonical preparation output
D-->>P: accept or reject boundary contract
Code identity is only one half of migration. A pipeline can import the same class and still fail because source configuration, normalization assumptions, cache keys, or artifact readers differ. Validate the complete data boundary used by the consumer.
Existing And Canonical Usage¶
Existing automation remains callable:
The canonical form for new work is:
The two RawDoc imports identify the same canonical class. An alias import
therefore does not introduce a competing document model.
Both bijux-rag and python -m bijux_rag call the canonical ingest CLI. The
bridge does not translate source identifiers, content, chunking parameters,
structured results, typed failures, or exit status.
Migrate The Whole Preparation Boundary¶
Replacing the dependency and imports is necessary but may not be sufficient. Inspect command invocations, source configuration, serialized dotted paths, prepared artifact readers, cache keys, container images, and downstream code that assumes an older output layout. Validate a representative document from source through the first downstream consumer.
Migration acceptance should retain evidence that:
- package manifests and lock files resolve
bijux-canon-ingest; - source, plugins, configuration, and serialized metadata use
bijux_canon_ingest; - scripts, images, schedulers, and runbooks invoke
bijux-canon-ingest; - representative inputs preserve source IDs, normalization, chunk boundaries, result variants, failures, and downstream acceptance;
- deployed environments no longer independently request
bijux-rag.
Current ingest semantics and supported facade live in the ingest handbook. The bridge proves delegation and selected identity invariants; it does not certify arbitrary private paths or every historical prepared artifact. Artifact and cache compatibility require consumer-owned evidence from representative data.
Repository Ownership¶
Current source, issues, release metadata, and documentation are owned by
bijux/bijux-canon. Treat the former bijux/bijux-rag repository as
historical context rather than a parallel implementation source.
Continue with command surfaces for executable behavior and migration guidance for the full surface checklist.