Repolode
microsoft

microsoft/prompty

面向 LLM 提示词的 Markdown 文件格式,配套多语言运行时与 VS Code 扩展,用于运行和追踪提示词。

Star
1,286
Fork
135
未关闭 Issue
23
最近提交
5天前

这是什么?

Prompty 是一种用于 LLM 提示词的文件格式和资产类型。一个 `.prompty` 文件由 YAML frontmatter 和 Markdown 正文两部分组成:前者定义模型、连接、输入和工具,后者用 system、user、assistant 角色标记编写消息,并支持 Jinja2 或 Mustache 模板语法。提示词因此可以被独立保存、阅读和迁移,在不同应用与运行时之间复用,而无需修改提示内容。

项目提供 Python、TypeScript、Rust、C#、Java、Go 和 Swift 等运行时,并包含 OpenAI、Microsoft Foundry、Anthropic 的 provider 包。VS Code 扩展提供连接管理侧边栏、实时预览、对话模式以及记录渲染、解析和模型调用过程的追踪查看器。v2 版本还新增了 agentic turn 机制,可执行模型请求的工具调用并返回最终结果。

连接配置支持 OpenAI 兼容的 endpoint,修改环境变量即可让同一份提示词指向网关或自托管的模型服务。

核心功能

  • 01以 `.prompty` 文件定义提示词,YAML frontmatter 与 Markdown 角色块结合。
  • 02支持 Jinja2 和 Mustache 模板,以及 `${env:VAR}` 环境变量引用。
  • 03提供 Python、TypeScript、Rust、C#、Java、Go 和 Swift 运行时。
  • 04内置 OpenAI、Microsoft Foundry 和 Anthropic 的 provider 包。
  • 05VS Code 扩展提供实时预览、对话模式和追踪查看器。
  • 06v2 的 agentic turn 可循环执行模型请求的工具,直到返回最终回答。

适用场景

  • 将提示词作为可读文件纳入版本控制,与应用代码分离。
  • 开发时在 VS Code 中调试提示词,部署时由 Python 或 TypeScript 服务调用同一文件。
  • 借助追踪文件排查提示词渲染与模型调用问题。
  • 让提示词通过 OpenAI 兼容网关或自托管模型服务运行。

快速上手

  1. 1

    编写包含模型配置和 Markdown 提示正文的 .prompty 文件

  2. 2

    安装带 OpenAI 支持的 Python 包

    uv pip install "prompty[jinja2,openai]"
  3. 3

    在 Python 中使用 prompty.invoke 运行提示

  4. 4

    或安装带 OpenAI 支持的 TypeScript 包

    npm install @prompty/core @prompty/openai

使用前须知

  • Prompty v2 较新,README 请求用户就此提供反馈。
  • 运行示例需要 OpenAI 或其他模型服务的 API 密钥。

收录于专题

标签

常见问题

prompty 是什么?
面向 LLM 提示词的 Markdown 文件格式,配套多语言运行时与 VS Code 扩展,用于运行和追踪提示词。 Prompty 是一种用于 LLM 提示词的文件格式和资产类型。一个 `.prompty` 文件由 YAML frontmatter 和 Markdown 正文两部分组成:前者定义模型、连接、输入和工具,后者用 system、user、assistant 角色标记编写消息,并支持 Jinja2 或 Mustache 模板语法。提示词因此可以被独立保存、阅读和迁移,在不同应用与运行时之间复用,而无需修改提示内容。
prompty 可以免费使用吗?用的什么许可证?
prompty 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
prompty 还在维护吗?
活跃维护中。prompty 最近一次提交是在 2026年11月2日。
prompty 适合用来做什么?
将提示词作为可读文件纳入版本控制,与应用代码分离。 开发时在 VS Code 中调试提示词,部署时由 Python 或 TypeScript 服务调用同一文件。 借助追踪文件排查提示词渲染与模型调用问题。 让提示词通过 OpenAI 兼容网关或自托管模型服务运行。
prompty 怎么安装和运行?
编写包含模型配置和 Markdown 提示正文的 .prompty 文件 安装带 OpenAI 支持的 Python 包: uv pip install "prompty[jinja2,openai]" 在 Python 中使用 prompty.invoke 运行提示 或安装带 OpenAI 支持的 TypeScript 包: npm install @prompty/core @prompty/openai
在哪里获取 prompty?
源代码和安装说明在 GitHub 上:https://github.com/microsoft/prompty

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目