@promptbook/openai 0.112.0 → 0.113.0-1

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.
Files changed (34) hide show
  1. package/README.md +45 -29
  2. package/esm/index.es.js +1 -1
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/src/_packages/core.index.d.ts +22 -0
  5. package/esm/src/_packages/types.index.d.ts +2 -0
  6. package/esm/src/book-2.0/agent-source/AgentBasicInformation.d.ts +2 -0
  7. package/esm/src/book-2.0/agent-source/agentSourceVisibility.d.ts +97 -0
  8. package/esm/src/book-2.0/agent-source/agentSourceVisibility.test.d.ts +1 -0
  9. package/esm/src/book-components/BookEditor/BookEditorMonacoTokenization.d.ts +1 -0
  10. package/esm/src/book-components/Chat/Chat/CitationIframePreview.d.ts +2 -2
  11. package/esm/src/book-components/Chat/utils/livePagePreviewConstants.d.ts +12 -0
  12. package/esm/src/cli/cli-commands/agents-server/buildAgentsServer.d.ts +6 -0
  13. package/esm/src/collection/agent-collection/CreateAgentInput.d.ts +2 -1
  14. package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/prepareAgentSourceForPersistence.d.ts +21 -1
  15. package/esm/src/commitments/META_VISIBILITY/META_VISIBILITY.d.ts +27 -0
  16. package/esm/src/commitments/index.d.ts +2 -1
  17. package/esm/src/version.d.ts +1 -1
  18. package/package.json +2 -2
  19. package/umd/index.umd.js +1 -1
  20. package/umd/index.umd.js.map +1 -1
  21. package/umd/src/_packages/core.index.d.ts +22 -0
  22. package/umd/src/_packages/types.index.d.ts +2 -0
  23. package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +2 -0
  24. package/umd/src/book-2.0/agent-source/agentSourceVisibility.d.ts +97 -0
  25. package/umd/src/book-2.0/agent-source/agentSourceVisibility.test.d.ts +1 -0
  26. package/umd/src/book-components/BookEditor/BookEditorMonacoTokenization.d.ts +1 -0
  27. package/umd/src/book-components/Chat/Chat/CitationIframePreview.d.ts +2 -2
  28. package/umd/src/book-components/Chat/utils/livePagePreviewConstants.d.ts +12 -0
  29. package/umd/src/cli/cli-commands/agents-server/buildAgentsServer.d.ts +6 -0
  30. package/umd/src/collection/agent-collection/CreateAgentInput.d.ts +2 -1
  31. package/umd/src/collection/agent-collection/constructors/agent-collection-in-supabase/prepareAgentSourceForPersistence.d.ts +21 -1
  32. package/umd/src/commitments/META_VISIBILITY/META_VISIBILITY.d.ts +27 -0
  33. package/umd/src/commitments/index.d.ts +2 -1
  34. package/umd/src/version.d.ts +1 -1
package/README.md CHANGED
@@ -41,14 +41,17 @@ Non-interactive mode takes defaults from command-line options. When `--openai-ap
41
41
  sudo curl -fsSL https://raw.githubusercontent.com/webgptorg/promptbook/refs/heads/main/other/vps/install.sh | bash -s -- \
42
42
  --non-interactive \
43
43
  --yes-i-understand-that-script-should-be-run-on-fresh-server \
44
- --domain s24.ptbk.io \
45
- --openai-api-key sk-proj-abcdef \
46
- --sentry-dsn https://abc@def.ingest.de.sentry.io/123 \
44
+ --domain my-server.com \
45
+ --openai-api-key sk-proj-xxx \
47
46
  --admin-password xxx
48
47
  ```
49
48
 
50
49
 
51
50
 
51
+ <blockquote style="color: #ff8811">
52
+ <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
53
+ </blockquote>
54
+
52
55
  ## 📦 Package `@promptbook/openai`
53
56
 
54
57
  - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -394,7 +397,7 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
394
397
 
395
398
  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.
396
399
 
397
- 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.
400
+ Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as Claude Mythos, GPT-5.6 or Kimi K2.7 are incredibly capable.
398
401
 
399
402
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
400
403
 
@@ -402,17 +405,20 @@ In Promptbook, you define your agents **using simple Books** - a human-readable
402
405
 
403
406
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
404
407
 
405
- **<ins>Paul Smith</ins>**<br/>
408
+ **<ins>Lawyer</ins>**<br/>
406
409
  <br/>
407
- **PERSONA** You are a company lawyer.<br/>
410
+ GOAL You are a company lawyer.<br/>
408
411
  Your job is to provide legal advice and support to the company and its employees.<br/>
409
- **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
412
+ Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
413
+ <br/>
410
414
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
411
415
  **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
412
416
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
413
- **USE EMAIL**<br/>
414
- **USE BROWSER**<br/>
415
- **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/>
417
+ <br/>
418
+ USE EMAIL<br/>
419
+ USE BROWSER<br/>
420
+ <br/>
421
+ 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/>
416
422
 
417
423
  </td></tr></table>
418
424
 
@@ -445,12 +451,12 @@ Goals define what the agent should actively work toward. Unlike a chatbot that o
445
451
 
446
452
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
447
453
 
448
- **<ins>Paul Smith & Associés</ins>**<br/>
454
+ **<ins>Company Lawyer</ins>**<br/>
449
455
  <br/>
450
- **PERSONA** You are a company lawyer.<br/>
456
+ GOAL<br/>
451
457
  Your job is to provide legal advice and support to the company and its employees.<br/>
452
- **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
453
- **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
458
+ GOAL Respond to incoming legal inquiries via email within 24 hours.<br/>
459
+ GOAL Keep the company website updated with the latest legal policies and compliance information.<br/>
454
460
 
455
461
  </td></tr></table>
456
462
 
@@ -468,8 +474,8 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
468
474
  <br/>
469
475
  **PERSONA** You are a company lawyer.<br/>
470
476
  Your job is to provide legal advice and support to the company and its employees.<br/>
471
- **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
472
- **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
477
+ GOAL Respond to incoming legal inquiries via email within 24 hours.<br/>
478
+ GOAL Keep the company website updated with the latest legal policies and compliance information.<br/>
473
479
  **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
474
480
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
475
481
 
@@ -487,8 +493,8 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
487
493
  <br/>
488
494
  **PERSONA** You are a company lawyer.<br/>
489
495
  Your job is to provide legal advice and support to the company and its employees.<br/>
490
- **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
491
- **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
496
+ GOAL Respond to incoming legal inquiries via email within 24 hours.<br/>
497
+ GOAL Keep the company website updated with the latest legal policies and compliance information.<br/>
492
498
  **RULE** Always ensure compliance with local laws and regulations.<br/>
493
499
  **RULE** Never provide legal advice outside your area of expertise.<br/>
494
500
  **RULE** Never provide legal advice about criminal law.<br/>
@@ -509,16 +515,16 @@ These are what turn a chatbot into a persistent agent that actually does work.
509
515
  <br/>
510
516
  **PERSONA** You are a company lawyer.<br/>
511
517
  Your job is to provide legal advice and support to the company and its employees.<br/>
512
- **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
513
- **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
518
+ GOAL Respond to incoming legal inquiries via email within 24 hours.<br/>
519
+ GOAL Keep the company website updated with the latest legal policies and compliance information.<br/>
514
520
  **RULE** Always ensure compliance with local laws and regulations.<br/>
515
521
  **RULE** Never provide legal advice outside your area of expertise.<br/>
516
522
  **RULE** Never provide legal advice about criminal law.<br/>
517
523
  **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
518
524
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
519
- **USE EMAIL**<br/>
520
- **USE BROWSER**<br/>
521
- **USE SEARCH ENGINE**<br/>
525
+ USE EMAIL<br/>
526
+ USE BROWSER<br/>
527
+ USE SEARCH ENGINE<br/>
522
528
 
523
529
  </td></tr></table>
524
530
 
@@ -532,20 +538,22 @@ Team commitment allows you to define the team structure and advisory fellow memb
532
538
  <br/>
533
539
  **PERSONA** You are a company lawyer.<br/>
534
540
  Your job is to provide legal advice and support to the company and its employees.<br/>
535
- **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
536
- **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
541
+ GOAL Respond to incoming legal inquiries via email within 24 hours.<br/>
542
+ GOAL Keep the company website updated with the latest legal policies and compliance information.<br/>
537
543
  **RULE** Always ensure compliance with local laws and regulations.<br/>
538
544
  **RULE** Never provide legal advice outside your area of expertise.<br/>
539
545
  **RULE** Never provide legal advice about criminal law.<br/>
540
546
  **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
541
547
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
542
- **USE EMAIL**<br/>
543
- **USE BROWSER**<br/>
544
- **USE SEARCH ENGINE**<br/>
545
- **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/>
548
+ USE EMAIL<br/>
549
+ USE BROWSER<br/>
550
+ USE SEARCH ENGINE<br/>
551
+ 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/>
546
552
 
547
553
  </td></tr></table>
548
554
 
555
+
556
+
549
557
  ### Promptbook Ecosystem
550
558
 
551
559
  Promptbook is an ecosystem of tools centered around the **Agents Server** - a production-ready platform for running persistent AI agents.
@@ -568,6 +576,8 @@ The [Promptbook Engine](https://github.com/webgptorg/promptbook) is the open-sou
568
576
 
569
577
 
570
578
 
579
+
580
+
571
581
  ## 💜 The Promptbook Project
572
582
 
573
583
  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:
@@ -605,6 +615,8 @@ Promptbook project is an ecosystem centered around the **Agents Server** - a pla
605
615
  </tbody>
606
616
  </table>
607
617
 
618
+
619
+
608
620
  ### 🌐 Community & Social Media
609
621
 
610
622
  Join our growing community of developers and users:
@@ -661,6 +673,8 @@ Join our growing community of developers and users:
661
673
 
662
674
 
663
675
 
676
+
677
+
664
678
  ## 📚 Documentation
665
679
 
666
680
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -868,6 +882,8 @@ The following glossary is used to clarify certain concepts:
868
882
 
869
883
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
870
884
 
885
+
886
+
871
887
  ### 💯 Core concepts
872
888
 
873
889
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
package/esm/index.es.js CHANGED
@@ -20,7 +20,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
20
20
  * @generated
21
21
  * @see https://github.com/webgptorg/promptbook
22
22
  */
23
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0';
23
+ const PROMPTBOOK_ENGINE_VERSION = '0.113.0-1';
24
24
  /**
25
25
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
26
26
  * Note: [💞] Ignore a discrepancy between file name and entity name