@promptbook/documents 0.112.0-16 → 0.112.0-17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # ✨ Promptbook: AI Agents
4
4
 
5
- Turn your company's scattered knowledge into AI ready Books
5
+ Create persistent AI agents that turn your company's scattered knowledge into action powered by the [Agents Server](https://gallery.ptbk.io/)
6
6
 
7
7
 
8
8
 
@@ -61,11 +61,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
61
61
 
62
62
  ## 📖 The Book Whitepaper
63
63
 
64
+ Promptbook lets you create **persistent AI agents** that work on real goals for your company. The [**Agents Server**](https://gallery.ptbk.io/) is the heart of the project — a place where your AI agents live, remember context, collaborate in teams, and get things done.
65
+
64
66
  Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as GPT-5.2 and Claude-4.5 are incredibly capable.
65
67
 
66
68
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
67
69
 
68
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
70
+ In Promptbook, you define your agents **using simple Books** — a human-readable language that is explicit, easy to understand and write, reliable, and highly portable. You then deploy them to the **Agents Server**, where they run persistently and work toward their goals.
69
71
 
70
72
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
71
73
 
@@ -73,8 +75,13 @@ In Promptbook, you can define your context **using simple Books** that are very
73
75
  <br/>
74
76
  **PERSONA** You are a company lawyer.<br/>
75
77
  Your job is to provide legal advice and support to the company and its employees.<br/>
78
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
76
79
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
77
- TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
80
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
81
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
82
+ **USE EMAIL**<br/>
83
+ **USE BROWSER**<br/>
84
+ **TEAM** You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
78
85
 
79
86
  </td></tr></table>
80
87
 
@@ -97,6 +104,22 @@ Personas define the character of your AI persona, its role, and how it should in
97
104
  **<ins>Paul Smith & Associés</ins>**<br/>
98
105
  <br/>
99
106
  **PERSONA** You are a company lawyer.<br/>
107
+ Your job is to provide legal advice and support to the company and its employees.<br/>
108
+
109
+ </td></tr></table>
110
+
111
+ #### `Goal` commitment
112
+
113
+ Goals define what the agent should actively work toward. Unlike a chatbot that only responds when asked, an agent with goals takes initiative and works on tasks persistently on the Agents Server.
114
+
115
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
116
+
117
+ **<ins>Paul Smith & Associés</ins>**<br/>
118
+ <br/>
119
+ **PERSONA** You are a company lawyer.<br/>
120
+ Your job is to provide legal advice and support to the company and its employees.<br/>
121
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
122
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
100
123
 
101
124
  </td></tr></table>
102
125
 
@@ -114,9 +137,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
114
137
  <br/>
115
138
  **PERSONA** You are a company lawyer.<br/>
116
139
  Your job is to provide legal advice and support to the company and its employees.<br/>
117
- You are knowledgeable, professional, and detail-oriented.<br/>
118
- <br/>
119
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
140
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
141
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
142
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
120
143
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
121
144
 
122
145
  </td></tr></table>
@@ -133,13 +156,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
133
156
  <br/>
134
157
  **PERSONA** You are a company lawyer.<br/>
135
158
  Your job is to provide legal advice and support to the company and its employees.<br/>
136
- You are knowledgeable, professional, and detail-oriented.<br/>
159
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
160
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
161
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
162
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
163
+ **RULE** Never provide legal advice about criminal law.<br/>
164
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
165
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
166
+
167
+ </td></tr></table>
168
+
169
+ #### `Use` commitments
170
+
171
+ Use commitments grant the agent real capabilities — tools it can use to interact with the outside world. `USE EMAIL` lets the agent send emails, `USE BROWSER` lets it access and read web content, `USE SEARCH ENGINE` lets it search the web, and many more.
172
+
173
+ These are what turn a chatbot into a persistent agent that actually does work.
174
+
175
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
176
+
177
+ **<ins>Paul Smith & Associés</ins>**<br/>
137
178
  <br/>
138
- **RULE** Always ensure compliance with laws and regulations.<br/>
179
+ **PERSONA** You are a company lawyer.<br/>
180
+ Your job is to provide legal advice and support to the company and its employees.<br/>
181
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
182
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
183
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
139
184
  **RULE** Never provide legal advice outside your area of expertise.<br/>
140
185
  **RULE** Never provide legal advice about criminal law.<br/>
141
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
186
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
142
187
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
188
+ **USE EMAIL**<br/>
189
+ **USE BROWSER**<br/>
190
+ **USE SEARCH ENGINE**<br/>
143
191
 
144
192
  </td></tr></table>
145
193
 
@@ -153,32 +201,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
153
201
  <br/>
154
202
  **PERSONA** You are a company lawyer.<br/>
155
203
  Your job is to provide legal advice and support to the company and its employees.<br/>
156
- You are knowledgeable, professional, and detail-oriented.<br/>
157
- <br/>
158
- **RULE** Always ensure compliance with laws and regulations.<br/>
204
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
205
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
206
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
159
207
  **RULE** Never provide legal advice outside your area of expertise.<br/>
160
208
  **RULE** Never provide legal advice about criminal law.<br/>
161
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
209
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
162
210
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
163
- TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
211
+ **USE EMAIL**<br/>
212
+ **USE BROWSER**<br/>
213
+ **USE SEARCH ENGINE**<br/>
214
+ **TEAM** You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
164
215
 
165
216
  </td></tr></table>
166
217
 
167
-
168
-
169
218
  ### Promptbook Ecosystem
170
219
 
171
- !!!@@@
220
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
172
221
 
173
- #### Promptbook Server
222
+ #### Agents Server
174
223
 
175
- !!!@@@
224
+ The [**Agents Server**](https://gallery.ptbk.io/) is the primary way to use Promptbook. It is a web application where your AI agents live and work. You can create agents, give them knowledge and rules using the Book language, organize them into teams, and let them work on goals persistently. The Agents Server provides a UI for managing agents, an API for integrating them into your applications, and can be self-hosted via [Docker](https://hub.docker.com/r/hejny/promptbook/) or deployed on Vercel.
176
225
 
177
226
  #### Promptbook Engine
178
227
 
179
- !!!@@@
180
-
181
-
228
+ The [Promptbook Engine](https://github.com/webgptorg/promptbook) is the open-source core that powers everything. It parses the Book language, applies commitments, manages LLM provider integrations, and executes agents. The Agents Server is built on top of the Engine. If you need to embed agent capabilities directly into your own application, you can use the Engine as a standalone TypeScript/JavaScript library via [NPM packages](https://www.npmjs.com/package/@promptbook/core).
182
229
 
183
230
 
184
231
 
@@ -192,7 +239,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
192
239
 
193
240
  ## 💜 The Promptbook Project
194
241
 
195
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
242
+ Promptbook project is an ecosystem centered around the **Agents Server** — a platform for creating, deploying, and running persistent AI agents. Following is a list of the most important pieces of the project:
196
243
 
197
244
  <table>
198
245
  <thead>
@@ -203,9 +250,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
203
250
  </thead>
204
251
  <tbody>
205
252
  <tr>
206
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
253
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
207
254
  <td>
208
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
255
+ The primary way to use Promptbook. A production-ready platform where your AI agents live create, manage, deploy, and interact with persistent agents that work on goals. Available as a hosted service or <a href="https://hub.docker.com/r/hejny/promptbook/">self-hosted via Docker</a>.
209
256
  </td>
210
257
  </tr>
211
258
  <tr>
@@ -219,17 +266,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
219
266
  <tr>
220
267
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
221
268
  <td>
222
- Promptbook engine can run AI agents based on Book language.
223
- It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Promptbook Agent Server as Docker Package</a>
224
- Agent Server is based on Promptbook Engine.
269
+ The open-source core that powers the Agents Server. Can also be used as a standalone TypeScript/JavaScript library to embed agent capabilities into your own applications.
270
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
225
271
  </td>
226
272
  </tr>
227
273
 
228
274
  </tbody>
229
275
  </table>
230
276
 
231
-
232
-
233
277
  ### 🌐 Community & Social Media
234
278
 
235
279
  Join our growing community of developers and users:
@@ -286,8 +330,6 @@ Join our growing community of developers and users:
286
330
 
287
331
 
288
332
 
289
-
290
-
291
333
  ## 📚 Documentation
292
334
 
293
335
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -296,9 +338,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
296
338
 
297
339
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
298
340
 
299
- ## 📦 Packages _(for developers)_
341
+ ## 📦 Deployment & Packages
342
+
343
+ The fastest way to get started is with the **Agents Server**:
300
344
 
301
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
345
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
346
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
347
+
348
+ ### NPM Packages _(for developers embedding the Engine)_
349
+
350
+ If you want to embed the Promptbook Engine directly into your application, the library is divided into several packages published from a [single monorepo](https://github.com/webgptorg/promptbook).
302
351
  You can install all of them at once:
303
352
 
304
353
  ```bash
@@ -317,7 +366,6 @@ Or you can install them separately:
317
366
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
318
367
  - ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
319
368
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
320
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
321
369
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
322
370
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
323
371
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -339,8 +387,7 @@ Or you can install them separately:
339
387
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
340
388
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
341
389
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
342
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
343
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
390
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
344
391
 
345
392
 
346
393
 
@@ -364,8 +411,6 @@ The following glossary is used to clarify certain concepts:
364
411
 
365
412
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
366
413
 
367
-
368
-
369
414
  ### 💯 Core concepts
370
415
 
371
416
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -427,31 +472,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
427
472
 
428
473
 
429
474
 
475
+ ## � Agents Server
476
+
477
+ The **[Agents Server](https://gallery.ptbk.io/)** is the primary way to use Promptbook. It is a production-ready platform where you create, deploy, and manage persistent AI agents that work toward goals. Agents remember context across conversations, collaborate in teams, and follow the rules and knowledge you define in the Book language.
478
+
479
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
480
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
481
+ - **API** for integrating agents into your own applications
482
+
430
483
  ## 🚂 Promptbook Engine
431
484
 
485
+ The Engine is the open-source core that powers the Agents Server. If you need to embed agent capabilities directly into your TypeScript/JavaScript application, you can use it as a standalone library.
486
+
432
487
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
433
488
 
434
489
  ## ➕➖ When to use Promptbook?
435
490
 
436
491
  ### ➕ When to use
437
492
 
438
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
439
- - When you want to **separate code from text prompts**
440
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
441
- - When you want to **orchestrate multiple prompts** together
442
- - When you want to **reuse** parts of prompts in multiple places
443
- - When you want to **version** your prompts and **test multiple versions**
444
- - When you want to **log** the execution of prompts and backtrace the issues
493
+ - When you want to **deploy persistent AI agents** that work on goals for your company
494
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
495
+ - When you want agents that **collaborate in teams** and consult each other
496
+ - When you need to **integrate AI agents into your existing applications** via API
497
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
498
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
499
+ - When you want to **version** your agent definitions and **test multiple versions**
500
+ - When you want to **log** agent execution and backtrace issues
445
501
 
446
502
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
447
503
 
448
504
  ### ➖ When not to use
449
505
 
450
- - When you have already implemented single simple prompt and it works fine for your job
506
+ - When a single simple prompt already works fine for your job
451
507
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
452
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
508
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
453
509
  - When you need to use something other than JavaScript or TypeScript _(other languages are on the way, [see the discussion](https://github.com/webgptorg/promptbook/discussions/101))_
454
- - When your main focus is on something other than text - like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
510
+ - When your main focus is on something other than text like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
455
511
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
456
512
 
457
513
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
26
26
  * @generated
27
27
  * @see https://github.com/webgptorg/promptbook
28
28
  */
29
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
30
30
  /**
31
31
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
32
32
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.112.0-15`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/documents",
3
- "version": "0.112.0-16",
3
+ "version": "0.112.0-17",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -98,7 +98,7 @@
98
98
  "module": "./esm/index.es.js",
99
99
  "typings": "./esm/typings/src/_packages/documents.index.d.ts",
100
100
  "peerDependencies": {
101
- "@promptbook/core": "0.112.0-16"
101
+ "@promptbook/core": "0.112.0-17"
102
102
  },
103
103
  "dependencies": {
104
104
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -24,7 +24,7 @@
24
24
  * @generated
25
25
  * @see https://github.com/webgptorg/promptbook
26
26
  */
27
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
27
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
28
28
  /**
29
29
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
30
30
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.112.0-15`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */