README_cn.md

📃 Flock (Flexible Low-code Orchestrating Collaborative-agent Kits)

简体中文 | English | 日本語 | 快速开始

Tip

🎉 最新更新 2024/11/12

• 意图识别节点: 新增意图识别节点,可以根据预设的类别自动识别用户输入的意图,支持多分类路由!

• CrewAI 节点支持: 现在您可以在工作流中使用 CrewAI 的强大多代理功能！轻松创建复杂的代理团队并编排复杂的协作任务。

Flock 是一个基于工作流 workflow 的低代码平台，用于快速构建聊天机器人、RAG 应用和协调多代理团队。它基于 LangChain 和 LangGraph 构建，提供灵活的低代码编排协作代理解决方案，支持聊天机器人、RAG 应用、代理和多代理系统，并具备离线运行能力。

flock.mp4

🤖️ 概览

工作流

节点类型和功能

Flock 的工作流系统由各种类型的节点组成，每种节点都有特定的用途：

1. 输入节点：处理初始输入并将其转换为工作流可处理的格式。
2. LLM 节点：利用大型语言模型进行文本生成和处理。
3. 检索节点：从知识库中获取相关信息。
4. 工具节点：执行特定的任务或操作，扩展工作流功能。
5. 检索工具节点：结合检索能力和工具功能。
6. 意图识别节点：根据预设类别自动识别用户输入意图并路由到不同的处理流程。
7. 回答节点：生成最终答案或输出，整合前序节点的结果。
8. 子图节点：封装完整的子工作流，允许模块化设计。
9. 开始和结束节点：标记工作流的开始和结束。

未来计划添加的节点包括：

• 条件分支节点（If-Else）
• 文件上传节点
• 代码执行节点
• 参数提取节点

这些节点可以组合创建强大而灵活的工作流，适用于各种复杂的业务需求和应用场景。

图像工具调用

知识检索

Human-in-the-Loop（人工审批或让 LLM 重新思考或寻求人工帮助）

如何开始

1. 准备工作

1.1 克隆代码

git clone https://github.com/Onelevenvy/flock.git

1.2 复制环境配置文件

cp .env.example .env

1.3 生成密钥

.env 文件中的一些环境变量默认值为 changethis。 您必须将它们更改为密钥，要生成密钥，可以运行以下命令：

python -c "import secrets; print(secrets.token_urlsafe(32))"

复制内容并将其用作密码/密钥。再次运行该命令以生成另一个安全密钥。

1.3 安装 postgres、qdrant、redis

cd docker
docker compose  --env-file ../.env up -d

2.运行后端

2.1 安装基本环境

服务器启动需要 Python 3.10.x。建议使用 pyenv 快速安装 Python 环境。

要安装其他 Python 版本，请使用 pyenv install。

pyenv install 3.10

要切换到 "3.10" Python 环境，请使用以下命令：

pyenv global 3.10

按照以下步骤操作： 导航到 "backend" 目录：

cd backend

激活环境。

poetry env use 3.10
poetry install

2.2 初始化数据

# 让数据库启动
python /app/app/backend_pre_start.py

# 运行迁移
alembic upgrade head

# 在数据库中创建初始数据
python /app/app/initial_data.py

2.3 运行 unicorn

 uvicorn app.main:app --reload --log-level debug

2.4 运行 celery（非必需，除非您想使用 rag 功能）

poetry run celery -A app.core.celery_app.celery_app worker --loglevel=debug

3.运行前端

3.1 进入 web 目录并安装依赖

cd web
pnpm install

3.2 启动 web 服务

cd web
pnpm dev

# 或者 pnpm build 然后 pnpm start

Star History