@promptbook/browser 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
 
@@ -100,11 +100,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
100
100
 
101
101
  ## 📖 The Book Whitepaper
102
102
 
103
+ 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.
104
+
103
105
  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.
104
106
 
105
107
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
106
108
 
107
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
109
+ 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.
108
110
 
109
111
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
110
112
 
@@ -112,8 +114,13 @@ In Promptbook, you can define your context **using simple Books** that are very
112
114
  <br/>
113
115
  **PERSONA** You are a company lawyer.<br/>
114
116
  Your job is to provide legal advice and support to the company and its employees.<br/>
117
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
115
118
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
116
- 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/>
119
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
120
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
121
+ **USE EMAIL**<br/>
122
+ **USE BROWSER**<br/>
123
+ **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/>
117
124
 
118
125
  </td></tr></table>
119
126
 
@@ -136,6 +143,22 @@ Personas define the character of your AI persona, its role, and how it should in
136
143
  **<ins>Paul Smith & Associés</ins>**<br/>
137
144
  <br/>
138
145
  **PERSONA** You are a company lawyer.<br/>
146
+ Your job is to provide legal advice and support to the company and its employees.<br/>
147
+
148
+ </td></tr></table>
149
+
150
+ #### `Goal` commitment
151
+
152
+ 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.
153
+
154
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
155
+
156
+ **<ins>Paul Smith & Associés</ins>**<br/>
157
+ <br/>
158
+ **PERSONA** You are a company lawyer.<br/>
159
+ Your job is to provide legal advice and support to the company and its employees.<br/>
160
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
161
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
139
162
 
140
163
  </td></tr></table>
141
164
 
@@ -153,9 +176,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
153
176
  <br/>
154
177
  **PERSONA** You are a company lawyer.<br/>
155
178
  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
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
179
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
180
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
181
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
159
182
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
160
183
 
161
184
  </td></tr></table>
@@ -172,13 +195,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
172
195
  <br/>
173
196
  **PERSONA** You are a company lawyer.<br/>
174
197
  Your job is to provide legal advice and support to the company and its employees.<br/>
175
- You are knowledgeable, professional, and detail-oriented.<br/>
198
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
199
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
200
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
201
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
202
+ **RULE** Never provide legal advice about criminal law.<br/>
203
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
204
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
205
+
206
+ </td></tr></table>
207
+
208
+ #### `Use` commitments
209
+
210
+ 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.
211
+
212
+ These are what turn a chatbot into a persistent agent that actually does work.
213
+
214
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
215
+
216
+ **<ins>Paul Smith & Associés</ins>**<br/>
176
217
  <br/>
177
- **RULE** Always ensure compliance with laws and regulations.<br/>
218
+ **PERSONA** You are a company lawyer.<br/>
219
+ Your job is to provide legal advice and support to the company and its employees.<br/>
220
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
221
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
222
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
178
223
  **RULE** Never provide legal advice outside your area of expertise.<br/>
179
224
  **RULE** Never provide legal advice about criminal law.<br/>
180
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
225
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
181
226
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
227
+ **USE EMAIL**<br/>
228
+ **USE BROWSER**<br/>
229
+ **USE SEARCH ENGINE**<br/>
182
230
 
183
231
  </td></tr></table>
184
232
 
@@ -192,32 +240,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
192
240
  <br/>
193
241
  **PERSONA** You are a company lawyer.<br/>
194
242
  Your job is to provide legal advice and support to the company and its employees.<br/>
195
- You are knowledgeable, professional, and detail-oriented.<br/>
196
- <br/>
197
- **RULE** Always ensure compliance with laws and regulations.<br/>
243
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
244
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
245
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
198
246
  **RULE** Never provide legal advice outside your area of expertise.<br/>
199
247
  **RULE** Never provide legal advice about criminal law.<br/>
200
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
248
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
201
249
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
202
- 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/>
250
+ **USE EMAIL**<br/>
251
+ **USE BROWSER**<br/>
252
+ **USE SEARCH ENGINE**<br/>
253
+ **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/>
203
254
 
204
255
  </td></tr></table>
205
256
 
206
-
207
-
208
257
  ### Promptbook Ecosystem
209
258
 
210
- !!!@@@
259
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
211
260
 
212
- #### Promptbook Server
261
+ #### Agents Server
213
262
 
214
- !!!@@@
263
+ 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.
215
264
 
216
265
  #### Promptbook Engine
217
266
 
218
- !!!@@@
219
-
220
-
267
+ 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).
221
268
 
222
269
 
223
270
 
@@ -231,7 +278,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
231
278
 
232
279
  ## 💜 The Promptbook Project
233
280
 
234
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
281
+ 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:
235
282
 
236
283
  <table>
237
284
  <thead>
@@ -242,9 +289,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
242
289
  </thead>
243
290
  <tbody>
244
291
  <tr>
245
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
292
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
246
293
  <td>
247
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
294
+ 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>.
248
295
  </td>
249
296
  </tr>
250
297
  <tr>
@@ -258,17 +305,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
258
305
  <tr>
259
306
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
260
307
  <td>
261
- Promptbook engine can run AI agents based on Book language.
262
- 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>
263
- Agent Server is based on Promptbook Engine.
308
+ 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.
309
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
264
310
  </td>
265
311
  </tr>
266
312
 
267
313
  </tbody>
268
314
  </table>
269
315
 
270
-
271
-
272
316
  ### 🌐 Community & Social Media
273
317
 
274
318
  Join our growing community of developers and users:
@@ -325,8 +369,6 @@ Join our growing community of developers and users:
325
369
 
326
370
 
327
371
 
328
-
329
-
330
372
  ## 📚 Documentation
331
373
 
332
374
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -335,9 +377,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
335
377
 
336
378
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
337
379
 
338
- ## 📦 Packages _(for developers)_
380
+ ## 📦 Deployment & Packages
381
+
382
+ The fastest way to get started is with the **Agents Server**:
339
383
 
340
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
384
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
385
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
386
+
387
+ ### NPM Packages _(for developers embedding the Engine)_
388
+
389
+ 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).
341
390
  You can install all of them at once:
342
391
 
343
392
  ```bash
@@ -356,7 +405,6 @@ Or you can install them separately:
356
405
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
357
406
  - ⭐ **[@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
358
407
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
359
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
360
408
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
361
409
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
362
410
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -378,8 +426,7 @@ Or you can install them separately:
378
426
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
379
427
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
380
428
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
381
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
382
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
429
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
383
430
 
384
431
 
385
432
 
@@ -403,8 +450,6 @@ The following glossary is used to clarify certain concepts:
403
450
 
404
451
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
405
452
 
406
-
407
-
408
453
  ### 💯 Core concepts
409
454
 
410
455
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -466,31 +511,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
466
511
 
467
512
 
468
513
 
514
+ ## � Agents Server
515
+
516
+ 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.
517
+
518
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
519
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
520
+ - **API** for integrating agents into your own applications
521
+
469
522
  ## 🚂 Promptbook Engine
470
523
 
524
+ 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.
525
+
471
526
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
472
527
 
473
528
  ## ➕➖ When to use Promptbook?
474
529
 
475
530
  ### ➕ When to use
476
531
 
477
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
478
- - When you want to **separate code from text prompts**
479
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
480
- - When you want to **orchestrate multiple prompts** together
481
- - When you want to **reuse** parts of prompts in multiple places
482
- - When you want to **version** your prompts and **test multiple versions**
483
- - When you want to **log** the execution of prompts and backtrace the issues
532
+ - When you want to **deploy persistent AI agents** that work on goals for your company
533
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
534
+ - When you want agents that **collaborate in teams** and consult each other
535
+ - When you need to **integrate AI agents into your existing applications** via API
536
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
537
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
538
+ - When you want to **version** your agent definitions and **test multiple versions**
539
+ - When you want to **log** agent execution and backtrace issues
484
540
 
485
541
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
486
542
 
487
543
  ### ➖ When not to use
488
544
 
489
- - When you have already implemented single simple prompt and it works fine for your job
545
+ - When a single simple prompt already works fine for your job
490
546
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
491
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
547
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
492
548
  - 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))_
493
- - 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))_
549
+ - 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))_
494
550
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
495
551
 
496
552
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -29,7 +29,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
29
29
  * @generated
30
30
  * @see https://github.com/webgptorg/promptbook
31
31
  */
32
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
32
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-18';
33
33
  /**
34
34
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
35
35
  * 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/browser",
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,
@@ -97,7 +97,7 @@
97
97
  "module": "./esm/index.es.js",
98
98
  "typings": "./esm/typings/src/_packages/browser.index.d.ts",
99
99
  "peerDependencies": {
100
- "@promptbook/core": "0.112.0-16"
100
+ "@promptbook/core": "0.112.0-18"
101
101
  },
102
102
  "dependencies": {
103
103
  "@openai/agents": "0.4.12",
package/umd/index.umd.js CHANGED
@@ -27,7 +27,7 @@
27
27
  * @generated
28
28
  * @see https://github.com/webgptorg/promptbook
29
29
  */
30
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
30
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-18';
31
31
  /**
32
32
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
33
33
  * 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
  */