rocketride-server

机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

从哪里开始

开源，MIT 许可证。 整个引擎都采用 MIT 许可证并符合 OSI 标准。没有企业版，也没有任何付费墙。

功能

快速开始

1. 为您的 IDE 安装扩展。在扩展市场中搜索 RocketRide：

   _{没看到你的 IDE？提交一个问题 · 直接下载}

2. 在您的 IDE 中点击 RocketRide 扩展

3. 部署服务器——系统会提示您选择如何运行服务器。选择适合您设置的选项：

   • 本地（推荐）——这会将服务器直接拉入您的 IDE，无需其他设置。
   • 本地部署——在您自己的硬件上运行服务器，以获得完全控制权和数据驻留。拉取镜像并部署到 Docker，或克隆此仓库并从源码构建。

你的第一个 AI 功能

无论您是构建 Web 应用、集成 API，还是运行后端服务，您已经有了心理模型。

三步骤，无需 API 密钥：

1. 本地运行。 遵循快速开始，在提示时选择 本地。整个安装就这么简单。

2. 打开一个工作流水线。 在您的 IDE 中打开 examples/document-processor.pipe 。提供一个 PDF 或图片，它会提取文本（包括图片内的文本）、识别姓名、地址和其他个人数据，并返回清理后的副本。它在本地模型上运行，因此数据不会离开您的机器。按 ▶ 在源节点上启动它。它的源是一个 webhook ，所以会等待输入——步骤 3 说明如何发送。

3. 从代码中调用它。 现在该流水线是您的服务可以调用的函数。从您在 IDE 中打开的文件夹运行它：扩展会将引擎的连接详情写入 .env 文件中，SDK 会自动读取。从其他地方运行时，客户端会回退到 RocketRide 云。

   pip install rocketride

   import asyncio
   from rocketride import RocketRideClient
   
   async def main():
      async with RocketRideClient() as client:
          run = await client.use(filepath='examples/document-processor.pipe')
          out = await client.send(
              run['token'], 'Alice Smith, 12 Elm St, Springfield.', objinfo={'name': 'note.txt'}, mimetype='text/plain'
          )
          print(out)
          await client.terminate(run['token'])
   
   asyncio.run(main())

   TypeScript 的工作方式相同： npm install rocketride · SDK 文档

接下来的步骤，一步一步来：

• 添加模型。 在源节点和响应节点之间添加一个 llm_* 节点并添加一个 API 密钥。相同的管道，现在循环中有一个 LLM。
• 按意义搜索。 examples/rag-pipeline.pipe 是标准的“对我的文档提问”模式。需要一个 LLM 密钥和一个向量数据库（Qdrant 可以本地运行）。
• 赋予它工具。 一个 代理 节点是允许调用其他节点循环直到完成的 LLM。 examples/agent-workflow.pipe 显示其结构。

构建你的第一个流程

1. 所有管道都采用 *.pipe 格式进行识别。每个管道及其配置都是 JSON 对象——但在您的 IDE 中，扩展将呈现在我们的可视化构建画布中。

2. 所有管道都从源节点开始：webhook、chat 或 dropper。关于具体用法、示例以及构建管道的灵感，请查看我们的 指南和文档。

3. 按类型连接输入通道和输出通道，以正确布线您的管道。某些节点，如代理或大型语言模型（LLM），可以被调用作为父节点使用的工具，如下所示：

4. 您可以通过点击源节点上的 ▶ 按钮，或者直接从 Connection Manager 运行画布中的管道。

5. 部署您的管道 - 选择适合的路径：

   • Docker - 下载 RocketRide 服务器镜像并创建一个容器。需要安装 Docker。

     docker pull ghcr.io/rocketride-org/rocketride-engine:latest
     docker create --name rocketride-engine -p 5565:5565 ghcr.io/rocketride-org/rocketride-engine:latest

   • 本地部署 - 从 Connection Manager 的 部署 页面下载您首选的运行时，作为独立进程使用。

   • RocketRide 云 - 跳过设置，直接使用 托管服务。使用相同的便携式管道 JSON，无需运行基础设施，从原型到生产环境均可使用。立即开始

6. 将您的管道作为独立进程运行，或利用我们的 SDK 集成到现有的 Python 和 TypeScript/JS 应用中。

可观测性

选择运行中的管道可以进行深入分析。跟踪调用树、令牌使用、内存消耗等，以在扩展和部署之前优化您的管道。找到最适合您任务的模型、代理和工具。

文档

docs.rocketride.org 上的所有内容都建立于本仓库的 docs/ 树，并按受众进行了划分。 docs/README.md 是完整地图；简略版本如下：

仓库整体的贡献者规则位于 AGENTS.md。

贡献

好的起点

• 通过一条评论认领一个问题。 在任何未解决的问题上评论 /assign ，它就是你的了。无需权限或会员资格。
• 适合初学者的问题 标记为 good first issue ； help wanted 标记我们希望帮忙解决的更大问题。
• 添加一个节点。 每个节点都是 nodes/src/nodes/ 下的一个小型 Python 包。一个新的提供者、工具或存储是一个不错的首次贡献。指南：添加新节点。
• 修复你刚刚阅读的内容。 欢迎文档的 PR，包括这个 README。

它是如何工作的

• Fork，创建分支为 <type>/RR-<issue>-<short-description> ，针对 develop 打开 PR，并关联问题。完整流程、风格指南和测试命令：CONTRIBUTING.md。
• 整个 monorepo 的构建工具： ./builder 为你管理 C 工具链、Python 环境和 Java/Tika。克隆、构建、运行。
• 角色和决策：GOVERNANCE.md · 发布：RELEASE.md · 安全报告：SECURITY.md · 问题：讨论，Discord，SUPPORT.md

RocketRide 云现已上线

连接需要两条线路。相同的便携式管道 JSON，现在为你托管：

ROCKETRIDE_URI=https://api.rocketride.ai
ROCKETRIDE_AUTH=your-api-token

开始使用   ·   阅读云文档

本地免费 & MIT

用一行代码将客户指向你的本地引擎：

ROCKETRIDE_URI=ws://localhost:5565

快速开始   ·   阅读本地部署文档

准备好发货了吗？将您的管道部署到 RocketRide Cloud，或者在本地运行，免费。