# dsRAG - Doramagic AI Context Pack > Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated. ## Project - canonical_name: `D-Star-AI/dsRAG` - capability: High-performance retrieval engine for unstructured data - expected_user_outcome: High-performance retrieval engine for unstructured data ## Operating Boundaries - Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it. - Project facts must come from repo evidence, Claim Graph, or explicit source references. - When a capability is not verified, mark it as unverified instead of completing it as fact. - publish_status: `publishable` - blocking_gaps: none --- ## Doramagic Context Augmentation The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints. ## Human Manual Outline Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph. Host AI hard rules: - Do not treat page titles, section order, summaries, or importance values as factual project evidence. - When explaining the Human Manual outline, state that it is only a reading route or salience signal. - Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph. - **Overview & System Architecture**: importance `high` - source_paths: README.md, dsrag/knowledge_base.py, dsrag/create_kb.py, dsrag/add_document.py, mkdocs.yml - **Pluggable Retrieval Components**: importance `high` - source_paths: dsrag/database/vector/db.py, dsrag/database/vector/basic_db.py, dsrag/database/vector/chroma_db.py, dsrag/database/vector/weaviate_db.py, dsrag/database/vector/qdrant_db.py - **Core Retrieval Innovations**: importance `high` - source_paths: dsrag/auto_context.py, dsrag/auto_query.py, dsrag/rse.py, dsrag/dsparse/sectioning_and_chunking/semantic_sectioning.py, dsrag/dsparse/sectioning_and_chunking/chunking.py - **dsParse: Multimodal File Parsing & VLM Integration**: importance `medium` - source_paths: dsrag/dsparse/README.md, dsrag/dsparse/main.py, dsrag/dsparse/file_parsing/vlm_clients.py, dsrag/dsparse/file_parsing/vlm.py, dsrag/dsparse/file_parsing/vlm_file_parsing.py ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `5215e9791133fc1ad383af043fb2fde0e7d4e4d4` - inspected_files: `README.md`, `pyproject.toml`, `requirements.txt`, `docs/api/chat.md`, `docs/api/knowledge_base.md`, `docs/community/contributing.md`, `docs/community/professional-services.md`, `docs/community/support.md`, `docs/concepts/chat.md`, `docs/concepts/citations.md`, `docs/concepts/components.md`, `docs/concepts/config.md`, `docs/concepts/knowledge-bases.md`, `docs/concepts/logging.md`, `docs/concepts/overview.md`, `docs/concepts/vlm.md`, `docs/getting-started/installation.md`, `docs/getting-started/quickstart.md`, `docs/index.md`, `examples/example_kb_data/metadata/levels_of_agi.json` Host AI hard rules: - Without repo_clone_verified=true, do not claim that the source code has been read. - Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts. - Without quick_start_verified=true, do not claim that the Quick Start path has run successfully. ## Doramagic Pitfall Constraints These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes. ### Constraint 1: Installation risk requires verification - Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/D-Star-AI/dsRAG/issues/113 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 2: Configuration risk requires verification - Trigger: Project evidence flags a configuration risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/D-Star-AI/dsRAG/issues/117 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 3: Installation risk requires verification - Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/D-Star-AI/dsRAG/issues/73 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 4: Installation risk requires verification - Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/D-Star-AI/dsRAG/issues/127 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 5: Configuration risk requires verification - Trigger: Project evidence flags a configuration risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/D-Star-AI/dsRAG/issues/116 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 6: Capability evidence risk requires verification - Trigger: README/documentation is current enough for a first validation pass. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: capability.assumptions | https://github.com/D-Star-AI/dsRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 7: Runtime risk requires verification - Trigger: Project evidence flags a runtime risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/D-Star-AI/dsRAG/issues/124 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 8: Maintenance risk requires verification - Trigger: Project evidence flags a maintenance risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: evidence.maintainer_signals | https://github.com/D-Star-AI/dsRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 9: Security or permission risk requires verification - Trigger: no_demo - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: downstream_validation.risk_items | https://github.com/D-Star-AI/dsRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 10: Security or permission risk requires verification - Trigger: no_demo - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: risks.scoring_risks | https://github.com/D-Star-AI/dsRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.