@promptbook/editable 0.112.0-16 → 0.112.0-18

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
 
@@ -60,11 +60,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
60
60
 
61
61
  ## 📖 The Book Whitepaper
62
62
 
63
+ 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.
64
+
63
65
  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.
64
66
 
65
67
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
66
68
 
67
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
69
+ 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.
68
70
 
69
71
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
70
72
 
@@ -72,8 +74,13 @@ In Promptbook, you can define your context **using simple Books** that are very
72
74
  <br/>
73
75
  **PERSONA** You are a company lawyer.<br/>
74
76
  Your job is to provide legal advice and support to the company and its employees.<br/>
77
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
75
78
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
76
- 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/>
79
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
80
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
81
+ **USE EMAIL**<br/>
82
+ **USE BROWSER**<br/>
83
+ **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/>
77
84
 
78
85
  </td></tr></table>
79
86
 
@@ -96,6 +103,22 @@ Personas define the character of your AI persona, its role, and how it should in
96
103
  **<ins>Paul Smith & Associés</ins>**<br/>
97
104
  <br/>
98
105
  **PERSONA** You are a company lawyer.<br/>
106
+ Your job is to provide legal advice and support to the company and its employees.<br/>
107
+
108
+ </td></tr></table>
109
+
110
+ #### `Goal` commitment
111
+
112
+ 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.
113
+
114
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
115
+
116
+ **<ins>Paul Smith & Associés</ins>**<br/>
117
+ <br/>
118
+ **PERSONA** You are a company lawyer.<br/>
119
+ Your job is to provide legal advice and support to the company and its employees.<br/>
120
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
121
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
99
122
 
100
123
  </td></tr></table>
101
124
 
@@ -113,9 +136,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
113
136
  <br/>
114
137
  **PERSONA** You are a company lawyer.<br/>
115
138
  Your job is to provide legal advice and support to the company and its employees.<br/>
116
- You are knowledgeable, professional, and detail-oriented.<br/>
117
- <br/>
118
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
139
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
140
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
141
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
119
142
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
120
143
 
121
144
  </td></tr></table>
@@ -132,13 +155,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
132
155
  <br/>
133
156
  **PERSONA** You are a company lawyer.<br/>
134
157
  Your job is to provide legal advice and support to the company and its employees.<br/>
135
- You are knowledgeable, professional, and detail-oriented.<br/>
158
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
159
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
160
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
161
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
162
+ **RULE** Never provide legal advice about criminal law.<br/>
163
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
164
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
165
+
166
+ </td></tr></table>
167
+
168
+ #### `Use` commitments
169
+
170
+ 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.
171
+
172
+ These are what turn a chatbot into a persistent agent that actually does work.
173
+
174
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
175
+
176
+ **<ins>Paul Smith & Associés</ins>**<br/>
136
177
  <br/>
137
- **RULE** Always ensure compliance with laws and regulations.<br/>
178
+ **PERSONA** You are a company lawyer.<br/>
179
+ Your job is to provide legal advice and support to the company and its employees.<br/>
180
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
181
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
182
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
138
183
  **RULE** Never provide legal advice outside your area of expertise.<br/>
139
184
  **RULE** Never provide legal advice about criminal law.<br/>
140
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
185
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
141
186
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
187
+ **USE EMAIL**<br/>
188
+ **USE BROWSER**<br/>
189
+ **USE SEARCH ENGINE**<br/>
142
190
 
143
191
  </td></tr></table>
144
192
 
@@ -152,32 +200,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
152
200
  <br/>
153
201
  **PERSONA** You are a company lawyer.<br/>
154
202
  Your job is to provide legal advice and support to the company and its employees.<br/>
155
- You are knowledgeable, professional, and detail-oriented.<br/>
156
- <br/>
157
- **RULE** Always ensure compliance with laws and regulations.<br/>
203
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
204
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
205
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
158
206
  **RULE** Never provide legal advice outside your area of expertise.<br/>
159
207
  **RULE** Never provide legal advice about criminal law.<br/>
160
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
208
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
161
209
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
162
- 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/>
210
+ **USE EMAIL**<br/>
211
+ **USE BROWSER**<br/>
212
+ **USE SEARCH ENGINE**<br/>
213
+ **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/>
163
214
 
164
215
  </td></tr></table>
165
216
 
166
-
167
-
168
217
  ### Promptbook Ecosystem
169
218
 
170
- !!!@@@
219
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
171
220
 
172
- #### Promptbook Server
221
+ #### Agents Server
173
222
 
174
- !!!@@@
223
+ 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.
175
224
 
176
225
  #### Promptbook Engine
177
226
 
178
- !!!@@@
179
-
180
-
227
+ 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).
181
228
 
182
229
 
183
230
 
@@ -191,7 +238,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
191
238
 
192
239
  ## 💜 The Promptbook Project
193
240
 
194
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
241
+ 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:
195
242
 
196
243
  <table>
197
244
  <thead>
@@ -202,9 +249,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
202
249
  </thead>
203
250
  <tbody>
204
251
  <tr>
205
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
252
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
206
253
  <td>
207
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
254
+ 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>.
208
255
  </td>
209
256
  </tr>
210
257
  <tr>
@@ -218,17 +265,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
218
265
  <tr>
219
266
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
220
267
  <td>
221
- Promptbook engine can run AI agents based on Book language.
222
- 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>
223
- Agent Server is based on Promptbook Engine.
268
+ 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.
269
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
224
270
  </td>
225
271
  </tr>
226
272
 
227
273
  </tbody>
228
274
  </table>
229
275
 
230
-
231
-
232
276
  ### 🌐 Community & Social Media
233
277
 
234
278
  Join our growing community of developers and users:
@@ -285,8 +329,6 @@ Join our growing community of developers and users:
285
329
 
286
330
 
287
331
 
288
-
289
-
290
332
  ## 📚 Documentation
291
333
 
292
334
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -295,9 +337,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
295
337
 
296
338
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
297
339
 
298
- ## 📦 Packages _(for developers)_
340
+ ## 📦 Deployment & Packages
341
+
342
+ The fastest way to get started is with the **Agents Server**:
299
343
 
300
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
344
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
345
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
346
+
347
+ ### NPM Packages _(for developers embedding the Engine)_
348
+
349
+ 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).
301
350
  You can install all of them at once:
302
351
 
303
352
  ```bash
@@ -316,7 +365,6 @@ Or you can install them separately:
316
365
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
317
366
  - ⭐ **[@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
318
367
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
319
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
320
368
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
321
369
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
322
370
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -338,8 +386,7 @@ Or you can install them separately:
338
386
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
339
387
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
340
388
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
341
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
342
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
389
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
343
390
 
344
391
 
345
392
 
@@ -363,8 +410,6 @@ The following glossary is used to clarify certain concepts:
363
410
 
364
411
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
365
412
 
366
-
367
-
368
413
  ### 💯 Core concepts
369
414
 
370
415
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -426,31 +471,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
426
471
 
427
472
 
428
473
 
474
+ ## � Agents Server
475
+
476
+ 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.
477
+
478
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
479
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
480
+ - **API** for integrating agents into your own applications
481
+
429
482
  ## 🚂 Promptbook Engine
430
483
 
484
+ 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.
485
+
431
486
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
432
487
 
433
488
  ## ➕➖ When to use Promptbook?
434
489
 
435
490
  ### ➕ When to use
436
491
 
437
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
438
- - When you want to **separate code from text prompts**
439
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
440
- - When you want to **orchestrate multiple prompts** together
441
- - When you want to **reuse** parts of prompts in multiple places
442
- - When you want to **version** your prompts and **test multiple versions**
443
- - When you want to **log** the execution of prompts and backtrace the issues
492
+ - When you want to **deploy persistent AI agents** that work on goals for your company
493
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
494
+ - When you want agents that **collaborate in teams** and consult each other
495
+ - When you need to **integrate AI agents into your existing applications** via API
496
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
497
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
498
+ - When you want to **version** your agent definitions and **test multiple versions**
499
+ - When you want to **log** agent execution and backtrace issues
444
500
 
445
501
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
446
502
 
447
503
  ### ➖ When not to use
448
504
 
449
- - When you have already implemented single simple prompt and it works fine for your job
505
+ - When a single simple prompt already works fine for your job
450
506
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
451
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
507
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
452
508
  - 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))_
453
- - 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))_
509
+ - 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))_
454
510
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
455
511
 
456
512
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -17,7 +17,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
17
17
  * @generated
18
18
  * @see https://github.com/webgptorg/promptbook
19
19
  */
20
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
20
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-18';
21
21
  /**
22
22
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
23
23
  * 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-17`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/editable",
3
- "version": "0.112.0-16",
3
+ "version": "0.112.0-18",
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/editable.index.d.ts",
100
100
  "peerDependencies": {
101
- "@promptbook/core": "0.112.0-16"
101
+ "@promptbook/core": "0.112.0-18"
102
102
  },
103
103
  "dependencies": {
104
104
  "crypto-js": "4.2.0",
package/umd/index.umd.js CHANGED
@@ -22,7 +22,7 @@
22
22
  * @generated
23
23
  * @see https://github.com/webgptorg/promptbook
24
24
  */
25
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
25
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-18';
26
26
  /**
27
27
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
28
28
  * 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-17`).
19
19
  *
20
20
  * @generated
21
21
  */