` タグを使用すると CSS と似た構文で POML ドキュメントのスタイルを定義できます。以下の例では `` タグを JSON としてレンダリングされるように指定しています。
```poml
{
"p": {
"syntax": "json"
}
}
このテキストは JSON としてレンダリングされます。
```
結果は以下のようになります。
````txt
```json
"This text will be rendered as JSON."
```
````
`className` 属性を使用し、特定の要素にスタイルを適用することもできます。
```poml
{
".csv": {
"syntax": "csv",
"writerOptions": { "csvHeader": false }
}
}
```
結果は以下のようになります。
```txt
種類,鳴き声
猫,ニャー
犬,ワン
```
## メタデータ
`` タグを使用して POML ドキュメントにメタデータを追加できます。メタデータはバージョン要件の指定やレスポンススキーマの定義、ツールの登録などに使用されます。
`` 要素は通常ドキュメントの先頭に配置されます。以下の例では POML ランタイムのバージョン要件を指定しています。
```poml
Some content
```
### レスポンススキーマ
レスポンススキーマは AI が生成するレスポンスの想定される形式を定義します。これにより AI の応答が期待される形式に従うことを保証できます。`lang="json"` 属性を使用して JSON スキーマを定義します。
```poml
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"required": ["name", "age"]
}
```
`lang` 属性を省略した場合、JavaScript 式として解釈されます。以下の例では Zod スキーマを使用して同様の構造を定義しています。
```poml
z.object({
name: z.string(),
age: z.number().min(0)
});
```
:::warning
レスポンススキーマは 1 つの POML ドキュメントに対して 1 つだけ定義できます。複数のスキーマを定義することはできません。
:::
### ツールスキーマ
ツールスキーマは、AI が使用する外部ツールのインターフェースを定義します。これにより、AI に利用可能なツールの情報を提供し、ツールの使用方法を明示的に示すことができます。以下の例では、`getWeather` というツールを定義しています。
```poml
{
"type": "object",
"properties": {
"location": { "type": "string" },
"unit": {
"type": "string",
"enum": ["celsius", "fahrenheit"]
}
},
"required": ["location"]
}
```
レスポンススキーマと同様に JavaScript 式として定義することもできます。
```poml
z.object({
location: z.string(),
unit: z.enum(["celsius", "fahrenheit"])
});
```
### ランタイムパラメーター
ランタイムパラメーターは LLM の実行時の設定を定義します。これにより、AI の動作を制御するためのパラメーターを指定できます。以下の例では `temperature` と `maxOutputTokens` のパラメーターを定義しています。
```poml
{
"temperature": 0.7,
"maxOutputTokens": 1024
}
```
### コンポーネントの制御
`` タグを使用して POML ドキュメントで使用するコンポーネントを制御できます。これにより、特定のコンポーネントを有効化または無効化できます。
例えば、`![]()
` コンポーネントを無効化するには `-` プレフィックスを使用します。
```poml
```
一度無効にしたコンポーネントを再度有効にするには、`+` プレフィックスを使用します。
```poml
```
## TypeScript SDK
POML を TypeScript で扱うための SDK を提供します。これにより、TypeScript 環境で POML ドキュメントを簡単に生成、解析、操作できるようになります。
以下のコマンドで `pomljs` パッケージをインストールします。
```bash
npm install pomljs
```
`read` 関数で POML ドキュメントを読み込み、`write` 関数で Markdown 形式に変換できます。
```ts
import { read, write } from "pomljs";
const prompt = `
あなたはプログラミング言語やフレームワーク、デザインパターンに関する卓越した知識を持つ専門家です。
ユーザーの指示に従い、コードの生成や修正を行います。
`;
const ir = await read(prompt);
const markdown = write(ir);
console.log("Markdown Output:", markdown);
// # Role
// あなたはプログラミング言語やフレームワーク、デザインパターンに関する卓越した知識を持つ専門家です。
// # Task
// ユーザーの指示に従い、コードの生成や修正を行います。
```
## まとめ
- POML (Prompt Orchestration Markup Language) はプロンプトを構造化された文書として管理するためのマークアップ言語
- VS Code 拡張機能や TypeScript, Python を通じて POML ドキュメントを解析しプレーンテキストに変換できる
- `.poml` 拡張子のファイルで POML ドキュメントを保存し、HTML タグに似た構文でプロンプトを定義
- ドキュメントのルートは `` タグで始まり、`` や `` といったセマンティックなコンポーネントを使用
- `![]()
`, `` などのコンポーネントを使用して、リッチなコンテンツを表現
- 変数の定義やループ、条件分岐を使用して動的なプロンプトを生成可能
- `` タグを使用して POML ドキュメントにバージョン要件やレスポンススキーマ、ツールスキーマを追加
## 参考
- [microsoft/poml: Prompt Orchestration Markup Language](https://github.com/microsoft/poml)
- [POML Documentation](https://microsoft.github.io/poml/latest/)
