BAML 是一种用于构建可靠 AI 工作流和智能体 的简单提示语言。

BAML 通过将提示工程转变为 模式工程，使提示工程变得简单——你只需专注于提示的模型结构，即可获得更可靠的输出。你无需用 BAML 编写整个应用，只需编写提示部分即可！你可以使用任何你喜欢的语言来集成你的 LLM 函数！请参阅我们的快速入门指南，适用于 Python、TypeScript、Ruby 以及 Go 等其他语言。

BAML 提供了开箱即用的功能——具备完整的类型安全、流式处理、重试机制、广泛的模型支持，即使这些模型不原生支持 工具调用 API。

试试 BAML：Prompt Fiddle • 交互式应用示例

BAML 的核心原则：LLM 提示就是函数

BAML 中的基本构建块是函数。每个提示都是一条函数，它接受参数并返回一个类型。

function ChatAgent(message: Message[], tone: "happy" | "sad") -> string

每个函数还会进一步定义它所使用的模型以及其具体的提示内容。

function ChatAgent(message: Message[], tone: "happy" | "sad") -> StopTool | ReplyTool {
    client "openai/gpt-4o-mini"

    prompt #"
        成为一个 {{ tone }} 的机器人。

        {{ ctx.output_format }}

        {% for m in message %}
        {{ _.role(m.role) }}
        {{ m.content }}
        {% endfor %}
    "#
}

class Message {
    role string
    content string
}

class ReplyTool {
  response string
}

class StopTool {
  action "stop" @description(#"
    当可能适合结束对话时
  "#)
}

BAML 函数可以从任何语言中调用

下面我们通过 Python 调用了我们在 BAML 中定义的 ChatAgent 函数。BAML 的 Rust 编译器会生成一个“baml_client”来访问和调用这些函数。

from baml_client import b
from baml_client.types import Message, StopTool

messages = [Message(role="assistant", content="我能帮您什么？")]

while True:
  print(messages[-1].content)
  user_reply = input()
  messages.append(Message(role="user", content=user_reply))
  tool = b.ChatAgent(messages, "happy")
  if isinstance(tool, StopTool):
    print("再见！")
    break
  else:
    messages.append(Message(role="assistant", content=tool.response))

你可以使用串联的 BAML 函数来编写任何类型的智能体或工作流。一个智能体就是一个循环，不断调用带有某些状态的聊天 BAML 函数。

如果你需要进行流式处理，只需再添加几行代码：

stream = b.stream.ChatAgent(messages, "happy")
# partial 是一个包含所有可选字段的 Partial 类型
for tool in stream:
    if isinstance(tool, StopTool):
      ...
    
final = stream.get_final_response()

这样你就可以为流中的每一个数据块获得完全类型安全的输出。

在 IDE 中以 10 倍速度测试提示

BAML 配备了针对 VS Code 和 JetBrains IDE 的原生工具，并且对 其他编辑器 的支持也在不断扩展。

可视化完整的提示（包括任何多模态资源）以及 API 请求。BAML 让你对提示拥有完全的透明度和控制力。

使用 AI 的关键在于迭代速度。

如果测试你的流程需要 2 分钟，那么在 20 分钟内你只能尝试 10 种想法。

如果将时间缩短到 5 秒，那么在相同的时间内你可以尝试 240 种想法。

Playground 还允许你并行运行测试——从而实现更快的迭代速度 🚀。

无需登录网站，也不需要手动定义 JSON 模式。

使用任何模型实现可靠的工具调用

BAML 即使在模型不支持原生工具调用 API 的情况下也能正常工作。我们开发了 SAP（模式对齐解析）算法，以支持 LLM 可能提供的灵活输出，例如 JSON 数据块中的 Markdown 格式，或者在回答之前的一系列思考过程。了解更多关于 SAP 的信息

借助 BAML，你的结构化输出可以在模型发布的第一天就生效。你无需再去研究某个模型是否支持并行工具调用，或者是否支持递归模式、anyOf 或 oneOf 等功能。

实际效果请参见：Deepseek-R1 和 OpenAI O1。

在几行代码中切换数百种模型

function Extract() -> Resume {
+  client openai/o3-mini
  prompt #"
    ....
  "#
}

重试策略 • 回退机制 • 模型轮转。全部静态定义。 想在运行时动态选择模型吗？请查看客户端注册表。

我们支持：OpenAI • Anthropic • Gemini • Vertex • Bedrock • Azure OpenAI • 任何兼容OpenAI的模型（Ollama、OpenRouter、VLLM、LMStudio、TogetherAI，以及其他）

构建美观的流式UI

BAML为NextJS、Python（以及任何语言）生成大量实用工具，让构建流式UI变得简单。

BAML的流式接口完全类型安全。请查看流式文档，以及我们的React钩子。

完全开源且可离线使用

• 100% 开源（Apache 2）
• 100% 私密。AGI不需要互联网连接，BAML也不需要
  • 除了您明确设置的模型调用外，不会发起任何网络请求
  • 不会存储或用于任何训练数据
• BAML文件可以保存在本地，并提交到Github以便于比较差异。
• 使用Rust构建。速度极快，几乎感觉不到它的存在。

BAML的设计理念

在创建新语法时，一切皆有可能。只要能用代码实现，就能成为你的工具。这是我们的设计理念，旨在帮助约束想法：

• 1: 尽可能避免重复发明
  • 是的，提示需要版本控制——我们有很棒的版本控制工具：git
  • 是的，你需要保存提示——我们有很棒的存储工具：文件系统
• 2: 任何文本编辑器和终端都足以使用它
• 3: 运行速度快
• 4: 大学一年级的学生也应该能够理解它

为什么需要一种新的编程语言

过去我们这样编写网站：

def home():
    return "<button onclick=\"() => alert(\\\"hello!\\\")\">点击</button>"

而现在我们这样做：

function Home() {
  return <button onClick={() => setCount(prev => prev + 1)}>
          {count} 次点击！
         </button>
}

新的语法能够以惊人的效率表达新概念。此外，维护成百上千个用于提示的f-string让我们感到非常厌恶 🤮。字符串不利于代码的可维护性。我们更倾向于结构化的字符串。

BAML的目标是赋予你英语般的表达力，同时保持代码的结构化。

完整博客文章由我们撰写。

结论

随着模型性能的不断提升，我们对它们的期望也会越来越高。但不变的是，我们需要一种方式来编写可维护的代码，以充分利用这些模型。目前我们拼接字符串的方式，让人不禁想起Web开发早期的PHP/HTML混合模式。希望今天我们分享的一些想法，能够为我们共同塑造未来的编码方式带来一点小小的改变。

常见问题解答

我需要将整个应用都用BAML编写吗？	不，只需要编写提示部分！BAML会将定义转换为你选择的语言！Python、TypeScript、Ruby及其他语言。
BAML稳定吗？	是的，许多公司已经在生产环境中使用它！我们每周都会发布更新！
为什么需要一种新语言？	跳转至章节

贡献

请查看我们的入门指南

引用

您可以按以下方式引用BAML仓库：

@software{baml,
  author = {Boundary ML},
  title = {BAML},
  url = {https://github.com/boundaryml/baml},
  year = {2024}
}

---

由Boundary用心打造

总部位于华盛顿州西雅图市

P.S. 我们正在招聘热爱Rust的软件工程师。请发送邮件至founders@boundaryml.com或通过Discord联系我们！

BAML 快速上手指南

BAML (Basically a Made-up Language) 是一种专为构建可靠 AI 工作流和智能体设计的提示词语言。它将提示词工程转化为“模式工程”，让你专注于定义数据模型，从而获得更稳定、类型安全的 LLM 输出。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统: Windows, macOS 或 Linux
• 编程语言: 选择你熟悉的主语言（支持 Python, TypeScript, Ruby, Go 等）
  • 若使用 Python: 建议版本 3.8+
  • 若使用 Node.js: 建议版本 16+
• 编辑器插件 (推荐):
  • VS Code Extension
  • JetBrains IDEs Plugin
  • 安装插件后可在 IDE 内直接可视化提示词、调试及并行测试。
• API Key: 准备好你所用大模型服务商的 API Key (如 OpenAI, Anthropic, Azure 等)。

安装步骤

BAML 的核心是 .baml 文件，通过编译器生成对应语言的客户端代码。以下以 Python 为例（其他语言逻辑类似）：

1. 安装 Python 客户端库

pip install baml-py

国内加速提示: 如果下载缓慢，可使用清华或阿里镜像源：

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

2. 初始化 BAML 项目

在项目根目录下运行初始化命令，这将创建基础的 baml_src 目录和配置文件：

baml-cli init

3. 生成客户端代码

每次修改 .baml 文件后，都需要运行生成命令来更新你的语言客户端（例如生成 baml_client 模块）：

baml-cli generate

基本使用

BAML 的核心原则是：LLM 提示词即函数。你需要定义输入参数、输出类型（Schema）以及具体的提示词内容。

第一步：定义 BAML 函数

在项目中的 baml_src/index.baml 文件中编写以下内容。这里定义了一个简单的聊天机器人函数，它接收消息列表和语气，返回结构化数据。

// baml_src/index.baml

client openai_client {
  provider OpenAI
  options {
    api_key "YOUR_OPENAI_API_KEY" // 建议替换为环境变量
  }
}

class Message {
  role string
  content string
}

class ReplyTool {
  response string
}

function ChatAgent(message: Message[], tone: "happy" | "sad") -> ReplyTool {
  client openai_client.gpt-4o-mini

  prompt #"
    Be a {{ tone }} bot.

    {% for m in message %}
    {{ _.role(m.role) }}: {{ m.content }}
    {% endfor %}
    
    Respond with a helpful message.
  "#
}

第二步：生成并调用

1. 运行生成命令：

   baml-cli generate
   

   这将在你的项目中生成 baml_client 目录。

2. 在你的 Python 代码中调用该函数：

from baml_client import b
from baml_client.types import Message

# 准备输入数据
messages = [
    Message(role="user", content="Hello, how are you?")
]

# 调用 BAML 定义的函数
# 第二个参数 "happy" 对应定义中的 tone 枚举
response = b.ChatAgent(messages, "happy")

# 获取类型安全的输出
print(response.response)

进阶：流式输出 (Streaming)

BAML 原生支持流式传输，且保持类型安全：

from baml_client import b

messages = [Message(role="user", content="Tell me a story")]

# 开启流式调用
stream = b.stream.ChatAgent(messages, "happy")

for partial_response in stream:
    # partial_response 包含当前片段的类型安全数据
    if partial_response.response:
        print(partial_response.response, end="", flush=True)

# 获取完整结果
final_result = stream.get_final_response()

通过以上步骤，你即可利用 BAML 将杂乱的字符串提示词转化为可维护、可测试且类型安全的代码模块。