@promptbook/core 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
 
@@ -322,11 +322,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
322
322
 
323
323
  ## 📖 The Book Whitepaper
324
324
 
325
+ 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.
326
+
325
327
  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.
326
328
 
327
329
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
328
330
 
329
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
331
+ 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.
330
332
 
331
333
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
332
334
 
@@ -334,8 +336,13 @@ In Promptbook, you can define your context **using simple Books** that are very
334
336
  <br/>
335
337
  **PERSONA** You are a company lawyer.<br/>
336
338
  Your job is to provide legal advice and support to the company and its employees.<br/>
339
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
337
340
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
338
- 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/>
341
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
342
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
343
+ **USE EMAIL**<br/>
344
+ **USE BROWSER**<br/>
345
+ **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/>
339
346
 
340
347
  </td></tr></table>
341
348
 
@@ -358,6 +365,22 @@ Personas define the character of your AI persona, its role, and how it should in
358
365
  **<ins>Paul Smith & Associés</ins>**<br/>
359
366
  <br/>
360
367
  **PERSONA** You are a company lawyer.<br/>
368
+ Your job is to provide legal advice and support to the company and its employees.<br/>
369
+
370
+ </td></tr></table>
371
+
372
+ #### `Goal` commitment
373
+
374
+ 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.
375
+
376
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
377
+
378
+ **<ins>Paul Smith & Associés</ins>**<br/>
379
+ <br/>
380
+ **PERSONA** You are a company lawyer.<br/>
381
+ Your job is to provide legal advice and support to the company and its employees.<br/>
382
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
383
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
361
384
 
362
385
  </td></tr></table>
363
386
 
@@ -375,9 +398,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
375
398
  <br/>
376
399
  **PERSONA** You are a company lawyer.<br/>
377
400
  Your job is to provide legal advice and support to the company and its employees.<br/>
378
- You are knowledgeable, professional, and detail-oriented.<br/>
379
- <br/>
380
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
401
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
402
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
403
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
381
404
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
382
405
 
383
406
  </td></tr></table>
@@ -394,13 +417,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
394
417
  <br/>
395
418
  **PERSONA** You are a company lawyer.<br/>
396
419
  Your job is to provide legal advice and support to the company and its employees.<br/>
397
- You are knowledgeable, professional, and detail-oriented.<br/>
420
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
421
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
422
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
423
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
424
+ **RULE** Never provide legal advice about criminal law.<br/>
425
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
426
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
427
+
428
+ </td></tr></table>
429
+
430
+ #### `Use` commitments
431
+
432
+ 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.
433
+
434
+ These are what turn a chatbot into a persistent agent that actually does work.
435
+
436
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
437
+
438
+ **<ins>Paul Smith & Associés</ins>**<br/>
398
439
  <br/>
399
- **RULE** Always ensure compliance with laws and regulations.<br/>
440
+ **PERSONA** You are a company lawyer.<br/>
441
+ Your job is to provide legal advice and support to the company and its employees.<br/>
442
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
443
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
444
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
400
445
  **RULE** Never provide legal advice outside your area of expertise.<br/>
401
446
  **RULE** Never provide legal advice about criminal law.<br/>
402
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
447
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
403
448
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
449
+ **USE EMAIL**<br/>
450
+ **USE BROWSER**<br/>
451
+ **USE SEARCH ENGINE**<br/>
404
452
 
405
453
  </td></tr></table>
406
454
 
@@ -414,32 +462,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
414
462
  <br/>
415
463
  **PERSONA** You are a company lawyer.<br/>
416
464
  Your job is to provide legal advice and support to the company and its employees.<br/>
417
- You are knowledgeable, professional, and detail-oriented.<br/>
418
- <br/>
419
- **RULE** Always ensure compliance with laws and regulations.<br/>
465
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
466
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
467
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
420
468
  **RULE** Never provide legal advice outside your area of expertise.<br/>
421
469
  **RULE** Never provide legal advice about criminal law.<br/>
422
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
470
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
423
471
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
424
- 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/>
472
+ **USE EMAIL**<br/>
473
+ **USE BROWSER**<br/>
474
+ **USE SEARCH ENGINE**<br/>
475
+ **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/>
425
476
 
426
477
  </td></tr></table>
427
478
 
428
-
429
-
430
479
  ### Promptbook Ecosystem
431
480
 
432
- !!!@@@
481
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
433
482
 
434
- #### Promptbook Server
483
+ #### Agents Server
435
484
 
436
- !!!@@@
485
+ 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.
437
486
 
438
487
  #### Promptbook Engine
439
488
 
440
- !!!@@@
441
-
442
-
489
+ 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).
443
490
 
444
491
 
445
492
 
@@ -453,7 +500,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
453
500
 
454
501
  ## 💜 The Promptbook Project
455
502
 
456
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
503
+ 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:
457
504
 
458
505
  <table>
459
506
  <thead>
@@ -464,9 +511,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
464
511
  </thead>
465
512
  <tbody>
466
513
  <tr>
467
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
514
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
468
515
  <td>
469
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
516
+ 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>.
470
517
  </td>
471
518
  </tr>
472
519
  <tr>
@@ -480,17 +527,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
480
527
  <tr>
481
528
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
482
529
  <td>
483
- Promptbook engine can run AI agents based on Book language.
484
- 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>
485
- Agent Server is based on Promptbook Engine.
530
+ 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.
531
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
486
532
  </td>
487
533
  </tr>
488
534
 
489
535
  </tbody>
490
536
  </table>
491
537
 
492
-
493
-
494
538
  ### 🌐 Community & Social Media
495
539
 
496
540
  Join our growing community of developers and users:
@@ -547,8 +591,6 @@ Join our growing community of developers and users:
547
591
 
548
592
 
549
593
 
550
-
551
-
552
594
  ## 📚 Documentation
553
595
 
554
596
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -557,9 +599,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
557
599
 
558
600
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
559
601
 
560
- ## 📦 Packages _(for developers)_
602
+ ## 📦 Deployment & Packages
603
+
604
+ The fastest way to get started is with the **Agents Server**:
561
605
 
562
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
606
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
607
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
608
+
609
+ ### NPM Packages _(for developers embedding the Engine)_
610
+
611
+ 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).
563
612
  You can install all of them at once:
564
613
 
565
614
  ```bash
@@ -578,7 +627,6 @@ Or you can install them separately:
578
627
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
579
628
  - ⭐ **[@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
580
629
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
581
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
582
630
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
583
631
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
584
632
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -600,8 +648,7 @@ Or you can install them separately:
600
648
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
601
649
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
602
650
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
603
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
604
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
651
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
605
652
 
606
653
 
607
654
 
@@ -625,8 +672,6 @@ The following glossary is used to clarify certain concepts:
625
672
 
626
673
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
627
674
 
628
-
629
-
630
675
  ### 💯 Core concepts
631
676
 
632
677
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -688,31 +733,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
688
733
 
689
734
 
690
735
 
736
+ ## � Agents Server
737
+
738
+ 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.
739
+
740
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
741
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
742
+ - **API** for integrating agents into your own applications
743
+
691
744
  ## 🚂 Promptbook Engine
692
745
 
746
+ 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.
747
+
693
748
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
694
749
 
695
750
  ## ➕➖ When to use Promptbook?
696
751
 
697
752
  ### ➕ When to use
698
753
 
699
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
700
- - When you want to **separate code from text prompts**
701
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
702
- - When you want to **orchestrate multiple prompts** together
703
- - When you want to **reuse** parts of prompts in multiple places
704
- - When you want to **version** your prompts and **test multiple versions**
705
- - When you want to **log** the execution of prompts and backtrace the issues
754
+ - When you want to **deploy persistent AI agents** that work on goals for your company
755
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
756
+ - When you want agents that **collaborate in teams** and consult each other
757
+ - When you need to **integrate AI agents into your existing applications** via API
758
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
759
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
760
+ - When you want to **version** your agent definitions and **test multiple versions**
761
+ - When you want to **log** agent execution and backtrace issues
706
762
 
707
763
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
708
764
 
709
765
  ### ➖ When not to use
710
766
 
711
- - When you have already implemented single simple prompt and it works fine for your job
767
+ - When a single simple prompt already works fine for your job
712
768
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
713
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
769
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
714
770
  - 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))_
715
- - 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))_
771
+ - 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))_
716
772
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
717
773
 
718
774
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -28,7 +28,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
28
28
  * @generated
29
29
  * @see https://github.com/webgptorg/promptbook
30
30
  */
31
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
31
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
32
32
  /**
33
33
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
34
34
  * 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/core",
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,
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-17';
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-16`).
19
19
  *
20
20
  * @generated
21
21
  */