Quick Start
1
Install the knowledge extra
2
Run the three-check marker test
Follow the decision tree top to bottom: install → search → chat. All three must pass before you trust RAG.
Symptom: “Indexed OK, but agent answers generically”
Search returns the right chunks, but the agent answers from its own memory — a silent hallucination against your own docs. Before (broken):Verification recipe
Run this marker test against a fresh install. It proves both that search finds the chunk and thatchat() actually uses it.
Why a unique marker matters
Generic questions can get a lucky correct guess from the model’s parametric knowledge, giving a false pass. Use a non-memorisable token likeZEBRA-QUOTA-9917 so a correct answer can only come from your documents.
This silent grounding failure in sync
chat() / start() was fixed in PR #5109 (merged 2026-09-17, closing #5098). The retrieved context now reaches the LLM prompt for both text and multimodal (attachment) paths. The async path was already correct. The fix shipped on main on 2026-09-17; it is released in the next praisonaiagents version. If your SEARCH_OK=True but CHAT_OK=False, upgrade praisonaiagents.Interim workaround (pinned to an older release)
If you cannot upgrade yet, inject the retrieved context into the prompt yourself:Symptom: ModuleNotFoundError: No module named 'chonkie'
The knowledge extra (which bundles the chonkie chunker) is not installed.
Symptom: chat is grounded but the wrong chunks come back
CHAT_OK passes, but the cited chunks are off-topic — a retrieval-quality problem, not a grounding one. Tune reranking and chunker settings.
RAG Strategies
Choose chunking and retrieval strategies for your corpus.
RAG Quality
Reranking and quality filters for better chunk selection.
Best Practices
Always run the marker test after wiring up knowledge
Always run the marker test after wiring up knowledge
A unique token like
ZEBRA-QUOTA-9917 turns “it looks configured” into a SEARCH_OK + CHAT_OK pass/fail you can trust.Never trust SEARCH_OK on its own
Never trust SEARCH_OK on its own
Retrieval succeeding does not prove the agent used the result. Assert
CHAT_OK too.Pin the knowledge extra in your project
Pin the knowledge extra in your project
Add
"praisonaiagents[knowledge]" to requirements so chonkie is always present across environments.Upgrade before reaching for workarounds
Upgrade before reaching for workarounds
The manual context-injection workaround is only for pinned-old releases; upgrading removes the need entirely.
Related
Knowledge Quick Start
Pass files to an agent and start asking questions.
RAG Quickstart
Get retrieval-augmented answers in a few steps.
Knowledge Indexing Errors
Diagnose empty indexes and embedding-backend failures.
Knowledge Search Results
Understand the shape of
knowledge.search() results.
