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 提供商、嵌入器和向量数据库。

⚡ 快速开始

选项 A：使用 pyspur Python 包

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

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. [可选] 自定义部署: 你可以通过两种方式自定义你的 PySpur 部署：

   a. 通过应用（推荐）： - 在应用中导航至 API 密钥标签页 - 添加各供应商的 API 密钥（例如 OpenAI、Anthropic 等） - 更改会立即生效

   b. 手动配置： - 编辑项目目录中的 .env 文件 - 建议在 .env 中配置 Postgres 数据库以获得更高的可靠性 - 使用 pyspur serve 重启应用；如果不使用 Postgres，请添加 --sqlite

选项 B：使用 Docker（推荐用于可扩展的生产系统）

这是生产部署的推荐方式：

1. 安装 Docker: 首先，根据你的操作系统，按照官方安装指南安装 Docker：

   • Linux 上的 Docker
   • Mac 上的 Docker Desktop

2. 创建 PySpur 项目: 安装 Docker 后，使用以下命令创建一个新的 PySpur 项目：

   curl -fsSL https://raw.githubusercontent.com/PySpur-com/pyspur/main/start_pyspur_docker.sh | bash -s pyspur-project

   这将：

   • 在名为 pyspur-project 的新目录中启动一个新的 PySpur 项目
   • 设置所需的配置文件
   • 自动启动由本地 Postgres Docker 实例支持的 PySpur 应用

3. 访问 PySpur: 在浏览器中访问 http://localhost:6080。

4. [可选] 自定义部署: 你可以通过两种方式自定义你的 PySpur 部署：

   a. 通过应用（推荐）： - 在应用中导航至 API 密钥标签页 - 添加各供应商的 API 密钥（例如 OpenAI、Anthropic 等） - 更改会立即生效

   b. 手动配置： - 编辑项目目录中的 .env 文件 - 使用以下命令重启服务： sh docker compose up -d

就这么简单！点击 “New Spur” 创建工作流，或从内置模板开始。

✨ 核心优势

节点级调试：

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_* 变量。

⭐ 支持我们

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

我们非常感谢你的反馈。 请 告诉我们 你希望下一个看到列表中的哪些功能，或请求全新的功能。