# ragbuilder - Doramagic AI Context Pack > 定位：安装前体验与判断资产。它帮助宿主 AI 有一个好的开始，但不代表已经安装、执行或验证目标项目。 ## 充分原则 - **充分原则，不是压缩原则**：AI Context Pack 应该充分到让宿主 AI 在开工前理解项目价值、能力边界、使用入口、风险和证据来源；它可以分层组织，但不以最短摘要为目标。 - **压缩策略**：只压缩噪声和重复内容，不压缩会影响判断和开工质量的上下文。 ## 给宿主 AI 的使用方式 你正在读取 Doramagic 为 ragbuilder 编译的 AI Context Pack。请把它当作开工前上下文：帮助用户理解适合谁、能做什么、如何开始、哪些必须安装后验证、风险在哪里。不要声称你已经安装、运行或执行了目标项目。 ## Claim 消费规则 - **事实来源**：Repo Evidence + Claim/Evidence Graph；Human Wiki 只提供显著性、术语和叙事结构。 - **事实最低状态**：`supported` - `supported`：可以作为项目事实使用，但回答中必须引用 claim_id 和证据路径。 - `weak`：只能作为低置信度线索，必须要求用户继续核实。 - `inferred`：只能用于风险提示或待确认问题，不能包装成项目事实。 - `unverified`：不得作为事实使用，应明确说证据不足。 - `contradicted`：必须展示冲突来源，不得替用户强行选择一个版本。 ## 它最适合谁 - **想在安装前理解开源项目价值和边界的用户**：当前证据主要来自项目文档。 证据：`README.md` Claim：`clm_0002` supported 0.86 ## 它能做什么 - **命令行启动或安装流程**（需要安装后验证）：项目文档中存在可执行命令，真实使用需要在本地或宿主环境中运行这些命令。 证据：`install.sh` Claim：`clm_0001` supported 0.86 ## 怎么开始 - `curl -fsSL https://raw.githubusercontent.com/KruxAI/ragbuilder/main/Brewfile -o Brewfile` 证据：`install.sh` Claim：`clm_0003` supported 0.86 ## 继续前判断卡 - **当前建议**：需要管理员/安全审批 - **为什么**：继续前可能涉及密钥、账号、外部服务或敏感上下文，建议先经过管理员或安全审批。 ### 30 秒判断 - **现在怎么做**：需要管理员/安全审批 - **最小安全下一步**：先跑 Prompt Preview；若涉及凭证或企业环境，先审批再试装 - **先别相信**：真实输出质量不能在安装前相信。 - **继续会触碰**：命令执行、本地环境或项目文件、环境变量 / API Key ### 现在可以相信 - **适合人群线索：想在安装前理解开源项目价值和边界的用户**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`README.md` Claim：`clm_0002` supported 0.86 - **能力存在：命令行启动或安装流程**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`install.sh` Claim：`clm_0001` supported 0.86 - **存在 Quick Start / 安装命令线索**（supported）：可以相信项目文档出现过启动或安装入口；不要因此直接在主力环境运行。 证据：`install.sh` Claim：`clm_0003` supported 0.86 ### 现在还不能相信 - **真实输出质量不能在安装前相信。**（unverified）：Prompt Preview 只能展示引导方式，不能证明真实项目中的结果质量。 - **宿主 AI 版本兼容性不能在安装前相信。**（unverified）：Claude、Cursor、Codex、Gemini 等宿主加载规则和版本差异必须在真实环境验证。 - **不会污染现有宿主 AI 行为，不能直接相信。**（inferred）：Skill、plugin、AGENTS/CLAUDE/GEMINI 指令可能改变宿主 AI 的默认行为。 - **可安全回滚不能默认相信。**（unverified）：除非项目明确提供卸载和恢复说明，否则必须先在隔离环境验证。 - **真实安装后是否与用户当前宿主 AI 版本兼容？**（unverified）：兼容性只能通过实际宿主环境验证。 - **项目输出质量是否满足用户具体任务？**（unverified）：安装前预览只能展示流程和边界，不能替代真实评测。 - **安装命令是否需要网络、权限或全局写入？**（unverified）：这影响企业环境和个人环境的安装风险。 证据：`install.sh` ### 继续会触碰什么 - **命令执行**：包管理器、网络下载、本地插件目录、项目配置或用户主目录。 原因：运行第一条命令就可能产生环境改动；必须先判断是否值得跑。 证据：`install.sh` - **本地环境或项目文件**：安装结果、插件缓存、项目配置或本地依赖目录。 原因：安装前无法证明写入范围和回滚方式，需要隔离验证。 证据：`install.sh` - **环境变量 / API Key**：项目入口文档明确出现 API key、token、secret 或账号凭证配置。 原因：如果真实安装需要凭证，应先使用测试凭证并经过权限/合规判断。 证据：`README.md`, `src/ragbuilder/langchain_module/embedding_model/embedding.py`, `src/ragbuilder/langchain_module/llms/llmConfig.py`, `src/ragbuilder/langchain_module/retriever/retriever.py` - **宿主 AI 上下文**：AI Context Pack、Prompt Preview、Skill 路由、风险规则和项目事实。 原因：导入上下文会影响宿主 AI 后续判断，必须避免把未验证项包装成事实。 ### 最小安全下一步 - **先跑 Prompt Preview**：用安装前交互式试用判断工作方式是否匹配，不需要授权或改环境。（适用：任何项目都适用，尤其是输出质量未知时。） - **只在隔离目录或测试账号试装**：避免安装命令污染主力宿主 AI、真实项目或用户主目录。（适用：存在命令执行、插件配置或本地写入线索时。） - **不要使用真实生产凭证**：环境变量/API key 一旦进入宿主或工具链，可能产生账号和合规风险。（适用：出现 API、TOKEN、KEY、SECRET 等环境线索时。） - **安装后只验证一个最小任务**：先验证加载、兼容、输出质量和回滚，再决定是否深用。（适用：准备从试用进入真实工作流时。） ### 退出方式 - **保留安装前状态**：记录原始宿主配置和项目状态，后续才能判断是否可恢复。 - **记录安装命令和写入路径**：没有明确卸载说明时，至少要知道哪些目录或配置需要手动清理。 - **准备撤销测试 API key 或 token**：测试凭证泄露或误用时，可以快速止损。 - **如果没有回滚路径，不进入主力环境**：不可回滚是继续前阻断项，不应靠信任或运气继续。 ## 哪些只能预览 - 解释项目适合谁和能做什么 - 基于项目文档演示典型对话流程 - 帮助用户判断是否值得安装或继续研究 ## 哪些必须安装后验证 - 真实安装 Skill、插件或 CLI - 执行脚本、修改本地文件或访问外部服务 - 验证真实输出质量、性能和兼容性 ## 边界与风险判断卡 - **把安装前预览误认为真实运行**：用户可能高估项目已经完成的配置、权限和兼容性验证。 处理方式：明确区分 prompt_preview_can_do 与 runtime_required。 Claim：`clm_0004` inferred 0.45 - **命令执行会修改本地环境**：安装命令可能写入用户主目录、宿主插件目录或项目配置。 处理方式：先在隔离环境或测试账号中运行。 证据：`install.sh` Claim：`clm_0005` supported 0.86 - **待确认**：真实安装后是否与用户当前宿主 AI 版本兼容？。原因：兼容性只能通过实际宿主环境验证。 - **待确认**：项目输出质量是否满足用户具体任务？。原因：安装前预览只能展示流程和边界，不能替代真实评测。 - **待确认**：安装命令是否需要网络、权限或全局写入？。原因：这影响企业环境和个人环境的安装风险。 ## 开工前工作上下文 ### 加载顺序 - 先读取 how_to_use.host_ai_instruction，建立安装前判断资产的边界。 - 读取 claim_graph_summary，确认事实来自 Claim/Evidence Graph，而不是 Human Wiki 叙事。 - 再读取 intended_users、capabilities 和 quick_start_candidates，判断用户是否匹配。 - 需要执行具体任务时，优先查 role_skill_index，再查 evidence_index。 - 遇到真实安装、文件修改、网络访问、性能或兼容性问题时，转入 risk_card 和 boundaries.runtime_required。 ### 任务路由 - **命令行启动或安装流程**：先说明这是安装后验证能力，再给出安装前检查清单。 边界：必须真实安装或运行后验证。 证据：`install.sh` Claim：`clm_0001` supported 0.86 ### 上下文规模 - 文件总数：377 - 重要文件覆盖：40/377 - 证据索引条目：49 - 角色 / Skill 条目：1 ### 证据不足时的处理 - **missing_evidence**：说明证据不足，要求用户提供目标文件、README 段落或安装后验证记录；不要补全事实。 - **out_of_scope_request**：说明该任务超出当前 AI Context Pack 证据范围，并建议用户先查看 Human Manual 或真实安装后验证。 - **runtime_request**：给出安装前检查清单和命令来源，但不要替用户执行命令或声称已执行。 - **source_conflict**：同时展示冲突来源，标记为待核实，不要强行选择一个版本。 ## Prompt Recipes ### 适配判断 - 目标：判断这个项目是否适合用户当前任务。 - 预期输出：适配结论、关键理由、证据引用、安装前可预览内容、必须安装后验证内容、下一步建议。 ```text 请基于 ragbuilder 的 AI Context Pack，先问我 3 个必要问题，然后判断它是否适合我的任务。回答必须包含：适合谁、能做什么、不能做什么、是否值得安装、证据来自哪里。所有项目事实必须引用 evidence_refs、source_paths 或 claim_id。 ``` ### 安装前体验 - 目标：让用户在安装前感受核心工作流，同时避免把预览包装成真实能力或营销承诺。 - 预期输出：一段带边界标签的体验剧本、安装后验证清单和谨慎建议；不含真实运行承诺或强营销表述。 ```text 请把 ragbuilder 当作安装前体验资产，而不是已安装工具或真实运行环境。 请严格输出四段： 1. 先问我 3 个必要问题。 2. 给出一段“体验剧本”：用 [安装前可预览]、[必须安装后验证]、[证据不足] 三种标签展示它可能如何引导工作流。 3. 给出安装后验证清单：列出哪些能力只有真实安装、真实宿主加载、真实项目运行后才能确认。 4. 给出谨慎建议：只能说“值得继续研究/试装”“先补充信息后再判断”或“不建议继续”，不得替项目背书。 硬性边界： - 不要声称已经安装、运行、执行测试、修改文件或产生真实结果。 - 不要写“自动适配”“确保通过”“完美适配”“强烈建议安装”等承诺性表达。 - 如果描述安装后的工作方式，必须使用“如果安装成功且宿主正确加载 Skill，它可能会……”这种条件句。 - 体验剧本只能写成“示例台词/假设流程”：使用“可能会询问/可能会建议/可能会展示”，不要写“已写入、已生成、已通过、正在运行、正在生成”。 - Prompt Preview 不负责给安装命令；如用户准备试装，只能提示先阅读 Quick Start 和 Risk Card，并在隔离环境验证。 - 所有项目事实必须来自 supported claim、evidence_refs 或 source_paths；inferred/unverified 只能作风险或待确认项。 ``` ### 角色 / Skill 选择 - 目标：从项目里的角色或 Skill 中挑选最匹配的资产。 - 预期输出：候选角色或 Skill 列表，每项包含适用场景、证据路径、风险边界和是否需要安装后验证。 ```text 请读取 role_skill_index，根据我的目标任务推荐 3-5 个最相关的角色或 Skill。每个推荐都要说明适用场景、可能输出、风险边界和 evidence_refs。 ``` ### 风险预检 - 目标：安装或引入前识别环境、权限、规则冲突和质量风险。 - 预期输出：环境、权限、依赖、许可、宿主冲突、质量风险和未知项的检查清单。 ```text 请基于 risk_card、boundaries 和 quick_start_candidates，给我一份安装前风险预检清单。不要替我执行命令，只说明我应该检查什么、为什么检查、失败会有什么影响。 ``` ### 宿主 AI 开工指令 - 目标：把项目上下文转成一次对话开始前的宿主 AI 指令。 - 预期输出：一段边界明确、证据引用明确、适合复制给宿主 AI 的开工前指令。 ```text 请基于 ragbuilder 的 AI Context Pack，生成一段我可以粘贴给宿主 AI 的开工前指令。这段指令必须遵守 not_runtime=true，不能声称项目已经安装、运行或产生真实结果。 ``` ## 角色 / Skill 索引 - 共索引 1 个角色 / Skill / 项目文档条目。 - **Readme**（project_doc）：! RagBuilder logo ./assets/ragbuilder dark.png gh-dark-mode-only ! RagBuilder logo ./assets/ragbuilder light.png gh-light-mode-only 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`README.md` ## 证据索引 - 共索引 49 条证据。 - **Readme**（documentation）：! RagBuilder logo ./assets/ragbuilder dark.png gh-dark-mode-only ! RagBuilder logo ./assets/ragbuilder light.png gh-light-mode-only 证据：`README.md` - **License**（source_file）：Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ 证据：`LICENSE` - **Init**（source_file）：module dir = os.path.dirname file ⋮---- module name = filename :-3 证据：`byor/__init__.py` - **Docker Compose**（source_file）：version: "3.8" services: neo4j: build: ./neo4j ports: - "7474:7474" - "7687:7687" environment: NEO4J AUTH: "neo4j/ragbuilder" NEO4J apoc export file enabled: "true" NEO4J apoc import file enabled: "true" NEO4J apoc import file use neo4j config: "true" NEO4J dbms security procedures unrestricted: "apoc. " volumes: - ./data:/data networks: - custom-network ragbuilder: image: ashwinzyx/ragbuilder:latest ports: - "55003:8005" volumes: - .:/ragbuilder env file: - .env depends on: - neo4j command: "ragbuilder" networks: - custom-network networks: custom-network: driver: bridge 证据：`docker-compose.yml` - **Install**（source_file）：echo Installing RagBuilder setlocal EnableDelayedExpansion 证据：`install.bat` - **Install**（source_file）：set -e echo "Downloading Brewfile..." curl -fsSL https://raw.githubusercontent.com/KruxAI/ragbuilder/main/Brewfile -o Brewfile echo "Installing Homebrew packages..." brew bundle install --file=Brewfile echo "Installing ragbuilder..." python3 -m pip install ragbuilder echo "Setup completed successfully." 证据：`install.sh` - **Optional dependencies**（source_file）：project name = "ragbuilder" dynamic = "version" description = "RagBuilder SDK - Create optimal Production-ready RAG pipelines" authors = {name = "Ashwin Aravind", email = "ashwin@krux.ai"}, {name = "Aravind Parameswaran", email = "aravind@krux.ai"}, requires-python = " =3.7" readme = "README.md" license = {text = "Apache-2.0"} 证据：`pyproject.toml` - **Start Server**（source_file）：def main ⋮---- parser = argparse.ArgumentParser description='Start the RAG server.' ⋮---- args = parser.parse args ⋮---- builder = RAGBuilder.from source with defaults 证据：`start_server.py` - **Init**（source_file）：version = "unknown version" ⋮---- all = 'RAGBuilder', ' version ' 证据：`src/ragbuilder/__init__.py` - **Init**（source_file）：all = 证据：`src/ragbuilder/config/__init__.py` - **Base**（source_file）：class LLMConfig BaseModel ⋮---- model config = {"protected namespaces": , "arbitrary types allowed": True} ⋮---- type: Optional LLMType = None model kwargs: Optional Dict str, Any = Field default=None, description="Model-specific parameters like model name/type" initialized llm: Optional Union BaseChatModel, BaseLLM = PrivateAttr default=None ⋮---- @property def llm self - Optional Union BaseChatModel, BaseLLM ⋮---- llm class = LLM MAP self.type ⋮---- @classmethod def from llm cls, llm: Union BaseChatModel, BaseLLM - 'LLMConfig' ⋮---- class EmbeddingConfig BaseModel ⋮---- type: Optional EmbeddingType = None model kwargs: Optional Dict str, Any = None custom class: Optional str = None initia… 证据：`src/ragbuilder/config/base.py` - **Component type definitions**（source_file）：@dataclass class PkgSpec ⋮---- install name: str import name: str = "" ⋮---- def post init self ⋮---- def validate self - str ⋮---- Component type definitions class GraphType str, Enum ⋮---- NEO4J = "neo4j" ⋮---- class LLMType str, Enum ⋮---- OPENAI = "openai" AZURE OPENAI = "azure openai" HUGGINGFACE = "huggingface" OLLAMA = "ollama" COHERE = "cohere" VERTEXAI = "vertexai" BEDROCK = "bedrock" JINA = "jina" CUSTOM = "custom" ⋮---- class ParserType str, Enum ⋮---- TEXT = "text" UNSTRUCTURED = "unstructured" PYMUPDF = "pymupdf" PYPDF = "pypdf" DOCX = "docx" AZURE BLOB = "azure blob" S3 = "s3" DIRECTORY = "directory" WEB = "web" ⋮---- class ChunkingStrategy str, Enum ⋮---- CHARACTER = "Charact… 证据：`src/ragbuilder/config/components.py` - **Init**（source_file）：all = 'DBLoggerCallback', 'ConfigStore', 'DocumentStore', 'setup rich logging', 'console' 证据：`src/ragbuilder/core/__init__.py` - **Create directory structure**（source_file）：DEFAULT DB PATH = "eval.db" ⋮---- class RAGBuilder ⋮---- SUPPORTED VECTORSTORES: Dict str, str = { ⋮---- data ingest config = DataIngestOptionsConfig.with defaults ⋮---- config = GenerationOptionsConfig.with defaults ⋮---- @classmethod def from yaml cls, file path: str - 'RAGBuilder' ⋮---- config dict = yaml.safe load f ⋮---- builder = cls ⋮---- def ensure eval dataset self, config: Union DataIngestOptionsConfig, RetrievalOptionsConfig, GenerationOptionsConfig - None ⋮---- source data = getattr config, 'input source', None or ⋮---- test dataset = self. test dataset manager.get or generate eval dataset ⋮---- """ Run data ingestion optimization Returns: Dict containing optimization results in… 证据：`src/ragbuilder/core/builder.py` - **Config Store**（source_file）：class ConfigMetadata BaseModel ⋮---- timestamp: datetime score: float source module: str additional info: Optional Dict str, Any = None ⋮---- class ConfigStore ⋮---- instance = None configs: Dict str, Dict str, Any = {} metadata: Dict str, ConfigMetadata = {} best data ingest pipeline = None best retriever pipeline = None best generator pipeline = None default llm: Optional LLMConfig = None default embeddings: Optional EmbeddingConfig = None default n trials: Optional int = None ⋮---- def new cls ⋮---- @classmethod def set default llm cls, llm config: Optional Union Dict str, Any , LLMConfig, BaseChatModel, BaseLLM - None ⋮---- @classmethod def get default llm cls - LLMConfig ⋮---- @classme… 证据：`src/ragbuilder/core/config_store.py` - **Results**（source_file）：class ModuleResults BaseModel ⋮---- best config: Any best score: float best pipeline: Any ⋮---- n trials: int completed trials: int optimization time: float ⋮---- avg latency: Optional float = None error rate: Optional float = None ⋮---- model config = ConfigDict arbitrary types allowed=True ⋮---- def get statistics self - Dict str, Any ⋮---- class DataIngestResults ModuleResults ⋮---- best index: Any ⋮---- def get vectorstore self ⋮---- def get config summary self - Dict str, Any ⋮---- embedding type = self.best config.embedding model.type ⋮---- embedding type = self.best config.embedding model. initialized embedding. class . name ⋮---- embedding type = "unknown" ⋮---- model name = None ⋮-… 证据：`src/ragbuilder/core/results.py` - **Custom Components**（source_file）：class ContextualChunker TextSplitter ⋮---- def split text self, text: str - List str ⋮---- temp doc = Document page content=text processed docs = self.split documents temp doc ⋮---- def split documents self, documents: List Document - List Document ⋮---- splitter = RecursiveCharacterTextSplitter chunk size=self.chunk size, chunk overlap=self.chunk overlap splits = splitter.split documents documents ⋮---- document array = ⋮---- chunk length = len split.page content ⋮---- context length = int chunk length 0.1 ⋮---- chunk group = splits max 0, i - 5 :min len splits , i + 6 chunk content = self.format docs split ⋮---- chunk group content = self.format docs chunk group ⋮---- prompt = f''' ⋮----… 证据：`src/ragbuilder/custom_components.py` - **Resolve the processors using their library and function names**（source_file）：logger = logging.getLogger "ragbuilder" ⋮---- DATA PROCESSORS = ⋮---- def resolve processor processor name: str ⋮---- class DataProcessor ⋮---- def init self, data source: str, data processors: list = None ⋮---- Resolve the processors using their library and function names ⋮---- def is url self, path: str - bool ⋮---- result = urlparse path ⋮---- def apply processors self - str ⋮---- path = Path self.data source ⋮---- data = self.data source ⋮---- data = processor data ⋮---- def process directory self, dir path: str - str ⋮---- processed dir = f"{dir path} processed" ⋮---- files = f for f in Path dir path .rglob ' ' if f.is file and f.name != '.DS Store' args = str f , f'{processed dir}/{st… 证据：`src/ragbuilder/data_processor.py` - **Define the configuration space**（source_file）：current working directory = os.getcwd ⋮---- dotenv path = os.path.join current working directory, '.env' ⋮---- logger = logging.getLogger "ragbuilder" ⋮---- RUN CONFIG TIMEOUT = int os.getenv 'RUN CONFIG TIMEOUT', '240' RUN CONFIG MAX WORKERS = int os.getenv 'RUN CONFIG MAX WORKERS', '16' RUN CONFIG MAX WAIT = int os.getenv 'RUN CONFIG MAX WAIT', '180' RUN CONFIG MAX RETRIES = int os.getenv 'RUN CONFIG MAX RETRIES', '10' RUN CONFIG IS ASYNC = os.getenv 'RUN CONFIG IS ASYNC', 'true' .lower == 'true' OVERRIDE BASELINE RETRIEVERS = os.getenv 'OVERRIDE BASELINE RETRIEVERS', 'true' .lower == 'true' DATABASE = 'eval.db' ⋮---- SINGLESTOREDB URL = os.getenv "SINGLESTOREDB URL" PGVECTOR CONNECTION S… 证据：`src/ragbuilder/executor.py` - **Init**（source_file）：all = 证据：`src/ragbuilder/generation/__init__.py` - **Init**（source_file）：def check graph dependencies 证据：`src/ragbuilder/graph_utils/__init__.py` - **Init**（source_file）：version = "unknown version" ⋮---- all = "run ragbuilder"," version " 证据：`src/ragbuilder/langchain_module/__init__.py` - **Init**（source_file）：version = "unknown version" ⋮---- all = "run ragbuilder"," version " 证据：`src/ragbuilder/langchain_module/retriever/__init__.py` - **Init**（source_file）：version = "unknown version" ⋮---- all = "run ragbuilder"," version " 证据：`src/ragbuilder/langchain_module/vectordb/__init__.py` - **If no modules were found, print a message or handle as needed**（source_file）：module dir = os.path.dirname file ⋮---- modules found = False ⋮---- module name = filename :-3 ⋮---- modules found = True Mark that at least one module was found ⋮---- If no modules were found, print a message or handle as needed 证据：`src/ragbuilder/rag_templates/sota/__init__.py` - **Graph Rag**（source_file）：code="""from langchain core.runnables import RunnablePassthrough 证据：`src/ragbuilder/rag_templates/sota/graph_rag.py` - **Graph Rag Hybrid**（source_file）：code="""from langchain core.runnables import RunnablePassthrough 证据：`src/ragbuilder/rag_templates/sota/graph_rag_hybrid.py` - **Hybrid Rag**（source_file）：code="""from langchain community.llms import Ollama 证据：`src/ragbuilder/rag_templates/sota/hybrid_rag.py` - **Hyde**（source_file）：code="""from langchain community.llms import Ollama 证据：`src/ragbuilder/rag_templates/sota/hyde.py` - **Semantic Chunker**（source_file）：code="""from langchain community.llms import Ollama 证据：`src/ragbuilder/rag_templates/sota/semantic_chunker.py` - **Check if column exists**（source_file）：logger = logging.getLogger "ragbuilder" LOG FILENAME = logger.handlers 0 .baseFilename LOG DIRNAME = Path LOG FILENAME .parent BASE DIR = Path file .resolve .parent ⋮---- url = "http://localhost:8005" ⋮---- app = FastAPI DATABASE = 'eval.db' BAYES OPT = 1 CURRENT RUN ID = 0 ⋮---- templates = Jinja2Templates directory=Path BASE DIR, 'templates' ⋮---- def basename path ⋮---- def get db ⋮---- db = sqlite3.connect DATABASE, check same thread=False ⋮---- def get hashmap db: sqlite3.Connection = Depends get db ⋮---- cur = db.execute 'SELECT hash, test data path FROM synthetic data hashmap' rows = cur.fetchall ⋮---- def insert hashmap hash: str, path: str, db: sqlite3.Connection ⋮---- insert query… 证据：`src/ragbuilder/ragbuilder.py` - **Chat**（source_file）：{% extends "layouts.html" %} {% block content %} Chat Playground for Eval ID: {{ eval id }} Send let currentSessionId = null; var evalId = document.getElementById 'chat-container' .getAttribute 'data-eval-id' ; $ document .ready function { // const evalId = $ '.container' .data 'eval-id' ; $ '.chat-messages' .append ' Loading... Initializing chat session... ' ; console.log evalId $.ajax { url: /create chat session , method: 'POST', contentType: 'application/json', data: JSON.stringify { eval id: evalId } , success: function response { currentSessionId = response.session id; console.log currentSessionId $ '.chat-messages' .empty ; $ ' sendMessage' .prop 'disabled', false ; }, error: function… 证据：`src/ragbuilder/templates/chat.html` - **Details**（source_file）：{% extends "layouts.html" %} {% block content %} Evaluation Details Question ID Question {% if module type == 'ui workflow' %} Answer Contexts Ground Truth Answer Correctness Faithfulness Answer Relevancy Context Precision Context Recall Tokens Cost / 1K Queries {% elif module type == 'data ingest' %} Retrieved Chunks Relevance Scores Weighted Score Error Latency Timestamp {% elif module type == 'retriever' %} Contexts Ground Truth Context Precision Context Recall F1 Score Error Latency Timestamp {% elif module type == 'generation' %} Answer Correctness {% endif %} {% for detail in details %} {{ detail.question id }} {{ detail.question :30 if detail.question is not none else ' null ' }} ...… 证据：`src/ragbuilder/templates/details.html` - **Index**（source_file）：{% extends "layouts.html" %} {% block content %} RagBuilder: Performance Dashboard New Project Status All Completed Pending Filter Run ID Status Type Description Source Data Run Config Disabled Options Timestamp Results Log {% for run in runs %} {{ run.run id }} {{ run.status }} {{ run.module type }} {{ run.description }} {% if run.src data %} {% if run.src data length 55 %} {{ run.src data :55 }} ... {% else %} {{ run.src data }} {% endif %} {% if run.src data length 55 %} {{ run.src data }} ➕ {% endif %} {% else %} None {% endif %} {{ run.run config :30 }} ... {{ run.run config }} ➕ {% if run.disabled opts %} {{ run.disabled opts :30 }} ... {% else %} None {% endif %} {{ run.disabled opts… 证据：`src/ragbuilder/templates/index.html` - **Init**（source_file）：version = "0.1.0" all = 'app' 证据：`src/ragbuilder_ui/__init__.py` - **.dockerignore**（source_file）：.dockerignore .log .env .csv .log .pyc .db .DS Store .dockerignore .git .gitignore venv/ 证据：`.dockerignore` - **Description: Environment variables for the project. Rename to .env file for use**（source_file）：Description: Environment variables for the project. Rename to .env file for use OPENAI API KEY=XXXXXXXXX MISTRAL API KEY=XXXXXXXXX MIXPANEL TOKEN=XXXXXXXXX HUGGINGFACEHUB API TOKEN=XXXXXXXXX COHERE API KEY=XXXXXXXXX JINA API KEY=XXXXXXXXX ENABLE ANALYTICS=True SINGLESTOREDB URL=userid:password@host:port/dbname PINECONE API KEY=XXXXXXXXX GROQ API KEY=XXXXXXXXX AZURE OPENAI API KEY=XXXXXXXXX AZURE OPENAI ENDPOINT=https://XXXXXXXXX.openai.azure.com/ OPENAI API VERSION=2024-02-01 GOOGLE API KEY=AIzaSyDN2-XXXXXXXXX GOOGLE CLOUD PROJECT=projectid GOOGLE APPLICATION CREDENTIALS=credentials.json must be placed in the folder where docker is run PGVECTOR CONNECTION STRING=postgresql+psycopg://langcha… 证据：`.env-Sample` - **Use an official Python runtime as a parent image**（source_file）：Use an official Python runtime as a parent image FROM python:3.12.3-slim 证据：`Dockerfile` - **Arxiv.783857**（source_file）：,question,contexts,ground truth,evolution type,metadata,episode done 0,What kind of practical exercises or resources can be offered to help manage symptoms and improve mental wellbeing?," '\nYour\n\napproach\n\nAs the patient shares their struggles, you will provide insightful guidance and evidence-based strategies tailored to their unique needs. You may also offer practical exercises or resources to help them manage their symptoms and improve their mental wellbeing. When necessary, you will gently redirect the conversation back to the patient\'s primary concerns related to anxiety, mental health, or family issues. This ensures that each session is productive and focused on addressing the m… 证据：`SampleSyntheticDataFiles/arxiv.783857.sample` - **Lilianweng**（source_file）：,question,contexts,ground truth,evolution type,metadata,episode done 0,What is the process followed by GPT-Engineer to create a repository of code given a task specified in natural language?," ' practice file naming convention.\nMake sure that files contain all imports, types etc. Make sure that code in different files are compatible with each other.\nEnsure to implement all code, if you are unsure, write a plausible implementation.\nInclude module dependency or package manager dependency definition file.\nBefore you finish, double check that all parts of the architecture is present in the files.\nUseful to know:\nYou almost always put different classes in different files.\nFor Python, you… 证据：`SampleSyntheticDataFiles/lilianweng.sample` - **Rag**（source_file）：,question,contexts,ground truth,evolution type,metadata,episode done 0,What is the purpose of calculating cosine similarity between two word vectors?," '.6Vector embeddings exampledef word to vector word : Define some basic rules for our vector components vector = 0 5 Initialize a vector of 5 dimensions Rule 1: Length of the word normalized to a max of 10 characters for simplicity vector 0 = len word / 10 Rule 2: Number of vowels in the word normalized to the length of the word vowels = \'aeiou\' vector 1 = sum 1 for char in word if char in vowels / len word Rule 3: Whether the word starts with a vowel 1 or not 0 vector 2 = 1 if word 0 in vowels else 0 Rule 4: Whether the word ends with a v… 证据：`SampleSyntheticDataFiles/rag.sample` - **Myrag**（source_file）：def rag pipeline ⋮---- def format docs docs ⋮---- llm = Ollama model='llama3.1:latest',base url='http://localhost:11434' ⋮---- loader = WebBaseLoader 'https://ashwinaravind.github.io/' docs = loader.load ⋮---- embedding = OllamaEmbeddings model='mxbai-embed-large:latest',base url='http://localhost:11434' ⋮---- splitter = RecursiveCharacterTextSplitter chunk size=1600, chunk overlap=200 splits=splitter.split documents docs c=Chroma.from documents documents=splits, embedding=embedding, collection name='testindex-ragbuilder', retrievers= retriever=c.as retriever search type='similarity', search kwargs={'k': 5} ⋮---- retriever=MergerRetriever retrievers=retrievers prompt = hub.pull "rlm/rag-pro… 证据：`byor/myrag.py` - **Dockerfile**（source_file）：ENV NEO4JLABS PLUGINS ' "apoc" ' ENV NEO4J dbms security procedures unrestricted apoc. 证据：`neo4j/Dockerfile` - **Pytest**（source_file）：pytest addopts = --strict-markers markers = core: marks tests as slow deselect with '-m "not slow"' serial timeout = 50 log cli=true log level=DEBUG log format = % asctime s % levelname s % message s log date format = %Y-%m-%d %H:%M:%S log file = logs/pytest-logs.txt minversion = 7.2 required plugins = pytest-xdist =3.2.0 pytest-env =0.8.0 证据：`pytest.ini` - **Rag Prompts**（source_file）：{"locale":"en","featureFlags": "alive longer retries","bypass copilot indexing quota","copilot new references ui","copilot beta features opt in","copilot chat retry on error","copilot chat persist submitted input","copilot conversational ux history refs","copilot editor upsells","copilot free limited user","copilot implicit context","copilot no floating button","copilot smell icebreaker ux","experimentation azure variant endpoint","failbot handle non errors","geojson azure maps","ghost pilot confidence truncation 25","ghost pilot confidence truncation 40","hovercard accessibility","issues advanced search","issues react close as duplicate","issues react new timeline","issues react avatar ref… 证据：`rag_prompts.yml` - **Ragbuilder Sdk Demo**（source_file）：{ "cells": { "cell type": "markdown", "metadata": {}, "source": " RAGBuilder Optimization Demo" }, { "cell type": "code", "execution count": null, "metadata": {}, "outputs": , "source": "!uv venv" }, { "cell type": "code", "execution count": null, "metadata": {}, "outputs": , "source": "!source .venv/bin/activate" }, { "cell type": "code", "execution count": null, "metadata": {}, "outputs": , "source": " First clone the RAGBuilder repo\n", "!uv pip install ragbuilder" }, { "cell type": "markdown", "metadata": {}, "source": " Quickstart - Basic Configuration" }, { "cell type": "code", "execution count": 1, "metadata": {}, "outputs": , "source": "from ragbuilder import RAGBuilder" }, { "cell… 证据：`ragbuilder_sdk_demo.ipynb` - **sample data.txt**（source_file）：sample data.txt This is a sample document for testing the RAGBuilder data ingestion pipeline. It contains multiple sentences to demonstrate chunking. We'll use this to test our parser, chunker, embedder, and indexer components. The goal is to ensure that our pipeline works end-to-end with a simple configuration. 证据：`sample_data.txt` - **Sample Questions**（source_file）：What is the purpose of this document? What does this document show? What all components will we test? 证据：`sample_questions.txt` - **Test Pipeline Options**（source_file）：input source: "sample data.txt" test dataset: "sample questions.txt" document loaders: - type: "unstructured" loader kwargs: {} chunking strategies: - "RecursiveCharacterTextSplitter" - "CharacterTextSplitter" - "custom" chunk size: min: 100 max: 500 stepsize: 100 chunk overlap: 50, 100 embedding models: - type: "openai" model: "text-embedding-3-small" - type: "huggingface" model: "sentence-transformers/all-MiniLM-L6-v2" vector databases: - type: "chroma" collection name: "test collection" persist directory: "chroma sample2" collection metadata: "hnsw:space": "cosine" - type: "faiss" normalize L2: true top k: 3 sampling rate: null optimization: n trials: 10 timeout: 600 storage: "sqlite:///… 证据：`test_pipeline_options.yaml` ## 宿主 AI 必须遵守的规则 - **把本资产当作开工前上下文，而不是运行环境。**：AI Context Pack 只包含证据化项目理解，不包含目标项目的可执行状态。 证据：`README.md`, `LICENSE`, `byor/__init__.py` - **回答用户时区分可预览内容与必须安装后才能验证的内容。**：安装前体验的消费者价值来自降低误装和误判，而不是伪装成真实运行。 证据：`README.md`, `LICENSE`, `byor/__init__.py` ## 用户开工前应该回答的问题 - 你准备在哪个宿主 AI 或本地环境中使用它？ - 你只是想先体验工作流，还是准备真实安装？ - 你最在意的是安装成本、输出质量、还是和现有规则的冲突？ ## 验收标准 - 所有能力声明都能回指到 evidence_refs 中的文件路径。 - AI_CONTEXT_PACK.md 没有把预览包装成真实运行。 - 用户能在 3 分钟内看懂适合谁、能做什么、如何开始和风险边界。 --- ## Doramagic Context Augmentation 下面内容用于强化 Repomix/AI Context Pack 主体。Human Manual 只提供阅读骨架；踩坑日志会被转成宿主 AI 必须遵守的工作约束。 ## Human Manual 骨架 使用规则：这里只是项目阅读路线和显著性信号，不是事实权威。具体事实仍必须回到 repo evidence / Claim Graph。 宿主 AI 硬性规则： - 不得把页标题、章节顺序、摘要或 importance 当作项目事实证据。 - 解释 Human Manual 骨架时，必须明确说它只是阅读路线/显著性信号。 - 能力、安装、兼容性、运行状态和风险判断必须引用 repo evidence、source path 或 Claim Graph。 - **项目概览与快速开始**：importance `high` - source_paths: README.md, pyproject.toml, install.sh, install.bat, Dockerfile - **核心 SDK RAGBuilder 与模块化架构**：importance `high` - source_paths: src/ragbuilder/ragbuilder.py, src/ragbuilder/core/builder.py, src/ragbuilder/core/config_store.py, src/ragbuilder/core/results.py, src/ragbuilder/config/base.py - **SOTA 模板、GraphRAG 与优化评估**：importance `high` - source_paths: src/ragbuilder/rag_templates/sota/graph_rag.py, src/ragbuilder/rag_templates/sota/graph_rag_hybrid.py, src/ragbuilder/rag_templates/sota/hybrid_rag.py, src/ragbuilder/rag_templates/sota/hyde.py, src/ragbuilder/rag_templates/sota/contextul_retriever.py - **API 部署、Web UI、安全与运维**：importance `high` - source_paths: start_server.py, src/ragbuilder/executor.py, src/ragbuilder/ragbuilder_ui/__init__.py, src/ragbuilder/templates/index.html, src/ragbuilder/templates/chat.html ## Repo Inspection Evidence / 源码检查证据 - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `5b084512d65042d9207ba19331176963fe005dd8` - inspected_files: `Dockerfile`, `README.md`, `docker-compose.yml`, `pyproject.toml`, `src/__init__.py`, `src/ragbuilder/__init__.py`, `src/ragbuilder/analytics.py`, `src/ragbuilder/config/__init__.py`, `src/ragbuilder/config/base.py`, `src/ragbuilder/config/components.py`, `src/ragbuilder/config/data_ingest.py`, `src/ragbuilder/config/generation.py`, `src/ragbuilder/config/retriever.py`, `src/ragbuilder/core/__init__.py`, `src/ragbuilder/core/builder.py`, `src/ragbuilder/core/callbacks.py`, `src/ragbuilder/core/config_store.py`, `src/ragbuilder/core/document_store.py`, `src/ragbuilder/core/exceptions.py`, `src/ragbuilder/core/logging_utils.py` 宿主 AI 硬性规则： - 没有 repo_clone_verified=true 时，不得声称已经读过源码。 - 没有 repo_inspection_verified=true 时，不得把 README/docs/package 文件判断写成事实。 - 没有 quick_start_verified=true 时，不得声称 Quick Start 已跑通。 ## Doramagic Pitfall Constraints / 踩坑约束 这些规则来自 Doramagic 发现、验证或编译过程中的项目专属坑点。宿主 AI 必须把它们当作工作约束，而不是普通说明文字。 ### Constraint 1: 来源证据：Custom RAG configuration not respected for retrievers - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：Custom RAG configuration not respected for retrievers - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/KruxAI/ragbuilder/issues/69 | 来源讨论提到 python 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 2: 来源证据：GraphRAG - vector search - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：GraphRAG - vector search - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/KruxAI/ragbuilder/issues/57 | 来源讨论提到 python 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 3: 来源证据：Installation Failure on macOS: No Response After Upgrading ca-certificates and Installing Cairo - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：Installation Failure on macOS: No Response After Upgrading ca-certificates and Installing Cairo - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/KruxAI/ragbuilder/issues/55 | 来源讨论提到 macos 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 4: 来源证据：RAGAS error - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：RAGAS error - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/KruxAI/ragbuilder/issues/70 | 来源讨论提到 python 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 5: 来源证据：Cannot run the app due to OpenAI rate limit breach - Trigger: GitHub 社区证据显示该项目存在一个安全/权限相关的待验证问题：Cannot run the app due to OpenAI rate limit breach - Why it matters: 可能影响授权、密钥配置或安全边界。 - Evidence: community_evidence:github | https://github.com/KruxAI/ragbuilder/issues/28 | 来源类型 github_issue 暴露的待验证使用条件。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 6: 来源证据：/install.sh failing with "curl: (56) The requested URL returned error: 404" - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：/install.sh failing with "curl: (56) The requested URL returned error: 404" - Why it matters: 可能影响升级、迁移或版本选择。 - Evidence: community_evidence:github | https://github.com/KruxAI/ragbuilder/issues/89 | 来源类型 github_issue 暴露的待验证使用条件。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 7: 来源证据：GraphRag: loading graph error - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：GraphRag: loading graph error - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/KruxAI/ragbuilder/issues/83 | 来源类型 github_issue 暴露的待验证使用条件。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 8: 来源证据：Improve Error Handling and Efficiency in `data_processor.py` - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：Improve Error Handling and Efficiency in `data_processor.py` - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/KruxAI/ragbuilder/issues/71 | 来源讨论提到 python 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 9: 能力判断依赖假设 - Trigger: README/documentation is current enough for a first validation pass. - Host AI rule: 将假设转成下游验证清单。 - Why it matters: 假设不成立时，用户拿不到承诺的能力。 - Evidence: capability.assumptions | https://github.com/KruxAI/ragbuilder | README/documentation is current enough for a first validation pass. - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 10: 维护活跃度未知 - Trigger: 未记录 last_activity_observed。 - Host AI rule: 补 GitHub 最近 commit、release、issue/PR 响应信号。 - Why it matters: 新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。 - Evidence: evidence.maintainer_signals | https://github.com/KruxAI/ragbuilder | last_activity_observed missing - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。