Pipecat Flows 是一个用于 Pipecat 的附加框架，它允许你在 AI 应用程序中构建结构化的对话流程。通过该框架，你可以创建预定义的对话路径以及动态生成的流程，同时处理状态管理和与大模型交互的复杂性。

该框架包括：

• 一个用于使用 Pipecat 构建对话流程的 Python 模块
• 一个用于设计和导出流程配置的 可视化编辑器

依赖项

• Python 3.11 或更高版本
• Pipecat

安装

1. 安装 uv

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

   需要帮助吗？ 请参阅 uv 安装文档。

2. 安装模块

   # 对于新项目
   uv init my-pipecat-flows-app
   cd my-pipecat-flows-app
   uv add pipecat-ai-flows
   
   # 或者对于现有项目
   uv add pipecat-ai-flows
   

使用 pip 吗？ 你仍然可以使用 pip install pipecat-ai-flows 来进行设置。

快速入门

请参阅 快速入门 README。

如需更详细的示例和指南，请访问我们的 文档。

示例

仓库包含多个完整的示例实现，展示了 Pipecat Flows 的各种功能。

可用示例

这些示例演示了多种对话流程，包括点餐、餐厅预订、患者入院登记、保险报价以及热转接等。所有示例均支持多个大模型提供商（OpenAI、Anthropic、Google Gemini、AWS Bedrock），以展示跨平台兼容性。

开始使用示例

有关详细的设置说明、配置和运行示例，请参阅 示例 README。

快速开始：

# 安装依赖
uv sync
uv pip install "pipecat-ai[daily,openai,deepgram,cartesia,silero,examples]"

# 配置环境
cp env.example .env  # 添加你的 API 密钥

# 运行一个示例
uv run examples/food_ordering.py

贡献框架

1. 克隆仓库并进入目录：

   git clone https://github.com/pipecat-ai/pipecat-flows.git
   cd pipecat-flows
   

2. 安装开发依赖：

   uv sync --group dev
   

3. 安装 Git 预提交钩子（这些钩子有助于确保你的代码符合项目规范）：

   uv run pre-commit install
   

   当你运行 uv sync 时，该包会自动以可编辑模式安装。

测试

该包包含一个全面的测试套件，覆盖核心功能。

设置测试环境

安装 venv 和依赖项：

uv sync --group dev

运行测试

运行所有测试：

uv run pytest tests/

运行特定测试文件：

uv run pytest tests/test_state.py

运行特定测试：

uv run pytest tests/test_state.py -k test_initialization

带覆盖率报告运行：

uv run pytest tests/ --cov=pipecat_flows

Pipecat Flows 编辑器

一个用于创建和管理 Pipecat 对话流程的可视化编辑器。

访问 Pipecat Flows 编辑器 仓库以了解更多信息。

贡献

我们欢迎社区的贡献！无论你是修复 bug、改进文档，还是添加新功能，都可以通过以下方式参与：

• 发现了一个 bug？ 打开一个 issue
• 有一个功能想法？ 在 Discord 上发起讨论
• 想贡献代码？ 请查看我们的 CONTRIBUTING.md 指南
• 改进文档？ 文档 PR 始终受到欢迎

在提交拉取请求之前，请检查现有的 issue 和 PR，以避免重复。

我们致力于及时审查所有贡献，并提供建设性的反馈，以帮助你的更改被合并。

获取帮助

➡️ 加入我们的 Discord

➡️ Pipecat Flows 指南

➡️ 在 X 上联系我们

Pipecat Flows 快速上手指南

Pipecat Flows 是 Pipecat 的扩展框架，专为构建结构化 AI 对话而设计。它支持预定义对话路径和动态生成的流程，同时自动处理状态管理和大模型（LLM）交互的复杂性。

环境准备

在开始之前，请确保满足以下系统要求：

• 操作系统：Linux, macOS, 或 Windows (WSL 推荐)
• Python 版本：3.11 或更高
• 前置依赖：已安装 Pipecat 基础环境
• 包管理器：推荐使用 uv (高性能 Python 包安装器)，同时也支持 pip

安装步骤

方法一：使用 uv (推荐)

uv 能显著加快依赖安装速度。

1. 安装 uv

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

   国内用户若下载缓慢，可尝试手动下载二进制文件或使用镜像源配置。

2. 创建项目并安装 Pipecat Flows

   # 初始化新项目
   uv init my-pipecat-flows-app
   cd my-pipecat-flows-app
   
   # 添加依赖
   uv add pipecat-ai-flows
   

   如果是现有项目，直接进入目录运行 uv add pipecat-ai-flows 即可。

方法二：使用 pip

如果你习惯使用 pip，可以直接安装：

pip install pipecat-ai-flows

注意：为了运行完整示例，通常还需要安装额外的提供商依赖（如 OpenAI, Daily 等），见下文“基本使用”。

基本使用

以下是基于官方示例的快速启动流程，演示如何运行一个食品订购对话流。

1. 同步依赖与环境配置

进入项目目录（或示例目录），安装包含语音、LLM 提供商在内的完整示例依赖：

# 同步开发依赖
uv sync

# 安装示例所需的额外组件 (Daily, OpenAI, Deepgram 等)
uv pip install "pipecat-ai[daily,openai,deepgram,cartesia,silero,examples]"

2. 配置 API 密钥

复制环境变量模板文件并填入你的 API Key（支持 OpenAI, Anthropic, Google Gemini, AWS Bedrock 等）：

cp env.example .env

编辑 .env 文件，填入对应的 OPENAI_API_KEY 或其他服务商密钥。

3. 运行示例

运行内置的食品订购示例脚本：

uv run examples/food_ordering.py

程序启动后，将建立一个结构化的对话流程，自动处理用户意图识别、状态跳转及多轮对话逻辑。

进阶：可视化编辑

Pipecat Flows 还提供可视化的流程编辑器，可用于设计和导出对话配置。

• 仓库地址：Pipecat Flows Editor
• 功能：通过图形界面设计对话节点，导出配置文件供代码加载使用。

---

更多详细文档请访问：Pipecat Flows Official Docs