README_CN.md

PySpur 是一个基于 Python 编写的 AI 智能体构建器。AI 工程师使用它来构建智能体，逐步执行并检查过去的运行记录。

hero.mp4

🕸️ 为什么选择 PySpur?

• ✅ 测试驱动：构建工作流，运行测试用例，并进行迭代。
• 👤 人在环路中：持久化工作流，等待人工批准或拒绝。
• 🔄 循环：具有记忆功能的迭代工具调用。
• 📤 文件上传：上传文件或粘贴 URL 来处理文档。
• 📋 结构化输出：JSON Schema UI 编辑器。
• 🗃️ RAG：解析、分块、嵌入并将数据更新到向量数据库。
• 🖼️ 多模态：支持视频、图像、音频、文本、代码。
• 🧰 工具：Slack、Firecrawl.dev、Google Sheets、GitHub 等。
• 🧪 评估：在真实数据集上评估代理。
• 🚀 一键部署：发布为 API 并在任意地方集成。
• 🐍 基于 Python：通过创建单个 Python 文件来添加新节点。
• 🎛️ 供应商支持：支持超过 100 个 LLM 供应商、嵌入器和向量数据库。

⚡ 快速开始

这是入门的最快方式。需要 Python 3.11 或更高版本。

1. 安装 PySpur:

   pip install pyspur

2. 初始化新项目:

   pyspur init my-project
   cd my-project

   这将创建一个包含 .env 文件的新目录。

3. 启动服务器:

   pyspur serve --sqlite

   默认情况下，这将使用 SQLite 数据库在 http://localhost:6080 启动 PySpur 应用。 我们建议你在 .env 文件中配置 Postgres 实例的 URL，以获得更稳定的体验。

4. [可选] 配置环境和添加 API 密钥:

   • 应用界面: 导航至 API 密钥标签页添加供应商密钥（OpenAI、Anthropic 等）
   • 手动配置: 编辑 .env 文件（推荐：配置 postgres）并使用 pyspur serve 重启

✨ 核心优势

人在环路中断点:

这些断点在达到时会暂停工作流，并在人工批准后恢复。 它们为需要质量保证的工作流提供人工监督：在工作流继续之前验证关键输出。

HIL.mp4

节点级调试：

visualization.mp4

多模态（上传文件或粘贴 URL）

支持 PDF、视频、音频、图像等……

multimodal.mp4

循环

RAG

步骤 1) 创建文档集合（分块 + 解析）

RAG_1.mp4

步骤 2) 创建向量索引（嵌入 + 向量数据库插入）

RAG_2.mp4

模块化构建块

blocks.mp4

评估最终性能

evals.mp4

即将推出：自我提升

optimization.mp4

🛠️ PySpur 开发环境设置

[ Unix 类系统开发指南。Windows/PC 开发不支持。 ]

开发时，请按照以下步骤操作：

1. 克隆仓库:

   git clone https://github.com/PySpur-com/pyspur.git
   cd pyspur

2. 使用 docker-compose.dev.yml 启动:

   docker compose -f docker-compose.dev.yml up --build -d

   这将启动一个本地 PySpur 实例，并启用热重载以便开发。

3. 自定义你的设置: 编辑 .env 文件以配置你的环境。默认情况下，PySpur 使用本地 PostgreSQL 数据库。若要使用外部数据库，请修改 .env 中的 POSTGRES_* 变量。

⭐ 支持我们

你可以通过给我们项目 Star 来支持我们的工作！谢谢！

我们非常重视你的反馈。 请 告诉我们 你想在下一次看到列表中的哪些功能或全新的功能。