@promptbook/types 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
 
@@ -304,11 +304,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
304
304
 
305
305
  ## 📖 The Book Whitepaper
306
306
 
307
+ 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.
308
+
307
309
  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.
308
310
 
309
311
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
310
312
 
311
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
313
+ 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.
312
314
 
313
315
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
314
316
 
@@ -316,8 +318,13 @@ In Promptbook, you can define your context **using simple Books** that are very
316
318
  <br/>
317
319
  **PERSONA** You are a company lawyer.<br/>
318
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 and keep the company website updated with the latest legal policies.<br/>
319
322
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
320
- 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/>
323
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
324
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
325
+ **USE EMAIL**<br/>
326
+ **USE BROWSER**<br/>
327
+ **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/>
321
328
 
322
329
  </td></tr></table>
323
330
 
@@ -340,6 +347,22 @@ Personas define the character of your AI persona, its role, and how it should in
340
347
  **<ins>Paul Smith & Associés</ins>**<br/>
341
348
  <br/>
342
349
  **PERSONA** You are a company lawyer.<br/>
350
+ Your job is to provide legal advice and support to the company and its employees.<br/>
351
+
352
+ </td></tr></table>
353
+
354
+ #### `Goal` commitment
355
+
356
+ 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.
357
+
358
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
359
+
360
+ **<ins>Paul Smith & Associés</ins>**<br/>
361
+ <br/>
362
+ **PERSONA** You are a company lawyer.<br/>
363
+ Your job is to provide legal advice and support to the company and its employees.<br/>
364
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
365
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
343
366
 
344
367
  </td></tr></table>
345
368
 
@@ -357,9 +380,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
357
380
  <br/>
358
381
  **PERSONA** You are a company lawyer.<br/>
359
382
  Your job is to provide legal advice and support to the company and its employees.<br/>
360
- You are knowledgeable, professional, and detail-oriented.<br/>
361
- <br/>
362
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
383
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
384
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
385
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
363
386
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
364
387
 
365
388
  </td></tr></table>
@@ -376,13 +399,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
376
399
  <br/>
377
400
  **PERSONA** You are a company lawyer.<br/>
378
401
  Your job is to provide legal advice and support to the company and its employees.<br/>
379
- You are knowledgeable, professional, and detail-oriented.<br/>
402
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
403
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
404
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
405
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
406
+ **RULE** Never provide legal advice about criminal law.<br/>
407
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
408
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
409
+
410
+ </td></tr></table>
411
+
412
+ #### `Use` commitments
413
+
414
+ 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.
415
+
416
+ These are what turn a chatbot into a persistent agent that actually does work.
417
+
418
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
419
+
420
+ **<ins>Paul Smith & Associés</ins>**<br/>
380
421
  <br/>
381
- **RULE** Always ensure compliance with laws and regulations.<br/>
422
+ **PERSONA** You are a company lawyer.<br/>
423
+ Your job is to provide legal advice and support to the company and its employees.<br/>
424
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
425
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
426
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
382
427
  **RULE** Never provide legal advice outside your area of expertise.<br/>
383
428
  **RULE** Never provide legal advice about criminal law.<br/>
384
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
429
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
385
430
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
431
+ **USE EMAIL**<br/>
432
+ **USE BROWSER**<br/>
433
+ **USE SEARCH ENGINE**<br/>
386
434
 
387
435
  </td></tr></table>
388
436
 
@@ -396,32 +444,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
396
444
  <br/>
397
445
  **PERSONA** You are a company lawyer.<br/>
398
446
  Your job is to provide legal advice and support to the company and its employees.<br/>
399
- You are knowledgeable, professional, and detail-oriented.<br/>
400
- <br/>
401
- **RULE** Always ensure compliance with laws and regulations.<br/>
447
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
448
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
449
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
402
450
  **RULE** Never provide legal advice outside your area of expertise.<br/>
403
451
  **RULE** Never provide legal advice about criminal law.<br/>
404
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
452
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
405
453
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
406
- 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/>
454
+ **USE EMAIL**<br/>
455
+ **USE BROWSER**<br/>
456
+ **USE SEARCH ENGINE**<br/>
457
+ **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/>
407
458
 
408
459
  </td></tr></table>
409
460
 
410
-
411
-
412
461
  ### Promptbook Ecosystem
413
462
 
414
- !!!@@@
463
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
415
464
 
416
- #### Promptbook Server
465
+ #### Agents Server
417
466
 
418
- !!!@@@
467
+ 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.
419
468
 
420
469
  #### Promptbook Engine
421
470
 
422
- !!!@@@
423
-
424
-
471
+ 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).
425
472
 
426
473
 
427
474
 
@@ -435,7 +482,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
435
482
 
436
483
  ## 💜 The Promptbook Project
437
484
 
438
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
485
+ 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:
439
486
 
440
487
  <table>
441
488
  <thead>
@@ -446,9 +493,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
446
493
  </thead>
447
494
  <tbody>
448
495
  <tr>
449
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
496
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
450
497
  <td>
451
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
498
+ 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>.
452
499
  </td>
453
500
  </tr>
454
501
  <tr>
@@ -462,17 +509,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
462
509
  <tr>
463
510
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
464
511
  <td>
465
- Promptbook engine can run AI agents based on Book language.
466
- 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>
467
- Agent Server is based on Promptbook Engine.
512
+ 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.
513
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
468
514
  </td>
469
515
  </tr>
470
516
 
471
517
  </tbody>
472
518
  </table>
473
519
 
474
-
475
-
476
520
  ### 🌐 Community & Social Media
477
521
 
478
522
  Join our growing community of developers and users:
@@ -529,8 +573,6 @@ Join our growing community of developers and users:
529
573
 
530
574
 
531
575
 
532
-
533
-
534
576
  ## 📚 Documentation
535
577
 
536
578
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -539,9 +581,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
539
581
 
540
582
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
541
583
 
542
- ## 📦 Packages _(for developers)_
584
+ ## 📦 Deployment & Packages
585
+
586
+ The fastest way to get started is with the **Agents Server**:
543
587
 
544
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
588
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
589
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
590
+
591
+ ### NPM Packages _(for developers embedding the Engine)_
592
+
593
+ 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).
545
594
  You can install all of them at once:
546
595
 
547
596
  ```bash
@@ -560,7 +609,6 @@ Or you can install them separately:
560
609
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
561
610
  - ⭐ **[@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
562
611
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
563
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
564
612
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
565
613
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
566
614
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -582,8 +630,7 @@ Or you can install them separately:
582
630
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
583
631
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
584
632
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
585
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
586
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
633
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
587
634
 
588
635
 
589
636
 
@@ -607,8 +654,6 @@ The following glossary is used to clarify certain concepts:
607
654
 
608
655
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
609
656
 
610
-
611
-
612
657
  ### 💯 Core concepts
613
658
 
614
659
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -670,31 +715,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
670
715
 
671
716
 
672
717
 
718
+ ## � Agents Server
719
+
720
+ 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.
721
+
722
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
723
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
724
+ - **API** for integrating agents into your own applications
725
+
673
726
  ## 🚂 Promptbook Engine
674
727
 
728
+ 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.
729
+
675
730
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
676
731
 
677
732
  ## ➕➖ When to use Promptbook?
678
733
 
679
734
  ### ➕ When to use
680
735
 
681
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
682
- - When you want to **separate code from text prompts**
683
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
684
- - When you want to **orchestrate multiple prompts** together
685
- - When you want to **reuse** parts of prompts in multiple places
686
- - When you want to **version** your prompts and **test multiple versions**
687
- - When you want to **log** the execution of prompts and backtrace the issues
736
+ - When you want to **deploy persistent AI agents** that work on goals for your company
737
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
738
+ - When you want agents that **collaborate in teams** and consult each other
739
+ - When you need to **integrate AI agents into your existing applications** via API
740
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
741
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
742
+ - When you want to **version** your agent definitions and **test multiple versions**
743
+ - When you want to **log** agent execution and backtrace issues
688
744
 
689
745
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
690
746
 
691
747
  ### ➖ When not to use
692
748
 
693
- - When you have already implemented single simple prompt and it works fine for your job
749
+ - When a single simple prompt already works fine for your job
694
750
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
695
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
751
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
696
752
  - 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))_
697
- - 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))_
753
+ - 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))_
698
754
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
699
755
 
700
756
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
@@ -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/types",
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,
@@ -95,6 +95,6 @@
95
95
  },
96
96
  "typings": "./esm/typings/src/_packages/types.index.d.ts",
97
97
  "peerDependencies": {
98
- "@promptbook/core": "0.112.0-15"
98
+ "@promptbook/core": "0.112.0-17"
99
99
  }
100
100
  }
@@ -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
  */