@promptbook/components 0.112.0-15 → 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
 
@@ -201,11 +201,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
201
201
 
202
202
  ## 📖 The Book Whitepaper
203
203
 
204
+ 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.
205
+
204
206
  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.
205
207
 
206
208
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
207
209
 
208
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
210
+ 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.
209
211
 
210
212
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
211
213
 
@@ -213,8 +215,13 @@ In Promptbook, you can define your context **using simple Books** that are very
213
215
  <br/>
214
216
  **PERSONA** You are a company lawyer.<br/>
215
217
  Your job is to provide legal advice and support to the company and its employees.<br/>
218
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
216
219
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
217
- 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/>
220
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
221
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
222
+ **USE EMAIL**<br/>
223
+ **USE BROWSER**<br/>
224
+ **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/>
218
225
 
219
226
  </td></tr></table>
220
227
 
@@ -237,6 +244,22 @@ Personas define the character of your AI persona, its role, and how it should in
237
244
  **<ins>Paul Smith & Associés</ins>**<br/>
238
245
  <br/>
239
246
  **PERSONA** You are a company lawyer.<br/>
247
+ Your job is to provide legal advice and support to the company and its employees.<br/>
248
+
249
+ </td></tr></table>
250
+
251
+ #### `Goal` commitment
252
+
253
+ 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.
254
+
255
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
256
+
257
+ **<ins>Paul Smith & Associés</ins>**<br/>
258
+ <br/>
259
+ **PERSONA** You are a company lawyer.<br/>
260
+ Your job is to provide legal advice and support to the company and its employees.<br/>
261
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
262
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
240
263
 
241
264
  </td></tr></table>
242
265
 
@@ -254,9 +277,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
254
277
  <br/>
255
278
  **PERSONA** You are a company lawyer.<br/>
256
279
  Your job is to provide legal advice and support to the company and its employees.<br/>
257
- You are knowledgeable, professional, and detail-oriented.<br/>
258
- <br/>
259
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
280
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
281
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
282
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
260
283
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
261
284
 
262
285
  </td></tr></table>
@@ -273,13 +296,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
273
296
  <br/>
274
297
  **PERSONA** You are a company lawyer.<br/>
275
298
  Your job is to provide legal advice and support to the company and its employees.<br/>
276
- You are knowledgeable, professional, and detail-oriented.<br/>
299
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
300
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
301
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
302
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
303
+ **RULE** Never provide legal advice about criminal law.<br/>
304
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
305
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
306
+
307
+ </td></tr></table>
308
+
309
+ #### `Use` commitments
310
+
311
+ 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.
312
+
313
+ These are what turn a chatbot into a persistent agent that actually does work.
314
+
315
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
316
+
317
+ **<ins>Paul Smith & Associés</ins>**<br/>
277
318
  <br/>
278
- **RULE** Always ensure compliance with laws and regulations.<br/>
319
+ **PERSONA** You are a company lawyer.<br/>
320
+ Your job is to provide legal advice and support to the company and its employees.<br/>
321
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
322
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
323
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
279
324
  **RULE** Never provide legal advice outside your area of expertise.<br/>
280
325
  **RULE** Never provide legal advice about criminal law.<br/>
281
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
326
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
282
327
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
328
+ **USE EMAIL**<br/>
329
+ **USE BROWSER**<br/>
330
+ **USE SEARCH ENGINE**<br/>
283
331
 
284
332
  </td></tr></table>
285
333
 
@@ -293,32 +341,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
293
341
  <br/>
294
342
  **PERSONA** You are a company lawyer.<br/>
295
343
  Your job is to provide legal advice and support to the company and its employees.<br/>
296
- You are knowledgeable, professional, and detail-oriented.<br/>
297
- <br/>
298
- **RULE** Always ensure compliance with laws and regulations.<br/>
344
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
345
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
346
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
299
347
  **RULE** Never provide legal advice outside your area of expertise.<br/>
300
348
  **RULE** Never provide legal advice about criminal law.<br/>
301
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
349
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
302
350
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
303
- 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/>
351
+ **USE EMAIL**<br/>
352
+ **USE BROWSER**<br/>
353
+ **USE SEARCH ENGINE**<br/>
354
+ **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/>
304
355
 
305
356
  </td></tr></table>
306
357
 
307
-
308
-
309
358
  ### Promptbook Ecosystem
310
359
 
311
- !!!@@@
360
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
312
361
 
313
- #### Promptbook Server
362
+ #### Agents Server
314
363
 
315
- !!!@@@
364
+ 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.
316
365
 
317
366
  #### Promptbook Engine
318
367
 
319
- !!!@@@
320
-
321
-
368
+ 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).
322
369
 
323
370
 
324
371
 
@@ -332,7 +379,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
332
379
 
333
380
  ## 💜 The Promptbook Project
334
381
 
335
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
382
+ 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:
336
383
 
337
384
  <table>
338
385
  <thead>
@@ -343,9 +390,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
343
390
  </thead>
344
391
  <tbody>
345
392
  <tr>
346
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
393
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
347
394
  <td>
348
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
395
+ 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>.
349
396
  </td>
350
397
  </tr>
351
398
  <tr>
@@ -359,17 +406,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
359
406
  <tr>
360
407
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
361
408
  <td>
362
- Promptbook engine can run AI agents based on Book language.
363
- 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>
364
- Agent Server is based on Promptbook Engine.
409
+ 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.
410
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
365
411
  </td>
366
412
  </tr>
367
413
 
368
414
  </tbody>
369
415
  </table>
370
416
 
371
-
372
-
373
417
  ### 🌐 Community & Social Media
374
418
 
375
419
  Join our growing community of developers and users:
@@ -426,8 +470,6 @@ Join our growing community of developers and users:
426
470
 
427
471
 
428
472
 
429
-
430
-
431
473
  ## 📚 Documentation
432
474
 
433
475
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -436,9 +478,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
436
478
 
437
479
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
438
480
 
439
- ## 📦 Packages _(for developers)_
481
+ ## 📦 Deployment & Packages
482
+
483
+ The fastest way to get started is with the **Agents Server**:
440
484
 
441
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
485
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
486
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
487
+
488
+ ### NPM Packages _(for developers embedding the Engine)_
489
+
490
+ 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).
442
491
  You can install all of them at once:
443
492
 
444
493
  ```bash
@@ -457,7 +506,6 @@ Or you can install them separately:
457
506
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
458
507
  - ⭐ **[@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
459
508
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
460
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
461
509
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
462
510
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
463
511
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -479,8 +527,7 @@ Or you can install them separately:
479
527
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
480
528
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
481
529
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
482
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
483
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
530
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
484
531
 
485
532
 
486
533
 
@@ -504,8 +551,6 @@ The following glossary is used to clarify certain concepts:
504
551
 
505
552
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
506
553
 
507
-
508
-
509
554
  ### 💯 Core concepts
510
555
 
511
556
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -567,31 +612,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
567
612
 
568
613
 
569
614
 
615
+ ## � Agents Server
616
+
617
+ 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.
618
+
619
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
620
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
621
+ - **API** for integrating agents into your own applications
622
+
570
623
  ## 🚂 Promptbook Engine
571
624
 
625
+ 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.
626
+
572
627
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
573
628
 
574
629
  ## ➕➖ When to use Promptbook?
575
630
 
576
631
  ### ➕ When to use
577
632
 
578
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
579
- - When you want to **separate code from text prompts**
580
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
581
- - When you want to **orchestrate multiple prompts** together
582
- - When you want to **reuse** parts of prompts in multiple places
583
- - When you want to **version** your prompts and **test multiple versions**
584
- - When you want to **log** the execution of prompts and backtrace the issues
633
+ - When you want to **deploy persistent AI agents** that work on goals for your company
634
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
635
+ - When you want agents that **collaborate in teams** and consult each other
636
+ - When you need to **integrate AI agents into your existing applications** via API
637
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
638
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
639
+ - When you want to **version** your agent definitions and **test multiple versions**
640
+ - When you want to **log** agent execution and backtrace issues
585
641
 
586
642
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
587
643
 
588
644
  ### ➖ When not to use
589
645
 
590
- - When you have already implemented single simple prompt and it works fine for your job
646
+ - When a single simple prompt already works fine for your job
591
647
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
592
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
648
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
593
649
  - 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))_
594
- - 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))_
650
+ - 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))_
595
651
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
596
652
 
597
653
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -40,7 +40,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
40
40
  * @generated
41
41
  * @see https://github.com/webgptorg/promptbook
42
42
  */
43
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-15';
43
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
44
44
  /**
45
45
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
46
46
  * 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-14`).
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/components",
3
- "version": "0.112.0-15",
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,
package/umd/index.umd.js CHANGED
@@ -30,7 +30,7 @@
30
30
  * @generated
31
31
  * @see https://github.com/webgptorg/promptbook
32
32
  */
33
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-15';
33
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
34
34
  /**
35
35
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
36
36
  * 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-14`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */