prompty

环境要求

• Python 环境（用 pip 安装 prompty）
• Node.js/npm 环境（使用 TypeScript 接口时需要）
• OpenAI API Key，或兼容端点的密钥
• VS Code（可选，用于在编辑器内按 F5 调试）

安装与启动步骤

1. 1安装 Python 依赖

   安装 prompty 及 jinja2 模板、openai 提供方扩展，用于在 Python 中调用。

   pip install "prompty[jinja2,openai]"

   复制

2. 2安装 TS 依赖

   使用 TypeScript/Node.js 时安装核心包与 openai 适配包。

   npm install @prompty/core @prompty/openai

   复制

3. 3编写 .prompty 文件

   把提示词、模型参数和模板格式写进 greeting.prompty，apiKey 从环境变量读取。

   cat > greeting.prompty << 'EOF'
   ---
   name: greeting
   model:
     id: gpt-4o-mini
     provider: openai
     connection:
       kind: key
       apiKey: ${env:OPENAI_API_KEY}
   template:
     format:
       kind: jinja2
     parser:
       kind: prompty
   ---
   system:
   You are a friendly assistant.
   
   user:
   Say hello to {{name}}.
   EOF

   复制

4. 4设置 API Key

   prompty 文件通过 ${env:OPENAI_API_KEY} 读取密钥，运行前需先导出该环境变量。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

5. 5用 Python 运行

   创建脚本并调用 prompty.invoke，传入 name 变量，打印模型返回结果。

   cat > run.py << 'EOF'
   import prompty
   
   result = prompty.invoke("greeting.prompty", inputs={"name": "Jane"})
   print(result)
   EOF
   python run.py

   复制

6. 6用 TypeScript 运行

   在代码中从 @prompty/core 引入 invoke，并导入 @prompty/openai 注册提供方后调用。

7. 7VS Code 调试

   用 VS Code 打开 .prompty 文件，直接按 F5 即可运行调试该提示词。

关键配置

如何确认成功

执行 python run.py（或 TypeScript 脚本）后，终端能打印出模型返回的问候内容，即说明调用成功。

常见问题

注意事项

• 当前为 v2 alpha 分支，API、文件格式和工具链仍在开发中，可能发生变化。
• 欢迎通过 GitHub Issues 反馈问题。