@promptbook/utils 0.103.0-1 → 0.103.0-2

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
@@ -363,19 +363,131 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
363
363
 
364
364
 
365
365
 
366
- ## 🤍 The Book Abstract
366
+ ## 📖 The Book Whitepaper
367
367
 
368
- **It's time for a paradigm shift! The future of software is written in plain English, French, or Latin.**
368
+ For most business applications nowadays, the biggest challenge isn't about the raw capabilities of AI models. Large language models like GPT-5 or Claude-4.1 are extremely capable.
369
369
 
370
- During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
370
+ The main challenge is to narrow it down, constrain it, set the proper **context, rules, knowledge, and personality**. There are a lot of tools which can do exactly this. On one side, there are no-code platforms which can launch your agent in seconds. On the other side, there are heavy frameworks like Langchain or Semantic Kernel, which can give you deep control.
371
371
 
372
- It's a revolution of writing software in **plain human language** that is understandable and executable by both humans and machines and it's going to change everything!
372
+ Promptbook takes the best from both worlds. You are defining your AI behavior by simple **books**, which are very explicit. They are automatically enforced, but they are very easy to understand, very easy to write, and very reliable and portable.
373
373
 
374
- The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
375
374
 
376
- This shift will happen whether we're ready or not. Our mission is to make it excellent, not just good.
377
375
 
378
- **Join us in this journey!**
376
+ <img
377
+ alt="Paul Smith & Associés Book"
378
+ src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.&width=800&height=450&nonce=0"
379
+ />
380
+
381
+ <div style="page-break-after: always;"></div>
382
+
383
+ ### Aspects of great AI agent
384
+
385
+ We have created a language called **Book**, which allows you to write AI agents in their native language and create your own AI persona. Book provides a guide to define all the traits and commitments.
386
+
387
+ You can look at it as prompting (or writing a system message), but decorated by **commitments**.
388
+
389
+ #### `Persona` commitment
390
+
391
+ Personas define the character of your AI persona, its role, and how it should interact with users. It sets the tone and style of communication.
392
+
393
+
394
+
395
+ <img
396
+ alt="Paul Smith & Associés Book"
397
+ src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.&width=800&height=450&nonce=0"
398
+ />
399
+
400
+ #### `Knowledge` commitment
401
+
402
+ Knowledge Commitment allows you to provide specific information, facts, or context that the AI should be aware of when responding.
403
+
404
+ This can include domain-specific knowledge, company policies, or any other relevant information.
405
+
406
+ Promptbook Engine will automatically enforce this knowledge during interactions. When the knowledge is short enough, it will be included in the prompt. When it is too long, it will be stored in vector databases and RAG retrieved when needed. But you don't need to care about it.
407
+
408
+
409
+
410
+ <img
411
+ alt="Paul Smith & Associés Book"
412
+ src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx&width=800&height=450&nonce=0"
413
+ />
414
+
415
+ #### `Rule` commitment
416
+
417
+ Rules will enforce specific behaviors or constraints on the AI's responses. This can include ethical guidelines, communication styles, or any other rules you want the AI to follow.
418
+
419
+ Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
420
+
421
+
422
+
423
+ <img
424
+ alt="Paul Smith & Associés Book"
425
+ src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20RULE%20Always%20ensure%20compliance%20with%20laws%20and%20regulations.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20outside%20your%20area%20of%20expertise.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20about%20criminal%20law.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx&width=800&height=450&nonce=0"
426
+ />
427
+
428
+ #### `Action` commitment
429
+
430
+ Action Commitment allows you to define specific actions that the AI can take during interactions. This can include things like posting on a social media platform, sending emails, creating calendar events, or interacting with your internal systems.
431
+
432
+
433
+
434
+ <img
435
+ alt="Paul Smith & Associés Book"
436
+ src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20RULE%20Always%20ensure%20compliance%20with%20laws%20and%20regulations.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20outside%20your%20area%20of%20expertise.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20about%20criminal%20law.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx%0A%20%20%20%20%20%20%7C%20ACTION%20When%20a%20user%20asks%20about%20an%20issue%20that%20could%20be%20treated%20as%20a%20crime%2C%20notify%20legal%40company.com.&width=800&height=450&nonce=0"
437
+ />
438
+
439
+ [Read more about the language](./BLUEPRINT.md)
440
+
441
+ <div style="page-break-after: always;"></div>
442
+
443
+ ### Where to use your AI agent in book
444
+
445
+ Books can be useful in various applications and scenarios. Here are some examples:
446
+
447
+ #### Chat apps:
448
+
449
+ Create your own chat shopping assistant and place it in your eShop.
450
+ You will be able to answer customer questions, help them find products, and provide personalized recommendations. Everything is tightly controlled by the book you have written.
451
+
452
+ #### Reply Agent:
453
+
454
+ Create your own AI agent, which will look at your emails and reply to them. It can even create drafts for you to review before sending.
455
+
456
+ #### Coding Agent:
457
+
458
+ Do you love Vibecoding, but the AI code is not always aligned with your coding style and architecture, rules, security, etc.? Create your own coding agent to help enforce your specific coding standards and practices.
459
+
460
+ This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
461
+
462
+ They will work the same as you are used to, but with your specific rules written in book.
463
+
464
+ #### Internal Expertise
465
+
466
+ Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
467
+
468
+ You can avoid struggle with choosing the best model, its settings like temperature, max tokens, etc., by writing a book agent and using it as your AI expertise.
469
+
470
+ Doesn't matter if you do automations, data analysis, customer support, sentiment analysis, classification, or any other task. Your AI agent will be tailored to your specific needs and requirements.
471
+
472
+ Even works in no-code platforms!
473
+
474
+ <div style="page-break-after: always;"></div>
475
+
476
+ ### How to create your AI agent in book
477
+
478
+ Now you want to use it. There are several ways how to write your first book:
479
+
480
+ #### From scratch with help from Paul
481
+
482
+ We have written ai asistant in book who can help you with writing your first book.
483
+
484
+ #### Your AI twin
485
+
486
+ Copy your own behavior, personality, and knowledge into book and create your AI twin. It can help you with your work, personal life, or any other task.
487
+
488
+ #### AI persona workpool
489
+
490
+ Or you can pick from our library of pre-written books for various roles and tasks. You can find books for customer support, coding, marketing, sales, HR, legal, and many other roles.
379
491
 
380
492
 
381
493
 
@@ -492,78 +604,207 @@ Join our growing community of developers and users:
492
604
 
493
605
  ## 📘 Book Language Blueprint
494
606
 
495
- _A concise, Markdown-based DSL for crafting AI workflows and automations._
607
+ <blockquote style="color:#FFE600">
608
+ ⚠ This file is a work in progress and may be incomplete or inaccurate.
609
+ </blockquote>
496
610
 
497
- ### Introduction
611
+ ---
498
612
 
499
- Book is a Markdown-based language that simplifies the creation of AI applications, workflows, and automations. With human-readable commands, you can define inputs, outputs, personas, knowledge sources, and actions—without needing model-specific details.
613
+ Book is a simple format do define AI apps and agents. It is the source code the soul of AI apps and agents.. It's purpose is to avoid ambiguous UIs with multiple fields and low-level ways like programming in langchain.
500
614
 
501
- ### Example
615
+ Book is defined in file with `.book` extension
502
616
 
503
- ```book
504
- # 🌟 My First Book
617
+ ### Examples
505
618
 
506
- - BOOK VERSION 1.0.0
507
- - URL https://promptbook.studio/hello.book
508
- - INPUT PARAMETER {topic}
509
- - OUTPUT PARAMETER {article}
510
619
 
511
- # Write an Article
512
620
 
513
- - PERSONA Jane, marketing specialist with prior experience in tech and AI writing
514
- - KNOWLEDGE https://wikipedia.org/
515
- - KNOWLEDGE ./journalist-ethics.pdf
516
- - EXPECT MIN 1 Sentence
517
- - EXPECT MAX 5 Pages
621
+ <img
622
+ alt="Write an article about {topic} Book"
623
+ src="https://promptbook.studio/embed/book-preview.png?book=Write%20an%20article%20about%20%7Btopic%7D%0A%20%20%20%20%20%20%7C%20PERSONA%20Jane%2C%20marketing%20specialist%20with%20prior%20experience%20in%20tech%20and%20AI%20writing%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fwikipedia.org%2F%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20.%2Fjournalist-ethics.pdf%0A%20%20%20%20%20%20%7C%20EXPECT%201%20Sentence%20-%205%20Pages%0A%20%20%20%20%20%20%7C%20RESULT%20%7Barticle%7D&width=800&height=450&nonce=0"
624
+ />
518
625
 
519
- > Write an article about {topic}
626
+ ---
520
627
 
521
- → {article}
522
- ```
523
628
 
524
- Each part of the book defines one of three circles:
525
629
 
526
- ### **1. What:** Workflows, Tasks and Parameters
630
+ <img
631
+ alt="Make post on LinkedIn based on @Input. Book"
632
+ src="https://promptbook.studio/embed/book-preview.png?book=Make%20post%20on%20LinkedIn%20based%20on%20%40Input.%0A%20%20%20%20%20%20%7C%20PERSONA%20%40Jane%2C%20an%20experienced%20copywriter%20and%20HR%20expert%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20cetin.cz%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20linkedin.com%2Fcompany%2Fcetin%2F&width=800&height=450&nonce=0"
633
+ />
634
+
635
+ ---
636
+
637
+
638
+
639
+ <img
640
+ alt="Odpověz na Email Book"
641
+ src="https://promptbook.studio/embed/book-preview.png?book=Odpov%C4%9Bz%20na%20Email%0A%20%20%20%20%20%20%7C%20%7BEmail%20content%7D%0A%20%20%20%20%20%20%7C%20PERSONA%20%40Pavol%20-%20pavolhejny.com%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20.%2Finstructions.pdf%0A%20%20%20%20%20%20%7C%20STYLE%20Professional%20tone%20of%20voice&width=800&height=450&nonce=0"
642
+ />
643
+
644
+ ---
645
+
646
+
647
+
648
+ <img
649
+ alt="Analyzuj {Případ}. Book"
650
+ src="https://promptbook.studio/embed/book-preview.png?book=Analyzuj%20%7BP%C5%99%C3%ADpad%7D.%0A%20%20%20%20%20%20%7C%20%7BDetaily%7D%0A%20%20%20%20%20%20%7C%20PERSONA%20%40Ji%C5%99%C3%AD%2C%20pr%C3%A1vn%C3%ADk%2C%20kter%C3%BD%20nikdy%20neode%C5%A1le%20informace%20o%20klientech%20mimo%20EU%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%7B89%2F2012%20Sb.%20Ob%C4%8Dansk%C3%BD%20z%C3%A1kon%C3%ADk%7D&width=800&height=450&nonce=0"
651
+ />
652
+
653
+ iframe:
654
+
655
+ <iframe frameborder="0" style="width:100%;height:455px;" src="https://viewer.diagrams.net/?tags=%7B%7D&lightbox=1&highlight=0000ff&edit=_blank&layers=1&nav=1&title=#R%3Cmxfile%20scale%3D%221%22%20border%3D%220%22%20disableSvgWarning%3D%22true%22%20linkTarget%3D%22_blank%22%3E%3Cdiagram%20name%3D%22Page-1%22%20id%3D%22zo4WBBcyATChdUDADUly%22%3E7ZxtU%2BM2EMc%2FjWfaF2b8kMTwEkKOu%2Fa468BM77ViK4mKLLmy8nSfvitbihPiNEAaIHTfYHm1luzVT7vG%2F5l4cT9f3ChSTG5lRrkXBdnCi6%2B9KAo7YQ8OxrK0liBKastYsczaGsM9%2B0mdo7VOWUbLDUctJdes2DSmUgia6g0bUUrON91Gkm%2FOWpCxnTFoDPcp4XTL7QfL9KS2nnfXvD9TNp64mcPA9uTEOVtDOSGZnK%2BZ4oEX95WUum7liz7lJnouLvV1n3b0rm5MUaGfcoFdiRnhU%2Ftsf1KlGTwqWPtSaMIEVfZe9dIFoJyznBMBZ1fzCdP0viCp6ZrDgoNtonMOZyE07fgwKF3svMdw9eTADJU51WoJLvYCP7qw0bK8JPZ03sQ%2B7lnbZC3ukQs7ses9Xo3dhAQaNirtEbrYipAX9TjMcFUWRDSOvb%2BnZtGuMpmWPhOaKkG4b0j1R2EcdbNO6iej0cgfhufQGiaJnw7PaXIRJT2adpsBoDW2x2qaYiP0zovDuvjuYS%2FDs%2FgcjDlRYyZ8LQtjiwrd2IZSa5k35vX5goypzcG12n0%2F9rG3b2kEuPhltVkvwWE1UVB1jEjO%2BLLugmtIbkCxV95JuD0JHbdSyMedXtQ3Owd6ypqyq2pnc6nqwdR4%2BEtQO7nDr7XTkKQPYyWnIvPX%2FLUionT0rW5vRhQjcBTTnCqW1q5Cqhx2wrYXJaX2SQntPY6EVyBok63%2B1bGQJdNM7huP5vIvtu0zs5sW5mNjO8aQlNRQUntU29SvImiCwUlR2nUqFC2pmtFHUNSLfkseqPGRpYaDNAv%2FlYkHmn0RdorM2R0fsKFqRN4%2FNhe1Uxh060YUJi9AZ%2B52IRgSYBCh2gOV1wm%2BiGKqT5AYTDRHYuJsDwxgLl5WGTtRGHW3imOntTgGH7A2ht34YGgxxT0T5z8Gd%2Fffv11iWURmnlMWfzP%2FU50eMFgVj4VEFdBqwemigMhQkVZv3KkslnMFY6qq35g%2B3zmvfS9WB9TSoLddSwMspZgWj7cHfv%2F2%2FcfXwfXN4DSLKebGI3GRUs3EWfoTkx0muw8D9TGSXYjJ7uS54NVHV5PvIN9En%2BAvrP7StEwWNGLG87NgxmbI1P%2BYKbfoQ9VCyw6IWpjZcn6kFWq6MPY1TdA%2ByDWnI9PjHvDSmnOWZXyXtFgtOTWSW7CabI%2B62GtXF62Y2HmimBg64yFiohOw37XeGjod20bIf2qI%2FhO9NQxRcH3%2FL4eYlFFwxS%2FLpwIVCq7IBAqur4Usfjh5A5xRcEVmUHDFqoiCK5ZSTIsH7QEUXJGLNi5QcMVk9%2BGgRsEVuWjjAgVXZAoFV%2B9FgmsYtOuLb6K4RieouK504tdRXGNUXN%2F%2F2yFmZVRc8dPyqUCFiisygYrrayGLX07eAGdUXJEZVFyxKqLiiqUU0%2BJBewAVV%2BSijQtUXDHZfTioUXFFLtq4QMUVmULF1XuZ4hq9meIKp83PFVd9N82vPseDfwA%3D%3C%2Fdiagram%3E%3C%2Fmxfile%3E"></iframe>
656
+
657
+ books.svg
658
+
659
+ ![Books](./books/diagram/books.svg)
660
+
661
+ books.png
662
+
663
+ ![Books](./books/diagram/books.png)
664
+
665
+ ### Basic Commitments:
666
+
667
+ Book is composed of commitments, which are the building blocks of the book. Each commitment defines a specific task or action to be performed by the AI agent. The commitments are defined in a structured format, allowing for easy parsing and execution.
668
+
669
+ #### `PERSONA`
670
+
671
+ defines basic contour of
672
+
673
+ > PERSONA @Joe Average man with
674
+
675
+ also the PERSONA is
676
+
677
+ Describes
678
+
679
+ #### `RULE` or `RULES`
680
+
681
+ defines
682
+
683
+ #### `STYLE`
684
+
685
+ xxx
686
+
687
+ #### `SAMPLE`
688
+
689
+ xxx
690
+
691
+ #### `KNOWLEDGE`
692
+
693
+ xxx
694
+
695
+ #### `EXPECT`
696
+
697
+ xxx
698
+
699
+ #### `FORMAT`
700
+
701
+ xxx
702
+
703
+ #### `JOKER`
704
+
705
+ xxx
706
+
707
+ #### `MODEL`
708
+
709
+ xxx
710
+
711
+ #### `ACTION`
712
+
713
+ xxx
714
+
715
+ #### `META`
716
+
717
+ ### Names
718
+
719
+ each commitment is
720
+
721
+ `PERSONA`
722
+
723
+ Variable names
724
+
725
+ ### Types
726
+
727
+ ### Miscellaneous aspects of Book language
728
+
729
+ #### Named vs Anonymous commitments
730
+
731
+ #### Single line vs multiline
732
+
733
+ #### Bookish vs Non-bookish definitions
734
+
735
+ ---
736
+
737
+ ## **\_\_\_\_**
738
+
739
+ Great context and prompt can make or break you AI app. In last few years we have came from simple one-shot prompts. When you want to add conplexity you have finetunned the model or add better orchestration. But with really large large language models the context seems to be a king.
740
+
741
+ The Book is the language to describe and define your AI app. Its like a shem for a Golem, book is the shem and model is the golem.
742
+
743
+
744
+
745
+ <img
746
+ alt="Franz Kafka Book"
747
+ src="https://promptbook.studio/embed/book-preview.png?book=Franz%20Kafka%0A%20%20%20%20%20%20%7C%20PERSONA%20Franz%20Kafka%2C%20a%20writer%20who%20is%20interested%20in%20the%20human%20condition%20and%20the%20absurdity%20of%20life%2C%20speaks%20German%20and%20Czech%20and%20English%0A%20%20%20%20%20%20%7C%20STYLE%20%7Bkafka.com%2Fthe-castle%7D%0A%20%20%20%20%20%20%7C%20STYLE%20%7Bkafka.com%2Fthe-trial.pdf%7D%0A%20%20%20%20%20%20%7C%20STYLE%20%7Bkafka.com%2Fmetamorphosis.docx%7D%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20Franz%20Kafka%20has%20a%20deep%20understanding%20of%20existentialism%2C%20surrealism%2C%20and%20the%20human%20psyche%0A%20%20%20%20%20%20%7C%20GOAL%20Write%20a%20short%20story%20that%20explores%20the%20themes%20of%20alienation%2C%20bureaucracy%2C%20and%20the%20absurd%0A%20%20%20%20%20%20%7C%20ACTION%20%7Bmcp&width=800&height=450&nonce=0"
748
+ />
749
+
750
+ ## Who, what and how?
751
+
752
+ To write a good prompt and the book you will be answering 3 main questions
753
+
754
+ - **Who** is working on the task, is it a team or an individual? What is the role of the person in the team? What is the background of the person? What is the motivation of the person to work on this task?
755
+ You rather want `Paul, an typescript developer who prefers SOLID code` not `gemini-2`
756
+ - **What**
757
+ - **How**
527
758
 
528
- What work needs to be done. Each book defines a [workflow _(scenario or pipeline)_](https://github.com/webgptorg/promptbook/discussions/88), which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
759
+ each commitment (described bellow) is connected with one of theese 3 questions.
529
760
 
530
- **Related commands:**
761
+ ### Commitments
531
762
 
532
- - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
763
+ Commitment is one piece of book, you can imagine it as one paragraph of book.
533
764
 
534
- ### **2. Who:** Personas
765
+ Each commitment starts in a new line with commitment name, its usually in UPPERCASE and follows a contents of that commitment. Contents of the commithemt is defined in natural language.
535
766
 
536
- Who does the work. Each task is performed by a persona. A persona is a description of your virtual employee. It is a higher abstraction than the model, tokens, temperature, top-k, top-p and other model parameters.
767
+ Commitments are chained one after another, in general commitments which are written later are more important and redefines things defined earlier.
537
768
 
538
- You can describe what you want in human language like `Jane, creative writer with a sense of sharp humour` instead of `gpt-4-2024-13-31, temperature 1.2, top-k 40, STOP token ".\n",...`.
769
+ Each commitment falls into one or more of cathegory who, what or how
539
770
 
540
- Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
771
+ Here are some basic commintemts:
541
772
 
542
- **Related commands:**
773
+ - `PERSONA` tells **who** is working on the task
774
+ - `KNOWLEDGE` describes **what** knowledge the person has
775
+ - `GOAL` describes **what** is the goal of the task
776
+ - `ACTION` describes **what** actions can be done
777
+ - `RULE` describes **what** rules should be followed
778
+ - `STYLE` describes **how** the output should be presented
543
779
 
544
- - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
780
+ ### Variables and references
545
781
 
546
- ### **3. How:** Knowledge, Instruments and Actions
782
+ When the prompt should be to be useful it should have some fixed static part and some variable dynamic part
547
783
 
548
- The resources used by the personas are used to do the work.
549
784
 
550
- **Related commands:**
551
785
 
552
- - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
553
- - [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md) for real-time data like time, location, weather, stock prices, searching the internet, calculations, etc.
554
- - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
786
+ <img
787
+ alt="Untitled Book"
788
+ src="https://promptbook.studio/embed/book-preview.png?book=&width=800&height=450&nonce=0"
789
+ />
555
790
 
556
- ### General Principles
791
+ ### Imports
557
792
 
558
- Book language is based on markdown. It is subset of markdown. It is designed to be easy to read and write. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
793
+ ### Layering
559
794
 
560
- The file has a `.book` extension and uses UTF-8 encoding without BOM.
795
+ ### Book defined in book
561
796
 
562
- Books have two variants: flat — just a prompt without structure, and full — with tasks, commands, and prompts.
797
+ ###
563
798
 
564
- As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
799
+ Book vs:
565
800
 
566
- But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
801
+ - Why just dont pick the right model
802
+ - Orchestration frameworks - Langchain, Google Agent ..., Semantic Kernel,...
803
+ - Finetunning
804
+ - Temperature, top_t, top_k,... etc.
805
+ - System message
806
+ - MCP server
807
+ - function calling
567
808
 
568
809
 
569
810
 
package/esm/index.es.js CHANGED
@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
16
16
  * @generated
17
17
  * @see https://github.com/webgptorg/promptbook
18
18
  */
19
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-1';
19
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-2';
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.103.0-0`).
18
+ * It follows semantic versioning (e.g., `0.103.0-1`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/utils",
3
- "version": "0.103.0-1",
3
+ "version": "0.103.0-2",
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
@@ -22,7 +22,7 @@
22
22
  * @generated
23
23
  * @see https://github.com/webgptorg/promptbook
24
24
  */
25
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-1';
25
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-2';
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