mirror of
https://github.com/onestardao/WFGY.git
synced 2026-04-28 19:50:17 +00:00
192 lines
9.9 KiB
Markdown
192 lines
9.9 KiB
Markdown
# Citation-First Prompting — Guardrails and Fix Pattern
|
||
|
||
<details>
|
||
<summary><strong>🧭 Quick Return to Map</strong></summary>
|
||
|
||
<br>
|
||
|
||
> You are in a sub-page of **PromptAssembly**.
|
||
> To reorient, go back here:
|
||
>
|
||
> - [**PromptAssembly** — prompt engineering and workflow composition](./README.md)
|
||
> - [**WFGY Global Fix Map** — main Emergency Room, 300+ structured fixes](../README.md)
|
||
> - [**WFGY Problem Map 1.0** — 16 reproducible failure modes](../../README.md)
|
||
>
|
||
> Think of this page as a desk within a ward.
|
||
> If you need the full triage and all prescriptions, return to the Emergency Room lobby.
|
||
</details>
|
||
|
||
|
||
Stabilize evidence-based answers by **requiring citations before explanation**. This page gives a minimal contract, validation steps, and fast routes to structural fixes when citations vanish, drift, or point to the wrong text.
|
||
|
||
## Open these first
|
||
- Visual map & recovery: [RAG Architecture & Recovery](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md)
|
||
- Snippet traceability & fields: [Retrieval Traceability](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-traceability.md)
|
||
- Contract the payload: [Data Contracts](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md)
|
||
- Ordering control: [Rerankers](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rerankers.md)
|
||
- Long chains & drift: [Context Drift](https://github.com/onestardao/WFGY/blob/main/ProblemMap/context-drift.md), [Entropy Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/entropy-collapse.md)
|
||
- Semantic ≠ cosine: [Embedding ≠ Semantic](https://github.com/onestardao/WFGY/blob/main/ProblemMap/embedding-vs-semantic.md)
|
||
- Reasoning collapse: [Logic Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/logic-collapse.md)
|
||
|
||
## When to use
|
||
- Answers sound right but **show no citations**.
|
||
- Citations appear but **don’t align** with the quoted text.
|
||
- Different runs cite **different sections** for the same question.
|
||
- After reranking, citations drift or vanish.
|
||
- Multi-turn dialogs slowly lose the cite-then-explain order.
|
||
|
||
## Acceptance targets
|
||
- **Cite-then-explain compliance ≥ 0.98** over 50 queries.
|
||
- **Field completeness ≥ 0.99** for: `snippet_id, section_id, source_url, offsets, tokens`.
|
||
- **ΔS(question, retrieved) ≤ 0.45** and stable across 3 paraphrases.
|
||
- **Coverage ≥ 0.70** to the target section.
|
||
- **λ convergent** across two seeds.
|
||
|
||
---
|
||
|
||
## Fix in 60 seconds
|
||
|
||
1) **Enforce the contract**
|
||
The model must cite before any reasoning. Reject outputs that invert the order.
|
||
|
||
2) **Validate fields**
|
||
Require the full snippet schema. Reject partial or fuzzy references.
|
||
|
||
3) **Pin rerank & order**
|
||
If citations change with header tweaks, lock your header order and rerank configuration.
|
||
|
||
4) **Probe ΔS and λ**
|
||
If ΔS stays high while citations look plausible, rebuild chunking or metrics.
|
||
|
||
---
|
||
|
||
## Minimal prompt block to paste
|
||
|
||
```
|
||
|
||
System:
|
||
You must CITE before you EXPLAIN.
|
||
Required fields per snippet: snippet\_id, section\_id, source\_url, offsets, tokens.
|
||
Order is strict:
|
||
|
||
1. "citations": \[...]
|
||
2. "answer": "..."
|
||
|
||
If citations are missing or fields incomplete, STOP and return:
|
||
{"citations": \[], "answer": "", "next\_fix": "open data-contracts & retrieval-traceability"}
|
||
|
||
User:
|
||
Question: "\<user\_question>"
|
||
Top-k retrieved: <passed from retriever>
|
||
Acceptance: ΔS(question,retrieved) ≤ 0.45; coverage ≥ 0.70.
|
||
|
||
````
|
||
|
||
---
|
||
|
||
## JSON response shape (auditable)
|
||
|
||
```json
|
||
{
|
||
"citations": [
|
||
{
|
||
"snippet_id": "S-28391",
|
||
"section_id": "SEC-3.2",
|
||
"source_url": "https://...",
|
||
"offsets": [2312, 2450],
|
||
"tokens": 172
|
||
}
|
||
],
|
||
"answer": "…",
|
||
"λ_state": "→|←|<>|×",
|
||
"ΔS": 0.37
|
||
}
|
||
````
|
||
|
||
---
|
||
|
||
## Typical breakpoints → exact fix
|
||
|
||
* **Citations missing but answer present**
|
||
Reject and re-emit with the contract.
|
||
Open: [Data Contracts](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md)
|
||
|
||
* **Citation fields incomplete or wrong offsets**
|
||
Enforce the full schema, verify offsets/tokens against the corpus.
|
||
Open: [Retrieval Traceability](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-traceability.md)
|
||
|
||
* **High similarity but wrong meaning**
|
||
Rerank or rebuild with correct metric/normalization.
|
||
Open: [Retrieval Playbook](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-playbook.md), [Embedding ≠ Semantic](https://github.com/onestardao/WFGY/blob/main/ProblemMap/embedding-vs-semantic.md)
|
||
|
||
* **Header tweak breaks citations**
|
||
Freeze header order; clamp variance with BBAM.
|
||
Open: [Logic Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/logic-collapse.md)
|
||
|
||
* **Long runs lose citation discipline**
|
||
Split plan, bridge with BBCR; add mid-chain citation checks.
|
||
Open: [Context Drift](https://github.com/onestardao/WFGY/blob/main/ProblemMap/context-drift.md), [Entropy Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/entropy-collapse.md)
|
||
|
||
---
|
||
|
||
## Validator stub (copy into your pipeline)
|
||
|
||
```
|
||
Step 1 parse JSON strictly → if fail, stop.
|
||
Step 2 require citations[].length ≥ 1 before answer.
|
||
Step 3 verify fields & offsets; reject if any missing.
|
||
Step 4 compute ΔS and coverage; block if ΔS>0.45 or coverage<0.70.
|
||
Step 5 log λ across three paraphrases; alert if non-convergent.
|
||
```
|
||
|
||
## Eval gates before ship
|
||
|
||
* Cite-then-explain ≥ 0.98 on 50 queries.
|
||
* Field completeness ≥ 0.99.
|
||
* ΔS ≤ 0.45, coverage ≥ 0.70, λ convergent on two seeds.
|
||
|
||
---
|
||
|
||
### 🔗 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 + \<your question>” |
|
||
| **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)** — <img src="https://img.shields.io/github/stars/onestardao/WFGY?style=social" alt="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).
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/onestardao/WFGY)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlahBlahBlah)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlotBlotBlot)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlocBlocBloc)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlurBlurBlur)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlowBlowBlow)
|
||
|
||
|
||
</div>
|