@promptbook/openai 0.103.0-0 → 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 +294 -51
- package/esm/index.es.js +1 -1
- package/esm/typings/src/config.d.ts +1 -1
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +3 -3
- package/umd/index.umd.js +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
<!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
|
|
2
2
|
|
|
3
|
-
# ✨ Promptbook: AI
|
|
3
|
+
# ✨ Promptbook: AI Agents
|
|
4
|
+
|
|
5
|
+
Turn your company's scattered knowledge into AI ready Books
|
|
6
|
+
|
|
4
7
|
|
|
5
|
-
Write AI applications using plain human language across multiple models and platforms.
|
|
6
8
|
|
|
7
9
|
|
|
8
10
|
|
|
@@ -376,19 +378,131 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
376
378
|
|
|
377
379
|
|
|
378
380
|
|
|
379
|
-
##
|
|
381
|
+
## 📖 The Book Whitepaper
|
|
382
|
+
|
|
383
|
+
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.
|
|
384
|
+
|
|
385
|
+
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.
|
|
386
|
+
|
|
387
|
+
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.
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
<img
|
|
392
|
+
alt="Paul Smith & Associés Book"
|
|
393
|
+
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"
|
|
394
|
+
/>
|
|
395
|
+
|
|
396
|
+
<div style="page-break-after: always;"></div>
|
|
397
|
+
|
|
398
|
+
### Aspects of great AI agent
|
|
399
|
+
|
|
400
|
+
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.
|
|
401
|
+
|
|
402
|
+
You can look at it as prompting (or writing a system message), but decorated by **commitments**.
|
|
403
|
+
|
|
404
|
+
#### `Persona` commitment
|
|
405
|
+
|
|
406
|
+
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.
|
|
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.&width=800&height=450&nonce=0"
|
|
413
|
+
/>
|
|
414
|
+
|
|
415
|
+
#### `Knowledge` commitment
|
|
416
|
+
|
|
417
|
+
Knowledge Commitment allows you to provide specific information, facts, or context that the AI should be aware of when responding.
|
|
418
|
+
|
|
419
|
+
This can include domain-specific knowledge, company policies, or any other relevant information.
|
|
420
|
+
|
|
421
|
+
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.
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<img
|
|
426
|
+
alt="Paul Smith & Associés Book"
|
|
427
|
+
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"
|
|
428
|
+
/>
|
|
429
|
+
|
|
430
|
+
#### `Rule` commitment
|
|
431
|
+
|
|
432
|
+
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.
|
|
433
|
+
|
|
434
|
+
Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
<img
|
|
439
|
+
alt="Paul Smith & Associés Book"
|
|
440
|
+
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"
|
|
441
|
+
/>
|
|
442
|
+
|
|
443
|
+
#### `Action` commitment
|
|
380
444
|
|
|
381
|
-
|
|
445
|
+
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.
|
|
382
446
|
|
|
383
|
-
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**!
|
|
384
447
|
|
|
385
|
-
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!
|
|
386
448
|
|
|
387
|
-
|
|
449
|
+
<img
|
|
450
|
+
alt="Paul Smith & Associés Book"
|
|
451
|
+
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"
|
|
452
|
+
/>
|
|
388
453
|
|
|
389
|
-
|
|
454
|
+
[Read more about the language](./BLUEPRINT.md)
|
|
390
455
|
|
|
391
|
-
|
|
456
|
+
<div style="page-break-after: always;"></div>
|
|
457
|
+
|
|
458
|
+
### Where to use your AI agent in book
|
|
459
|
+
|
|
460
|
+
Books can be useful in various applications and scenarios. Here are some examples:
|
|
461
|
+
|
|
462
|
+
#### Chat apps:
|
|
463
|
+
|
|
464
|
+
Create your own chat shopping assistant and place it in your eShop.
|
|
465
|
+
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.
|
|
466
|
+
|
|
467
|
+
#### Reply Agent:
|
|
468
|
+
|
|
469
|
+
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.
|
|
470
|
+
|
|
471
|
+
#### Coding Agent:
|
|
472
|
+
|
|
473
|
+
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.
|
|
474
|
+
|
|
475
|
+
This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
|
|
476
|
+
|
|
477
|
+
They will work the same as you are used to, but with your specific rules written in book.
|
|
478
|
+
|
|
479
|
+
#### Internal Expertise
|
|
480
|
+
|
|
481
|
+
Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
|
|
482
|
+
|
|
483
|
+
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.
|
|
484
|
+
|
|
485
|
+
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.
|
|
486
|
+
|
|
487
|
+
Even works in no-code platforms!
|
|
488
|
+
|
|
489
|
+
<div style="page-break-after: always;"></div>
|
|
490
|
+
|
|
491
|
+
### How to create your AI agent in book
|
|
492
|
+
|
|
493
|
+
Now you want to use it. There are several ways how to write your first book:
|
|
494
|
+
|
|
495
|
+
#### From scratch with help from Paul
|
|
496
|
+
|
|
497
|
+
We have written ai asistant in book who can help you with writing your first book.
|
|
498
|
+
|
|
499
|
+
#### Your AI twin
|
|
500
|
+
|
|
501
|
+
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.
|
|
502
|
+
|
|
503
|
+
#### AI persona workpool
|
|
504
|
+
|
|
505
|
+
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.
|
|
392
506
|
|
|
393
507
|
|
|
394
508
|
|
|
@@ -505,78 +619,207 @@ Join our growing community of developers and users:
|
|
|
505
619
|
|
|
506
620
|
## 📘 Book Language Blueprint
|
|
507
621
|
|
|
508
|
-
|
|
622
|
+
<blockquote style="color:#FFE600">
|
|
623
|
+
⚠ This file is a work in progress and may be incomplete or inaccurate.
|
|
624
|
+
</blockquote>
|
|
509
625
|
|
|
510
|
-
|
|
626
|
+
---
|
|
511
627
|
|
|
512
|
-
Book is a
|
|
628
|
+
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.
|
|
513
629
|
|
|
514
|
-
|
|
630
|
+
Book is defined in file with `.book` extension
|
|
515
631
|
|
|
516
|
-
|
|
517
|
-
# 🌟 My First Book
|
|
632
|
+
### Examples
|
|
518
633
|
|
|
519
|
-
- BOOK VERSION 1.0.0
|
|
520
|
-
- URL https://promptbook.studio/hello.book
|
|
521
|
-
- INPUT PARAMETER {topic}
|
|
522
|
-
- OUTPUT PARAMETER {article}
|
|
523
634
|
|
|
524
|
-
# Write an Article
|
|
525
635
|
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
-
|
|
529
|
-
|
|
530
|
-
- EXPECT MAX 5 Pages
|
|
636
|
+
<img
|
|
637
|
+
alt="Write an article about {topic} Book"
|
|
638
|
+
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"
|
|
639
|
+
/>
|
|
531
640
|
|
|
532
|
-
|
|
641
|
+
---
|
|
533
642
|
|
|
534
|
-
→ {article}
|
|
535
|
-
```
|
|
536
643
|
|
|
537
|
-
Each part of the book defines one of three circles:
|
|
538
644
|
|
|
539
|
-
|
|
645
|
+
<img
|
|
646
|
+
alt="Make post on LinkedIn based on @Input. Book"
|
|
647
|
+
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"
|
|
648
|
+
/>
|
|
649
|
+
|
|
650
|
+
---
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
<img
|
|
655
|
+
alt="Odpověz na Email Book"
|
|
656
|
+
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"
|
|
657
|
+
/>
|
|
658
|
+
|
|
659
|
+
---
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
<img
|
|
664
|
+
alt="Analyzuj {Případ}. Book"
|
|
665
|
+
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"
|
|
666
|
+
/>
|
|
667
|
+
|
|
668
|
+
iframe:
|
|
669
|
+
|
|
670
|
+
<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>
|
|
671
|
+
|
|
672
|
+
books.svg
|
|
673
|
+
|
|
674
|
+

|
|
675
|
+
|
|
676
|
+
books.png
|
|
677
|
+
|
|
678
|
+

|
|
679
|
+
|
|
680
|
+
### Basic Commitments:
|
|
681
|
+
|
|
682
|
+
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.
|
|
683
|
+
|
|
684
|
+
#### `PERSONA`
|
|
685
|
+
|
|
686
|
+
defines basic contour of
|
|
687
|
+
|
|
688
|
+
> PERSONA @Joe Average man with
|
|
689
|
+
|
|
690
|
+
also the PERSONA is
|
|
691
|
+
|
|
692
|
+
Describes
|
|
693
|
+
|
|
694
|
+
#### `RULE` or `RULES`
|
|
695
|
+
|
|
696
|
+
defines
|
|
697
|
+
|
|
698
|
+
#### `STYLE`
|
|
699
|
+
|
|
700
|
+
xxx
|
|
701
|
+
|
|
702
|
+
#### `SAMPLE`
|
|
703
|
+
|
|
704
|
+
xxx
|
|
705
|
+
|
|
706
|
+
#### `KNOWLEDGE`
|
|
707
|
+
|
|
708
|
+
xxx
|
|
709
|
+
|
|
710
|
+
#### `EXPECT`
|
|
711
|
+
|
|
712
|
+
xxx
|
|
713
|
+
|
|
714
|
+
#### `FORMAT`
|
|
715
|
+
|
|
716
|
+
xxx
|
|
717
|
+
|
|
718
|
+
#### `JOKER`
|
|
719
|
+
|
|
720
|
+
xxx
|
|
721
|
+
|
|
722
|
+
#### `MODEL`
|
|
723
|
+
|
|
724
|
+
xxx
|
|
725
|
+
|
|
726
|
+
#### `ACTION`
|
|
727
|
+
|
|
728
|
+
xxx
|
|
729
|
+
|
|
730
|
+
#### `META`
|
|
731
|
+
|
|
732
|
+
### Names
|
|
733
|
+
|
|
734
|
+
each commitment is
|
|
735
|
+
|
|
736
|
+
`PERSONA`
|
|
737
|
+
|
|
738
|
+
Variable names
|
|
739
|
+
|
|
740
|
+
### Types
|
|
741
|
+
|
|
742
|
+
### Miscellaneous aspects of Book language
|
|
743
|
+
|
|
744
|
+
#### Named vs Anonymous commitments
|
|
745
|
+
|
|
746
|
+
#### Single line vs multiline
|
|
747
|
+
|
|
748
|
+
#### Bookish vs Non-bookish definitions
|
|
749
|
+
|
|
750
|
+
---
|
|
751
|
+
|
|
752
|
+
## **\_\_\_\_**
|
|
753
|
+
|
|
754
|
+
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.
|
|
755
|
+
|
|
756
|
+
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.
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
<img
|
|
761
|
+
alt="Franz Kafka Book"
|
|
762
|
+
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"
|
|
763
|
+
/>
|
|
764
|
+
|
|
765
|
+
## Who, what and how?
|
|
766
|
+
|
|
767
|
+
To write a good prompt and the book you will be answering 3 main questions
|
|
768
|
+
|
|
769
|
+
- **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?
|
|
770
|
+
You rather want `Paul, an typescript developer who prefers SOLID code` not `gemini-2`
|
|
771
|
+
- **What**
|
|
772
|
+
- **How**
|
|
540
773
|
|
|
541
|
-
|
|
774
|
+
each commitment (described bellow) is connected with one of theese 3 questions.
|
|
542
775
|
|
|
543
|
-
|
|
776
|
+
### Commitments
|
|
544
777
|
|
|
545
|
-
|
|
778
|
+
Commitment is one piece of book, you can imagine it as one paragraph of book.
|
|
546
779
|
|
|
547
|
-
|
|
780
|
+
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.
|
|
548
781
|
|
|
549
|
-
|
|
782
|
+
Commitments are chained one after another, in general commitments which are written later are more important and redefines things defined earlier.
|
|
550
783
|
|
|
551
|
-
|
|
784
|
+
Each commitment falls into one or more of cathegory who, what or how
|
|
552
785
|
|
|
553
|
-
|
|
786
|
+
Here are some basic commintemts:
|
|
554
787
|
|
|
555
|
-
**
|
|
788
|
+
- `PERSONA` tells **who** is working on the task
|
|
789
|
+
- `KNOWLEDGE` describes **what** knowledge the person has
|
|
790
|
+
- `GOAL` describes **what** is the goal of the task
|
|
791
|
+
- `ACTION` describes **what** actions can be done
|
|
792
|
+
- `RULE` describes **what** rules should be followed
|
|
793
|
+
- `STYLE` describes **how** the output should be presented
|
|
556
794
|
|
|
557
|
-
|
|
795
|
+
### Variables and references
|
|
558
796
|
|
|
559
|
-
|
|
797
|
+
When the prompt should be to be useful it should have some fixed static part and some variable dynamic part
|
|
560
798
|
|
|
561
|
-
The resources used by the personas are used to do the work.
|
|
562
799
|
|
|
563
|
-
**Related commands:**
|
|
564
800
|
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
801
|
+
<img
|
|
802
|
+
alt="Untitled Book"
|
|
803
|
+
src="https://promptbook.studio/embed/book-preview.png?book=&width=800&height=450&nonce=0"
|
|
804
|
+
/>
|
|
568
805
|
|
|
569
|
-
###
|
|
806
|
+
### Imports
|
|
570
807
|
|
|
571
|
-
|
|
808
|
+
### Layering
|
|
572
809
|
|
|
573
|
-
|
|
810
|
+
### Book defined in book
|
|
574
811
|
|
|
575
|
-
|
|
812
|
+
###
|
|
576
813
|
|
|
577
|
-
|
|
814
|
+
Book vs:
|
|
578
815
|
|
|
579
|
-
|
|
816
|
+
- Why just dont pick the right model
|
|
817
|
+
- Orchestration frameworks - Langchain, Google Agent ..., Semantic Kernel,...
|
|
818
|
+
- Finetunning
|
|
819
|
+
- Temperature, top_t, top_k,... etc.
|
|
820
|
+
- System message
|
|
821
|
+
- MCP server
|
|
822
|
+
- function calling
|
|
580
823
|
|
|
581
824
|
|
|
582
825
|
|
package/esm/index.es.js
CHANGED
|
@@ -19,7 +19,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
19
19
|
* @generated
|
|
20
20
|
* @see https://github.com/webgptorg/promptbook
|
|
21
21
|
*/
|
|
22
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.103.0-
|
|
22
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.103.0-2';
|
|
23
23
|
/**
|
|
24
24
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
25
25
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -35,7 +35,7 @@ export declare const ADMIN_GITHUB_NAME: string_name;
|
|
|
35
35
|
*
|
|
36
36
|
* @public exported from `@promptbook/core`
|
|
37
37
|
*/
|
|
38
|
-
export declare const CLAIM = "
|
|
38
|
+
export declare const CLAIM = "Turn your company's scattered knowledge into AI ready books";
|
|
39
39
|
/**
|
|
40
40
|
* Color of the Promptbook
|
|
41
41
|
*
|
|
@@ -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.
|
|
18
|
+
* It follows semantic versioning (e.g., `0.103.0-1`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/openai",
|
|
3
|
-
"version": "0.103.0-
|
|
4
|
-
"description": "Promptbook:
|
|
3
|
+
"version": "0.103.0-2",
|
|
4
|
+
"description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
7
7
|
"repository": {
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
"module": "./esm/index.es.js",
|
|
103
103
|
"typings": "./esm/typings/src/_packages/openai.index.d.ts",
|
|
104
104
|
"peerDependencies": {
|
|
105
|
-
"@promptbook/core": "0.103.0-
|
|
105
|
+
"@promptbook/core": "0.103.0-2"
|
|
106
106
|
},
|
|
107
107
|
"dependencies": {
|
|
108
108
|
"bottleneck": "^2.19.5",
|
package/umd/index.umd.js
CHANGED
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
* @generated
|
|
26
26
|
* @see https://github.com/webgptorg/promptbook
|
|
27
27
|
*/
|
|
28
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.103.0-
|
|
28
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.103.0-2';
|
|
29
29
|
/**
|
|
30
30
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
31
31
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|