promptflow

环境要求

• 本地已安装 Python，推荐版本 >=3.9 且 <=3.11
• 可用的 OpenAI API Key（或 Azure OpenAI 的 Key 与 Endpoint）
• 能访问 PyPI 以安装 promptflow 相关包

安装与启动步骤

1. 1准备 Python 环境

   确认本机 Python 版本在 3.9 到 3.11 之间，README 推荐该区间，版本过高或过低可能装不上。

2. 2安装 promptflow

   在本地环境安装 promptflow 主包与官方工具包 promptflow-tools，这是后续所有 pf 命令的基础。

   pip install promptflow promptflow-tools

   复制

3. 3初始化聊天流

   用 chat 模板生成示例流，命令会创建 my_chatbot 目录并生成所需文件。

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

   复制

4. 4创建 OpenAI 连接

   为 API Key 建立名为 open_ai_connection 的连接，用 --set 直接传 key 可避免改 yaml 文件。

   pf connection create --file ./my_chatbot/openai.yaml --set api_key=sk-xxxxxxxx --name open_ai_connection

   复制

5. 5创建 Azure 连接

   若用 Azure OpenAI，改用 azure_openai.yaml 并额外传 api_base；连接名同样为 open_ai_connection。

   pf connection create --file ./my_chatbot/azure_openai.yaml --set api_key=sk-xxxxxxxx api_base=https://your-resource.openai.azure.com/ --name open_ai_connection

   复制

6. 6交互式测试流

   进入对话测试模式，输入消息即可与聊天机器人交互，按 Ctrl+C 结束会话。

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

   复制

7. 7关闭遥测（可选）

   遥测收集默认开启，如不希望上报数据，执行该命令关闭。

   pf config set telemetry.enabled=false

   复制

关键配置

如何确认成功

运行 pf flow test --flow ./my_chatbot --interactive 后出现交互提示，输入消息能收到模型回复即为成功。

常见问题

注意事项

• 连接名必须与 flow.dag.yaml 中 chat 节点引用的 open_ai_connection 保持一致。
• 推荐用 --set 传入密钥，避免直接修改 yaml 文件导致密钥泄露。
• 遥测收集默认开启，介意隐私请在首次使用后关闭。
• README 也提供 GitHub Codespaces 预置开发环境，可跳过本地安装步骤。