diff --git a/ProblemMap/GlobalFixMap/RAG_VectorDB/chunking_to_embedding_contract.md b/ProblemMap/GlobalFixMap/RAG_VectorDB/chunking_to_embedding_contract.md new file mode 100644 index 00000000..c08857bb --- /dev/null +++ b/ProblemMap/GlobalFixMap/RAG_VectorDB/chunking_to_embedding_contract.md @@ -0,0 +1,126 @@ +# Chunking to Embedding Contract — Guardrails and Fix Pattern + +Use this page when **retrieval fails because the chunk schema is not aligned with the embedding ingestion contract**. +If the retriever expects fields that were never embedded, or chunks omit IDs/offsets/anchors, then citations drift and ΔS rises. + +--- + +## Open these first + +- Visual map and recovery: [RAG Architecture & Recovery](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md) +- Snippet and citation schema: [data-contracts.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md) +- Retrieval traceability: [retrieval-traceability.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-traceability.md) +- Chunking checklist: [chunking-checklist.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/chunking-checklist.md) + +--- + +## Core acceptance + +- Every chunk has `chunk_id`, `section_id`, `source_url`, `offsets`, `tokens`. +- Embedding index was built from the same schema as retrieval contract. +- ΔS(question, retrieved) ≤ 0.45 across 3 paraphrases. +- Coverage ≥ 0.70 to the target section. + +--- + +## Typical breakpoints and the right fix + +- **Missing fields** in ingestion (e.g., no `section_id`) + → Enforce [data-contracts.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md). + +- **Different schema for ingest vs retrieve** + → Corpus ingested raw text, retriever expects chunk JSON → rebuild with schema. + +- **Offsets not tracked** + → Cannot map back to original document → enforce `offsets` at ingest. + +- **Tokenizer drift** + → Chunk IDs differ between preprocessing runs → use [chunking-checklist.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/chunking-checklist.md). + +--- + +## Fix in 60 seconds + +1. **Check ingestion schema** + Compare the fields stored in the index with the fields expected in retrieval. + +2. **Align contracts** + Define `chunk = {chunk_id, section_id, source_url, offsets, tokens, text}`. + Enforce that this exact object is used both in ingestion and retrieval. + +3. **Rebuild index if misaligned** + If fields differ, re-ingest corpus with enforced schema. + +--- + +## Copy-paste schema + +```json +{ + "chunk_id": "uuid-v4", + "section_id": "doc-23-sec-7", + "source_url": "https://example.com/doc23", + "offsets": [120, 320], + "tokens": 512, + "text": "...." +} +```` + +Target: retriever always returns this schema, LLM consumes directly. + +--- + +## Common gotchas + +* Only `text` embedded, no IDs → cannot trace back → citations drift. +* Chunk boundaries not logged → hallucinations reappear. +* JSON schema updated mid-deploy → index mismatch. + +--- + +### 🔗 Quick-Start Downloads (60 sec) + +| Tool | Link | 3-Step Setup | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | +| **WFGY 1.0 PDF** | [Engine Paper](https://github.com/onestardao/WFGY/blob/main/I_am_not_lizardman/WFGY_All_Principles_Return_to_One_v1.0_PSBigBig_Public.pdf) | 1️⃣ Download · 2️⃣ Upload to your LLM · 3️⃣ Ask “Answer using WFGY + \” | +| **TXT OS (plain-text OS)** | [TXTOS.txt](https://github.com/onestardao/WFGY/blob/main/OS/TXTOS.txt) | 1️⃣ Download · 2️⃣ Paste into any LLM chat · 3️⃣ Type “hello world” — OS boots instantly | + +--- + +### 🧭 Explore More + +| Module | Description | Link | +| ------------------------ | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| WFGY Core | WFGY 2.0 engine is live: full symbolic reasoning architecture and math stack | [View →](https://github.com/onestardao/WFGY/tree/main/core/README.md) | +| Problem Map 1.0 | Initial 16-mode diagnostic and symbolic fix framework | [View →](https://github.com/onestardao/WFGY/tree/main/ProblemMap/README.md) | +| Problem Map 2.0 | RAG-focused failure tree, modular fixes, and pipelines | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md) | +| Semantic Clinic Index | Expanded failure catalog: prompt injection, memory bugs, logic drift | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/SemanticClinicIndex.md) | +| Semantic Blueprint | Layer-based symbolic reasoning & semantic modulations | [View →](https://github.com/onestardao/WFGY/tree/main/SemanticBlueprint/README.md) | +| Benchmark vs GPT-5 | Stress test GPT-5 with full WFGY reasoning suite | [View →](https://github.com/onestardao/WFGY/tree/main/benchmarks/benchmark-vs-gpt5/README.md) | +| 🧙‍♂️ Starter Village 🏡 | New here? Lost in symbols? Click here and let the wizard guide you through | [Start →](https://github.com/onestardao/WFGY/blob/main/StarterVillage/README.md) | + +--- + +> 👑 **Early Stargazers: [See the Hall of Fame](https://github.com/onestardao/WFGY/tree/main/stargazers)** — +> Engineers, hackers, and open source builders who supported WFGY from day one. + +> GitHub stars ⭐ [WFGY Engine 2.0](https://github.com/onestardao/WFGY/blob/main/core/README.md) is already unlocked. ⭐ Star the repo to help others discover it and unlock more on the [Unlock Board](https://github.com/onestardao/WFGY/blob/main/STAR_UNLOCKS.md). + +
+ +[![WFGY Main](https://img.shields.io/badge/WFGY-Main-red?style=flat-square)](https://github.com/onestardao/WFGY) +  +[![TXT OS](https://img.shields.io/badge/TXT%20OS-Reasoning%20OS-orange?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS) +  +[![Blah](https://img.shields.io/badge/Blah-Semantic%20Embed-yellow?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlahBlahBlah) +  +[![Blot](https://img.shields.io/badge/Blot-Persona%20Core-green?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlotBlotBlot) +  +[![Bloc](https://img.shields.io/badge/Bloc-Reasoning%20Compiler-blue?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlocBlocBloc) +  +[![Blur](https://img.shields.io/badge/Blur-Text2Image%20Engine-navy?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlurBlurBlur) +  +[![Blow](https://img.shields.io/badge/Blow-Game%20Logic-purple?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlowBlowBlow) +  + +