一种人类友好的高级声明式语言,通过 ".book" 文件定义 AI 代理的行为、知识、规则和人格,支持自动 RAG 检索和多 LLM 提供商集成。
Promptbook 是一种人类友好的高级声明式语言与引擎,通过 "Book" 文件定义 AI 代理的行为、知识、规则和人格。
核心概念#
项目引入名为 "Book" 的声明式语言,通过 "Commitments"(承诺)来定义 AI 代理:
- PERSONA:定义 AI 代理的角色、性格和沟通风格
- KNOWLEDGE:提供特定知识、文档或上下文,支持 PDF/DOCX/URL,自动 RAG 检索
- RULE:强制执行特定行为约束,可通过对抗代理强制执行
- TEAM:定义团队结构和可咨询的其他专家成员
Book 文件示例#
Paul Smith & Associés
PERSONA You are a company lawyer.
Your job is to provide legal advice and support to the company and its employees.
RULE Always ensure compliance with laws and regulations.
RULE Never provide legal advice outside your area of expertise.
KNOWLEDGE https://company.com/company-policies.pdf
生态系统组件#
| 组件 | 说明 |
|---|---|
| Book Language | 人类友好的高级声明式语言,文件扩展名 .book |
| Promptbook Engine | 运行 Book 语言的引擎,发布为多个 NPM 包 |
| Agents Server | AI 代理的托管和管理平台 |
| VSCode Plugin | 支持 .book 文件扩展名的编辑器插件 |
安装方式#
# 安装完整包
npm i ptbk
# 或
npm i promptbook
# 核心包
npm i @promptbook/core
npm i @promptbook/node # Node.js 环境
npm i @promptbook/browser # 浏览器环境
# LLM 提供商集成
npm i @promptbook/openai
npm i @promptbook/anthropic-claude
npm i @promptbook/google
npm i @promptbook/deepseek
npm i @promptbook/ollama
npm i @promptbook/azure-openai
典型应用场景#
- Chat Apps:创建利用公司知识提供准确响应的聊天应用
- Reply Agent:自动生成上下文感知的电子邮件回复草稿
- Coding Agent:在 vibecoding 平台中强制执行编码风格和架构规则
- Internal Expertise:将 AI 集成到内部应用中进行数据分析、情感分析等
能力边界#
支持:多 LLM 提供商(OpenAI、Claude、Gemini、DeepSeek、Ollama、Azure)、自动 RAG 检索与向量数据库集成、多代理团队协作定义、PDF/DOCX/网页知识源导入、Node.js / Browser / Docker 运行环境
不支持/限制:流式响应(待实现)、递归逻辑、非文本媒体(图像、音频、视频、电子表格)为主的应用