提示流程

欢迎加入我们，通过参与 讨论、提交 问题 和 拉取请求 来共同让提示流程更加完善。

提示流程 是一套开发工具，旨在简化基于 LLM 的 AI 应用程序的端到端开发周期，从构思、原型设计、测试、评估到生产部署和监控。它使提示工程变得更加容易，并帮助您构建具有生产质量的 LLM 应用程序。

借助提示流程，您可以：

• 创建并迭代开发流程
  • 创建可执行的 流程，将 LLM、提示、Python 代码和其他 工具 连接在一起。
  • 轻松调试和迭代您的流程，尤其是 跟踪与 LLM 的交互。
• 评估流程质量和性能
  • 使用更大的数据集评估流程的质量和性能。
  • 将测试和评估集成到您的 CI/CD 系统中，以确保流程的质量。
• 为生产环境优化开发流程
  • 将您的流程部署到您选择的服务平台，或轻松集成到您的应用程序代码库中。
  • （可选但强烈推荐）通过利用 Azure AI 中的云版本 Prompt Flow 与团队协作。

---

安装

要快速入门，您可以使用预构建的开发环境。点击下方按钮 在 GitHub Codespaces 中打开仓库，然后继续阅读自述文件！

如果您想在本地环境中开始使用，首先安装以下包：

请确保您有一个 Python 环境，建议使用 python>=3.9, <=3.11。

pip install promptflow promptflow-tools

快速入门 ⚡

使用提示流程创建聊天机器人

运行命令从聊天模板初始化一个提示流程，它会创建名为 my_chatbot 的文件夹，并在其中生成所需的文件：

pf flow init --flow ./my_chatbot --type chat

为您的 API 密钥设置连接

对于 OpenAI 密钥，请运行以下命令建立连接，使用 my_chatbot 文件夹中的 openai.yaml 文件存储您的 OpenAI 密钥（使用 --set 参数覆盖密钥和名称，以避免修改 YAML 文件）：

pf connection create --file ./my_chatbot/openai.yaml --set api_key=<your_api_key> --name open_ai_connection

对于 Azure OpenAI 密钥，请运行以下命令建立连接，使用 azure_openai.yaml 文件：

pf connection create --file ./my_chatbot/azure_openai.yaml --set api_key=<your_api_key> api_base=<your_api_base> --name open_ai_connection

与您的流程对话

在 my_chatbot 文件夹中，有一个 flow.dag.yaml 文件，概述了流程，包括输入/输出、节点、连接以及 LLM 模型等。

请注意，在 chat 节点中，我们使用名为 open_ai_connection 的连接（在 connection 字段中指定）和 gpt-35-turbo 模型（在 deployment_name 字段中指定）。deployment_name 字段用于指定 OpenAI 模型，或 Azure OpenAI 部署资源。

通过运行以下命令与您的聊天机器人互动：（按 Ctrl + C 结束会话）

pf flow test --flow ./my_chatbot --interactive

核心价值：从原型到生产确保“高质量”

探索我们的 15 分钟教程，该教程将指导您完成提示微调 ➡ 批量测试 ➡ 评估的过程，所有这些步骤都旨在确保高质量，为生产做好准备。

下一步！继续阅读下方的 教程 部分，深入了解提示流程。

教程 🏃‍♂️

提示流程是一种用于 构建高质量 LLM 应用程序 的工具，其开发流程遵循以下步骤：开发流程、提升流程质量、将流程部署到生产环境。

开发您自己的 LLM 应用程序

VS Code 扩展

我们还提供一个 VS Code 扩展（流程设计器），让您可以通过 UI 体验交互式的流程开发。

您可以从 Visual Studio 市场 安装它。

深入了解流程开发

提示流程入门：逐步指导您运行第一个流程。

从用例中学习

教程：与 PDF 对话：一个端到端教程，介绍如何使用提示流程构建高质量的聊天应用程序，包括流程开发和基于指标的评估。

更多示例可以在这里找到 这里。我们欢迎新的用例贡献！

贡献者设置

如果您有兴趣贡献代码，请从我们的开发设置指南开始：dev_setup.md。

下一步！继续阅读下方的 贡献 部分，为提示流程贡献力量。

贡献

本项目欢迎贡献和建议。大多数贡献都需要您签署贡献者许可协议（CLA），声明您有权且确实将您的贡献使用权授予我们。有关详细信息，请访问 https://cla.opensource.microsoft.com。

当您提交拉取请求时，CLA 机器人会自动判断您是否需要提供 CLA，并相应地标记 PR（例如状态检查、评论）。请按照机器人提供的指示操作。对于使用我们 CLA 的所有仓库，您只需执行此操作一次。

本项目已采用 微软开源行为准则。更多信息请参阅 行为准则常见问题解答 或发送电子邮件至 opencode@microsoft.com 咨询更多问题或意见。

商标

本项目可能包含项目、产品或服务的商标或标识。未经授权使用微软商标或标识须遵守并遵循 微软商标与品牌指南。在本项目的修改版本中使用微软商标或标识不得造成混淆或暗示微软的赞助关系。任何第三方商标或标识的使用均应遵守该第三方的相关政策。

行为准则

本项目已采用 微软开源行为准则。 更多信息请参阅 行为准则常见问题解答 或发送电子邮件至 opencode@microsoft.com 咨询更多问题或意见。

数据收集

如果配置为启用遥测功能，本软件可能会收集有关您及您使用该软件的信息，并将其发送给微软。微软可能会利用这些信息来提供服务并改进其产品和服务。您可以在仓库中找到启用遥测功能的方法。此外，本软件中还有一些功能可以帮助您和微软收集您应用程序用户的数据。如果您使用这些功能，必须遵守适用法律，包括向您的应用程序用户发出适当的通知，并附上微软的隐私声明。我们的隐私声明位于 https://go.microsoft.com/fwlink/?LinkID=824704。您可以通过帮助文档和我们的隐私声明了解更多关于数据收集和使用的信息。您使用本软件即表示您同意这些做法。

遥测配置

默认情况下，遥测收集功能已开启。

如需退出，请运行 pf config set telemetry.enabled=false 来关闭它。

许可证

版权所有 © 微软公司。保留所有权利。

根据 MIT 许可证 授权。

Prompt Flow 快速上手指南

Prompt Flow 是一套旨在简化基于大语言模型（LLM）的 AI 应用端到端开发周期的工具套件。它涵盖了从构思、原型设计、测试、评估到生产部署和监控的全过程，帮助开发者轻松进行提示工程并构建高质量的生产级 LLM 应用。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Windows, macOS 或 Linux
• Python 版本：推荐 3.9 至 3.11 (必须 >=3.9 且 <=3.11)
• 前置依赖：已安装 pip 包管理工具

提示：如果您希望快速体验而无需配置本地环境，可以直接点击 GitHub Codespaces 在浏览器中打开预构建的开发环境。

安装步骤

使用 pip 安装核心库及常用工具包。国内用户若遇到下载缓慢，可添加国内镜像源（如清华源或阿里源）。

标准安装命令：

pip install promptflow promptflow-tools

使用国内镜像源加速安装（推荐）：

pip install promptflow promptflow-tools -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

以下是最简单的快速启动流程，我们将创建一个聊天机器人应用，配置 API 连接并进行交互测试。

1. 初始化聊天流

运行以下命令创建一个名为 my_chatbot 的文件夹，并生成基于聊天模板的必要文件：

pf flow init --flow ./my_chatbot --type chat

2. 配置 API 连接

您需要将 OpenAI 或 Azure OpenAI 的密钥配置为连接对象。

对于 OpenAI 用户： 使用生成的 openai.yaml 文件创建连接（请将 <your_api_key> 替换为您的实际密钥）：

pf connection create --file ./my_chatbot/openai.yaml --set api_key=<your_api_key> --name open_ai_connection

对于 Azure OpenAI 用户： 使用 azure_openai.yaml 文件创建连接（需替换密钥和基础 URL）：

pf connection create --file ./my_chatbot/azure_openai.yaml --set api_key=<your_api_key> api_base=<your_api_base> --name open_ai_connection

注意：上述命令中的 --name 参数定义了连接名称，需与后续流程配置中的名称保持一致。默认模板中使用的模型部署名为 gpt-35-turbo，请根据您的实际资源进行调整。

3. 交互式测试

进入 my_chatbot 目录或直接指定路径，运行以下命令启动交互式聊天会话：

pf flow test --flow ./my_chatbot --interactive

运行后，您可以在终端中输入消息与您的 LLM 应用对话。按 Ctrl + C 即可结束会话。

---

完成上述步骤后，您已成功运行了第一个 Prompt Flow。接下来您可以探索 VS Code 插件以获得可视化的流程设计体验，或查阅官方文档学习如何进行批量测试与评估。