Prompt flow

欢迎加入我们，通过参与讨论、提交Issue、提交PR来共同改进 prompt flow。

Prompt flow 是一套开发工具，旨在简化基于LLM的AI应用的端到端开发流程，涵盖从构思、原型设计、测试、评估到生产部署和监控的全过程。它极大地简化了提示工程，帮助你构建生产级质量的LLM应用。

借助 prompt flow，你可以：

• 创建并迭代开发流程
• 创建可执行的流程，将LLM、提示词、Python代码和其他工具连接起来。
• 轻松调试和迭代你的流程，特别是追踪与LLM的交互。
• 评估流程质量与性能
• 使用更大规模的数据集评估流程的质量和性能。
• 将测试和评估集成到CI/CD系统中，确保流程质量。
• 精简的生产级开发流程
• 将流程部署到你选择的服务平台，或轻松集成到你的应用代码库中。
• （可选但强烈建议）利用Azure AI中的Prompt flow云版本与团队协作。

安装

如需快速开始，可以使用预构建的开发环境。点击下方按钮在GitHub Codespaces中打开仓库，然后继续阅读本说明！

如果想在本地环境开始，首先安装软件包：

确保已安装Python环境，推荐使用 python>=3.9, <=3.11。

pip install promptflow promptflow-tools

快速开始 ⚡

使用 prompt flow 创建聊天机器人

运行以下命令从一个聊天模板初始化 prompt flow，将创建名为 my_chatbot 的文件夹，并在其中生成所需的文件：

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

为API密钥设置连接

对于OpenAI密钥，通过运行以下命令建立连接，使用 my_chatbot 文件夹中的 openai.yaml 文件（可通过 --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 文件（DSL文件），它定义了流程，包括输入/输出、节点、连接和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分钟教程，指导你完成提示词调优 ➡ 批量测试 ➡ 评估，所有这些都旨在确保高质量，为生产就绪。

下一步！继续阅读教程 👇 部分，深入了解 prompt flow。

教程 🏃‍♂️

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

开发你自己的LLM应用

VS Code扩展

我们还提供了一个VS Code扩展（流程设计器），用于通过UI进行交互式流程开发体验。

你可以从visualstudio marketplace安装它。

深入了解流程开发

Prompt flow快速入门：逐步指导你调用第一个流程运行。

从实际用例中学习

教程：Chat with PDF：一个端到端教程，展示如何用 prompt flow 构建高质量的聊天应用，包括流程开发和带指标的评估。

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

为贡献者设置

如果你对贡献感兴趣，请首先查看我们的开发环境设置指南：dev_setup.md。

下一步！继续阅读贡献 👇 部分，为 prompt flow 做出贡献。

贡献

本项目欢迎贡献和建议。大多数贡献需要你同意一份贡献者许可协议（CLA），声明你有权并确实授予我们使用你贡献的权利。详情请访问 https://cla.opensource.microsoft.com。

当你提交拉取请求时，CLA机器人会自动确定你是否需要提供CLA，并适当地装饰PR（例如，状态检查、评论）。只需按照机器人提供的指示操作即可。你只需要在我们使用CLA的所有仓库中执行一次此操作。

本项目已采用Microsoft开源行为准则。如需更多信息，请参阅行为准则常见问题解答或联系opencode@microsoft.com提出任何其他问题或意见。

商标

本项目可能包含项目、产品或服务的商标或徽标。Microsoft商标或徽标的授权使用须遵守并遵循Microsoft的商标和品牌指南。在本项目的修改版本中使用Microsoft商标或徽标不得引起混淆或暗示Microsoft赞助。任何第三方商标或徽标的使用均受第三方政策的约束。

行为准则

本项目已采用Microsoft开源行为准则。如需更多信息，请参阅行为准则常见问题解答或联系opencode@microsoft.com提出任何其他问题或意见。

数据收集

此软件可能收集关于你和你在使用此软件时的信息，并在配置为启用遥测时将其发送给Microsoft。Microsoft可能会使用此信息提供服务和改进我们的产品和服务。你可以按照仓库中的描述开启遥测。此软件中还有一些功能可能允许你和Microsoft从你的应用用户那里收集数据。如果你使用这些功能，必须遵守适用法律，包括向你的应用用户提供适当的通知以及Microsoft隐私声明的副本。我们的隐私声明位于 https://go.microsoft.com/fwlink/?LinkID=824704。你可以在帮助文档和隐私声明中了解有关数据收集和使用的更多信息。使用此软件即表示你同意这些做法。

遥测配置

遥测收集默认开启。

若要退出，请运行 pf config set telemetry.enabled=false 关闭它。

许可证

版权所有 (c) Microsoft Corporation。保留所有权利。

根据MIT许可证授权。