@promptbook/google 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
 
@@ -251,11 +251,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
251
251
 
252
252
  ## 📖 The Book Whitepaper
253
253
 
254
+ 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.
255
+
254
256
  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.
255
257
 
256
258
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
257
259
 
258
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
260
+ 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.
259
261
 
260
262
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
261
263
 
@@ -263,8 +265,13 @@ In Promptbook, you can define your context **using simple Books** that are very
263
265
  <br/>
264
266
  **PERSONA** You are a company lawyer.<br/>
265
267
  Your job is to provide legal advice and support to the company and its employees.<br/>
268
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
266
269
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
267
- 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/>
270
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
271
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
272
+ **USE EMAIL**<br/>
273
+ **USE BROWSER**<br/>
274
+ **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/>
268
275
 
269
276
  </td></tr></table>
270
277
 
@@ -287,6 +294,22 @@ Personas define the character of your AI persona, its role, and how it should in
287
294
  **<ins>Paul Smith & Associés</ins>**<br/>
288
295
  <br/>
289
296
  **PERSONA** You are a company lawyer.<br/>
297
+ Your job is to provide legal advice and support to the company and its employees.<br/>
298
+
299
+ </td></tr></table>
300
+
301
+ #### `Goal` commitment
302
+
303
+ 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.
304
+
305
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
306
+
307
+ **<ins>Paul Smith & Associés</ins>**<br/>
308
+ <br/>
309
+ **PERSONA** You are a company lawyer.<br/>
310
+ Your job is to provide legal advice and support to the company and its employees.<br/>
311
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
312
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
290
313
 
291
314
  </td></tr></table>
292
315
 
@@ -304,9 +327,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
304
327
  <br/>
305
328
  **PERSONA** You are a company lawyer.<br/>
306
329
  Your job is to provide legal advice and support to the company and its employees.<br/>
307
- You are knowledgeable, professional, and detail-oriented.<br/>
308
- <br/>
309
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
330
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
331
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
332
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
310
333
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
311
334
 
312
335
  </td></tr></table>
@@ -323,13 +346,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
323
346
  <br/>
324
347
  **PERSONA** You are a company lawyer.<br/>
325
348
  Your job is to provide legal advice and support to the company and its employees.<br/>
326
- You are knowledgeable, professional, and detail-oriented.<br/>
349
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
350
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
351
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
352
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
353
+ **RULE** Never provide legal advice about criminal law.<br/>
354
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
355
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
356
+
357
+ </td></tr></table>
358
+
359
+ #### `Use` commitments
360
+
361
+ 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.
362
+
363
+ These are what turn a chatbot into a persistent agent that actually does work.
364
+
365
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
366
+
367
+ **<ins>Paul Smith & Associés</ins>**<br/>
327
368
  <br/>
328
- **RULE** Always ensure compliance with laws and regulations.<br/>
369
+ **PERSONA** You are a company lawyer.<br/>
370
+ Your job is to provide legal advice and support to the company and its employees.<br/>
371
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
372
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
373
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
329
374
  **RULE** Never provide legal advice outside your area of expertise.<br/>
330
375
  **RULE** Never provide legal advice about criminal law.<br/>
331
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
376
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
332
377
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
378
+ **USE EMAIL**<br/>
379
+ **USE BROWSER**<br/>
380
+ **USE SEARCH ENGINE**<br/>
333
381
 
334
382
  </td></tr></table>
335
383
 
@@ -343,32 +391,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
343
391
  <br/>
344
392
  **PERSONA** You are a company lawyer.<br/>
345
393
  Your job is to provide legal advice and support to the company and its employees.<br/>
346
- You are knowledgeable, professional, and detail-oriented.<br/>
347
- <br/>
348
- **RULE** Always ensure compliance with laws and regulations.<br/>
394
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
395
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
396
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
349
397
  **RULE** Never provide legal advice outside your area of expertise.<br/>
350
398
  **RULE** Never provide legal advice about criminal law.<br/>
351
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
399
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
352
400
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
353
- 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/>
401
+ **USE EMAIL**<br/>
402
+ **USE BROWSER**<br/>
403
+ **USE SEARCH ENGINE**<br/>
404
+ **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/>
354
405
 
355
406
  </td></tr></table>
356
407
 
357
-
358
-
359
408
  ### Promptbook Ecosystem
360
409
 
361
- !!!@@@
410
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
362
411
 
363
- #### Promptbook Server
412
+ #### Agents Server
364
413
 
365
- !!!@@@
414
+ 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.
366
415
 
367
416
  #### Promptbook Engine
368
417
 
369
- !!!@@@
370
-
371
-
418
+ 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).
372
419
 
373
420
 
374
421
 
@@ -382,7 +429,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
382
429
 
383
430
  ## 💜 The Promptbook Project
384
431
 
385
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
432
+ 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:
386
433
 
387
434
  <table>
388
435
  <thead>
@@ -393,9 +440,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
393
440
  </thead>
394
441
  <tbody>
395
442
  <tr>
396
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
443
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
397
444
  <td>
398
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
445
+ 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>.
399
446
  </td>
400
447
  </tr>
401
448
  <tr>
@@ -409,17 +456,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
409
456
  <tr>
410
457
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
411
458
  <td>
412
- Promptbook engine can run AI agents based on Book language.
413
- 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>
414
- Agent Server is based on Promptbook Engine.
459
+ 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.
460
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
415
461
  </td>
416
462
  </tr>
417
463
 
418
464
  </tbody>
419
465
  </table>
420
466
 
421
-
422
-
423
467
  ### 🌐 Community & Social Media
424
468
 
425
469
  Join our growing community of developers and users:
@@ -476,8 +520,6 @@ Join our growing community of developers and users:
476
520
 
477
521
 
478
522
 
479
-
480
-
481
523
  ## 📚 Documentation
482
524
 
483
525
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -486,9 +528,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
486
528
 
487
529
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
488
530
 
489
- ## 📦 Packages _(for developers)_
531
+ ## 📦 Deployment & Packages
532
+
533
+ The fastest way to get started is with the **Agents Server**:
490
534
 
491
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
535
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
536
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
537
+
538
+ ### NPM Packages _(for developers embedding the Engine)_
539
+
540
+ 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).
492
541
  You can install all of them at once:
493
542
 
494
543
  ```bash
@@ -507,7 +556,6 @@ Or you can install them separately:
507
556
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
508
557
  - ⭐ **[@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
509
558
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
510
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
511
559
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
512
560
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
513
561
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -529,8 +577,7 @@ Or you can install them separately:
529
577
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
530
578
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
531
579
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
532
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
533
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
580
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
534
581
 
535
582
 
536
583
 
@@ -554,8 +601,6 @@ The following glossary is used to clarify certain concepts:
554
601
 
555
602
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
556
603
 
557
-
558
-
559
604
  ### 💯 Core concepts
560
605
 
561
606
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -617,31 +662,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
617
662
 
618
663
 
619
664
 
665
+ ## � Agents Server
666
+
667
+ 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.
668
+
669
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
670
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
671
+ - **API** for integrating agents into your own applications
672
+
620
673
  ## 🚂 Promptbook Engine
621
674
 
675
+ 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.
676
+
622
677
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
623
678
 
624
679
  ## ➕➖ When to use Promptbook?
625
680
 
626
681
  ### ➕ When to use
627
682
 
628
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
629
- - When you want to **separate code from text prompts**
630
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
631
- - When you want to **orchestrate multiple prompts** together
632
- - When you want to **reuse** parts of prompts in multiple places
633
- - When you want to **version** your prompts and **test multiple versions**
634
- - When you want to **log** the execution of prompts and backtrace the issues
683
+ - When you want to **deploy persistent AI agents** that work on goals for your company
684
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
685
+ - When you want agents that **collaborate in teams** and consult each other
686
+ - When you need to **integrate AI agents into your existing applications** via API
687
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
688
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
689
+ - When you want to **version** your agent definitions and **test multiple versions**
690
+ - When you want to **log** agent execution and backtrace issues
635
691
 
636
692
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
637
693
 
638
694
  ### ➖ When not to use
639
695
 
640
- - When you have already implemented single simple prompt and it works fine for your job
696
+ - When a single simple prompt already works fine for your job
641
697
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
642
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
698
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
643
699
  - 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))_
644
- - 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))_
700
+ - 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))_
645
701
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
646
702
 
647
703
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
16
16
  * @generated
17
17
  * @see https://github.com/webgptorg/promptbook
18
18
  */
19
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
19
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
20
20
  /**
21
21
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
22
22
  * 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/google",
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,
@@ -98,7 +98,7 @@
98
98
  "module": "./esm/index.es.js",
99
99
  "typings": "./esm/typings/src/_packages/google.index.d.ts",
100
100
  "peerDependencies": {
101
- "@promptbook/core": "0.112.0-16"
101
+ "@promptbook/core": "0.112.0-17"
102
102
  },
103
103
  "dependencies": {
104
104
  "@ai-sdk/google": "1.0.17",
package/umd/index.umd.js CHANGED
@@ -22,7 +22,7 @@
22
22
  * @generated
23
23
  * @see https://github.com/webgptorg/promptbook
24
24
  */
25
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
25
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
26
26
  /**
27
27
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
28
28
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.112.0-15`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */