POML：提示编排标记语言

**POML（提示编排标记语言）**是一种新颖的标记语言，旨在为大型语言模型（LLM）的高级提示工程带来结构化、可维护性和多功能性。它解决了提示开发中常见的挑战，例如缺乏结构、复杂的数据集成、对格式的敏感性以及工具支持不足等问题。POML提供了一种系统化的组织提示组件的方式，能够无缝集成多种数据类型并管理呈现方式的变化，从而帮助开发者构建更复杂、更可靠的 LLM 应用程序。

演示视频

核心特性

• 结构化提示标记：采用类似 HTML 的语法，包含 <role>、<task> 和 <example> 等语义化组件，鼓励模块化设计，提升提示的可读性、可重用性和可维护性。
• 全面的数据处理：内置专门的数据组件（如 <document>、<table>、<img>），可无缝嵌入或引用文本文件、电子表格和图片等外部数据源，并提供自定义的格式化选项。
• 解耦的呈现样式：具有类似 CSS 的样式系统，将内容与呈现分离。这使得开发者可以通过 <stylesheet> 定义或内联属性来修改样式（如详尽程度、语法格式），而无需改变核心提示逻辑，从而降低 LLM 对格式的敏感性。
• 集成的模板引擎：内置模板引擎，支持变量（{{ }}）、循环（for）、条件语句（if）以及变量定义（<let>），用于动态生成复杂的、数据驱动的提示。
• 丰富的开发工具套件：
  • IDE 扩展（Visual Studio Code）：提供语法高亮、上下文感知自动补全、悬停文档、实时预览、内联诊断错误检查以及集成式交互测试等开发辅助功能。
  • 软件开发工具包（SDKs）：提供适用于 Node.js（JavaScript/TypeScript）和 Python 的 SDK，便于无缝集成到各种应用工作流和流行的 LLM 框架中。

快速入门

以下是一个非常简单的 POML 示例，请将其保存为名为 example.poml 的文件，并确保该文件与 photosynthesis_diagram.png 图片文件位于同一目录下。

<poml>
  <role>你是一位耐心的老师，正在向一位10岁的孩子解释概念。</role>
  <task>请结合提供的图片，解释光合作用的概念。</task>

  <img src="photosynthesis_diagram.png" alt="光合作用示意图" />

  <output-format>
    解释要简单易懂，富有吸引力，字数不超过100字。
    开头请使用“嘿，未来的小科学家！”。
  </output-format>
</poml>

此示例定义了 LLM 的角色和任务，插入了一张参考图片，并指定了期望的输出格式。借助 POML 工具包，可以轻松地以灵活的格式渲染提示，并使用具备视觉理解能力的 LLM 进行测试。

安装

Visual Studio Code 扩展

从 Visual Studio Code 市场安装。

您也可以手动下载 .vsix 文件，从我们的 GitHub 发布页面获取，然后通过 VS Code 的扩展视图进行安装。

在使用 POML 工具包测试提示之前，请确保已配置好您偏好的 LLM 模型、API 密钥和端点。如果未设置这些信息，提示测试将无法正常运行。

在 Visual Studio Code 中配置：

• 打开扩展设置（进入“设置”并搜索“POML”）。
• 在 POML 部分设置您的模型提供商（如 OpenAI、Azure、Google）、API 密钥和端点 URL。
• 或者，您也可以直接将这些设置添加到 settings.json 文件中。

Node.js（通过 npm）

npm install pomljs

Python（通过 pip）

pip install poml

对于开发或本地安装，您可以从克隆的仓库中使用 pip install -e .。

有关夜间构建版本的更多安装详情，请参阅文档。

文档

有关 POML 语法、组件、样式、模板、SDK 以及 VS Code 扩展的详细信息，请参阅我们的文档。

了解更多

• 观看我们的 YouTube 演示视频： POML 介绍与演示
• 加入我们的 Discord 社区： 与团队及其他用户在我们的 Discord 服务器交流。
• 阅读《提示编排标记语言》论文： Prompt Orchestration Markup Language 介绍了 POML 的设计及其对提示工程的影响。
• 探索内容-格式一体化提示优化： 超越提示内容：通过内容-格式一体化提示优化提升 LLM 性能 提出了一种迭代方法，同时优化提示内容和格式，以提高 LLM 的性能。

引用

如果您认为 POML 对您的研究有所帮助，请引用以下论文：

@misc{zhang2025promptorchestrationmarkuplanguage,
      title={Prompt Orchestration Markup Language},
      author={Yuge Zhang and Nan Chen and Jiahang Xu and Yuqing Yang},
      year={2025},
      eprint={2508.13948},
      archivePrefix={arXiv},
      primaryClass={cs.HC},
      url={https://arxiv.org/abs/2508.13948},
}

生态系统与社区项目

• mini-poml-rs – 基于 Rust 的实验性 POML 渲染器，适用于没有 JavaScript 或 Python 解释器的环境。
• poml-ruby – 用于 Ruby 应用程序的 POML Ruby gem 实现。
• ai-chatbot-with-python-and-angular – 由 HERE AND NOW AI 开发的聊天机器人，使用 Python 和 Angular（版本 20）构建，利用 POML 进行提示设计，并结合 Langchain 框架。
• PomlSDK.jl – POML 规范的 Julia 实现。

贡献说明

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

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

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

商标

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

负责任的人工智能

本项目已通过评估并认证符合 Microsoft 负责任的人工智能标准。团队将持续监控和维护该代码库，及时处理可能出现的严重问题，包括潜在的危害。更多详情请参阅 负责任的人工智能自述文件。

许可证

本项目采用 MIT 许可证授权。详细信息请参阅 LICENSE 文件。

POML 快速上手指南

POML (Prompt Orchestration Markup Language) 是一种专为大语言模型（LLM）提示词工程设计的标记语言。它通过类 HTML 的语法结构、样式与内容分离机制以及内置模板引擎，帮助开发者构建更结构化、可维护且高效的提示词。

环境准备

在开始之前，请确保满足以下要求：

• 操作系统：Windows, macOS 或 Linux。
• 运行时环境（二选一或全选）：
  • Node.js: 版本 16+（用于 JavaScript/TypeScript 开发）。
  • Python: 版本 3.8+（用于 Python 开发）。
• 编辑器（推荐）：Visual Studio Code（用于获得语法高亮、自动补全和实时预览体验）。
• LLM 配置：需准备好大模型服务商的 API Key 和 Endpoint（如 OpenAI, Azure, Google 等），以便进行提示词测试。

安装步骤

你可以根据开发需求选择安装 VS Code 插件或编程语言 SDK。

1. 安装 Visual Studio Code 扩展（推荐）

这是最便捷的开发方式，提供完整的编辑辅助功能。

• 方式一：通过市场安装 在 VS Code 扩展商店中搜索 POML 或访问 VS Code Marketplace 点击安装。

• 方式二：手动安装 从 GitHub Releases 下载 .vsix 文件，在 VS Code 扩展视图右上角菜单中选择“从 VSIX 安装”。

• 配置模型信息 安装完成后，打开 VS Code 设置（搜索 "POML"），填入你的模型提供商、API Key 和 Endpoint URL；或直接编辑 settings.json 文件进行配置。

2. 安装 Python SDK

pip install poml

提示：国内用户若下载缓慢，可使用清华源加速：

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

3. 安装 Node.js SDK

npm install pomljs

提示：国内用户若下载缓慢，可配置淘宝镜像：

npm config set registry https://registry.npmmirror.com
npm install pomljs

基本使用

以下是一个最简单的 POML 示例，展示了如何定义角色、任务、嵌入图片以及规定输出格式。

1. 创建一个名为 example.poml 的文件。
2. 确保该文件目录下存在一张名为 photosynthesis_diagram.png 的图片（或修改代码中的图片路径）。
3. 将以下内容复制到文件中：

<poml>
  <role>You are a patient teacher explaining concepts to a 10-year-old.</role>
  <task>Explain the concept of photosynthesis using the provided image as a reference.</task>

  <img src="photosynthesis_diagram.png" alt="Diagram of photosynthesis" />

  <output-format>
    Keep the explanation simple, engaging, and under 100 words.
    Start with "Hey there, future scientist!".
  </output-format>
</poml>

运行与测试：

• 在 VS Code 中：打开该文件，利用插件提供的 "Run" 或 "Preview" 功能，即可直接调用配置的 LLM 进行测试并查看结果。
• 在代码中：使用安装的 SDK 读取并渲染该 .poml 文件，将其转换为最终发送给 LLM 的 Prompt 字符串。

此示例定义了 AI 的角色和任务，嵌入了上下文图片，并严格限制了输出的风格和长度。通过 POML，你可以轻松管理复杂的数据输入和样式变化，而无需硬编码字符串。