项目概述

POML 是微软推出的一种新型标记语言，全称为 Prompt Orchestration Markup Language，旨在为大型语言模型（LLMs）的高级提示工程带来结构性、可维护性和多功能性。它解决了提示开发中的常见挑战，如缺乏结构、复杂数据集成、格式敏感性和工具不足等问题，能帮助开发者创建更复杂、可靠的 LLM 应用。

核心功能

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

快速入门示例

创建一个名为example.poml的文件，确保与
photosynthesis_diagram.png图像文件在同一目录，内容如下：

poml

<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>

该示例为 LLM 定义了角色和任务，包含用于上下文的图像，并指定了期望的输出格式，借助 POML 工具包可轻松渲染并通过视觉 LLM 进行测试。

安装方法

• Visual Studio Code 扩展：从 Visual Studio Code Marketplace 安装。也可从 GitHub 发布页面下载.vsix文件，然后通过 VS Code 的扩展视图手动安装。使用前需配置首选的 LLM 模型、API 密钥和端点，可在扩展设置中配置或直接添加到settings.json文件。
• Node.js（通过 npm）：npm install pomljs
• Python（通过 pip）：pip install poml；若为开发或本地安装，可从克隆的存储库中使用pip install -e .

文档与资源

• 详细文档可参考相关文档，涵盖 POML 语法、组件、样式、模板、SDK 和 VS Code 扩展等内容。
• 研究论文即将推出，将深入介绍 POML 的设计、实现和评估。

项目地址：
https://github.com/microsoft/poml