Skip to content

README_ZH.md

Latest commit

 

History

History
168 lines (118 loc) · 6.1 KB

README_ZH.md

File metadata and controls

168 lines (118 loc) · 6.1 KB
Raw

FlowLLM Logo

Python Version PyPI Version PyPI Downloads GitHub commit activity License English 简体中文 GitHub Stars DeepWiki

FlowLLM: 轻松构建 LLM 应用。

FlowLLM 是一个配置驱动的 LLM 应用框架，用 Service、Job、Step、Component 组织工作流、服务入口和长期组件。

✨ 核心特性

  • 配置驱动：默认从 flowllm/config/default.yaml 启动，支持配置文件和 dot notation 覆盖。
  • 统一链路：CLI / Client -> Service -> Application -> Job -> Step -> Component。
  • 多种 Job 形态：支持同步、流式、后台和定时任务，并可通过 HTTP 或 MCP 暴露。
  • 可插拔组件：通过注册表 R 扩展 Step、Service、Client、LLM、Embedding、Embedding Store 和 Agent Wrapper。

FlowLLM Architecture

🧠 FlowLLM 开发 Skill

FlowLLM 提供面向编程 Agent 的开发 Skill，覆盖框架约定、仓库地图、扩展点、测试流程和 review checklist。

修改或扩展代码库时从这里开始：FlowLLM 开发 Skill。

📝 技术笔记

笔记 说明
上下文管理设计 Agent 短期上下文管理设计，包括历史压缩和工具结果截断。
SELFCOMPACT 论文与 AgentScope PR #1938 SELFCOMPACT 论文、实验结果和 AgentScope 实现 PR 的技术解读。

🚀 快速开始

安装

FlowLLM 要求 Python 3.11+。

从 pip 安装：

pip install flowllm

从源码安装：

git clone https://github.com/flowllm-ai/flowllm.git
cd flowllm
pip install -e .

启动服务

flowllm start

默认服务地址是 127.0.0.1:2333，默认 workspace 是 .flowllm/。可以用 dot notation 覆盖配置：

flowllm start service.port=8181 enable_logo=false
flowllm start workspace_dir=/tmp/flowllm-demo service.host=127.0.0.1 service.port=8181

更多启动和调用示例见 快速开始。

🧩 使用 FlowLLM

flowllm version
flowllm health_check
flowllm help
flowllm demo query="Hello FlowLLM" min_score=0.8
flowllm add a=1 b=2

CLI 的非 start 命令会调用服务端同名 Job。HTTP 入口是 POST /<job_name>：

curl -s http://127.0.0.1:2333/add \
  -H 'Content-Type: application/json' \
  -d '{"a":1,"b":2}'

服务、CLI、HTTP 和流式调用示例见 快速开始。

⚙️ 构建应用

FlowLLM 应用可以从 flowllm/config/default.yaml 或你自己的 YAML/JSON 配置启动。新增能力时，注册 Step 或 Component，再把它暴露成 Job：

jobs:
  reverse:
    backend: base
    description: "reverse text"
    steps:
      - backend: reverse_step

配置支持 .env、${VAR}、${VAR:-default}、dot notation 覆盖和直接指定配置文件：

flowllm start config=/path/to/app.yaml

具体实现规则和示例优先看 FlowLLM 开发 Skill 。简版架构说明见 代码框架。

🆕 极简 CLI Flow

对于不需要完整服务框架的脚本，flowllm.lite 可以把 fl --action --field value 映射到 Pydantic config 和顺序执行的 BaseFlow。见 FlowLLM Lite。

🗺️ Roadmap

项目 说明
Agent wrapper 集成 将 FlowLLM 集成到 Agent wrapper 中，让 Agent 可以根据你的想法自动开发 FlowLLM 的 Step 和 Job。
TypeScript 前端 增加 TypeScript 前端，支持通过前端界面开发 FlowLLM 应用。

📚 文档

🤝 开源与贡献

FlowLLM 使用 Apache 2.0 许可证。贡献前请阅读 贡献指南 和 开发 Skill。

从源码安装开发依赖：

pip install -e ".[dev]"

提交改动前请尽量运行：

pre-commit run --all-files
pytest

📄 License

This project is open source under the Apache License 2.0. See LICENSE for details.

⭐ Star 历史

Star History Chart