promptbook 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.
Files changed (2) hide show
  1. package/README.md +290 -49
  2. package/package.json +30 -30
package/README.md CHANGED
@@ -36,19 +36,131 @@ Turn your company's scattered knowledge into AI ready Books
36
36
 
37
37
 
38
38
 
39
- ## 🤍 The Book Abstract
39
+ ## 📖 The Book Whitepaper
40
40
 
41
- **It's time for a paradigm shift! The future of software is written in plain English, French, or Latin.**
41
+ 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.
42
42
 
43
- 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**!
43
+ 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.
44
44
 
45
- 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!
45
+ 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.
46
46
 
47
- 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.
48
47
 
49
- This shift will happen whether we're ready or not. Our mission is to make it excellent, not just good.
50
48
 
51
- **Join us in this journey!**
49
+ <img
50
+ alt="Paul Smith & Associés Book"
51
+ 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"
52
+ />
53
+
54
+ <div style="page-break-after: always;"></div>
55
+
56
+ ### Aspects of great AI agent
57
+
58
+ 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.
59
+
60
+ You can look at it as prompting (or writing a system message), but decorated by **commitments**.
61
+
62
+ #### `Persona` commitment
63
+
64
+ 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.
65
+
66
+
67
+
68
+ <img
69
+ alt="Paul Smith & Associés Book"
70
+ 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"
71
+ />
72
+
73
+ #### `Knowledge` commitment
74
+
75
+ Knowledge Commitment allows you to provide specific information, facts, or context that the AI should be aware of when responding.
76
+
77
+ This can include domain-specific knowledge, company policies, or any other relevant information.
78
+
79
+ 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.
80
+
81
+
82
+
83
+ <img
84
+ alt="Paul Smith & Associés Book"
85
+ 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"
86
+ />
87
+
88
+ #### `Rule` commitment
89
+
90
+ 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.
91
+
92
+ Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
93
+
94
+
95
+
96
+ <img
97
+ alt="Paul Smith & Associés Book"
98
+ 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"
99
+ />
100
+
101
+ #### `Action` commitment
102
+
103
+ 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.
104
+
105
+
106
+
107
+ <img
108
+ alt="Paul Smith & Associés Book"
109
+ 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"
110
+ />
111
+
112
+ [Read more about the language](./BLUEPRINT.md)
113
+
114
+ <div style="page-break-after: always;"></div>
115
+
116
+ ### Where to use your AI agent in book
117
+
118
+ Books can be useful in various applications and scenarios. Here are some examples:
119
+
120
+ #### Chat apps:
121
+
122
+ Create your own chat shopping assistant and place it in your eShop.
123
+ 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.
124
+
125
+ #### Reply Agent:
126
+
127
+ 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.
128
+
129
+ #### Coding Agent:
130
+
131
+ 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.
132
+
133
+ This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
134
+
135
+ They will work the same as you are used to, but with your specific rules written in book.
136
+
137
+ #### Internal Expertise
138
+
139
+ Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
140
+
141
+ 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.
142
+
143
+ 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.
144
+
145
+ Even works in no-code platforms!
146
+
147
+ <div style="page-break-after: always;"></div>
148
+
149
+ ### How to create your AI agent in book
150
+
151
+ Now you want to use it. There are several ways how to write your first book:
152
+
153
+ #### From scratch with help from Paul
154
+
155
+ We have written ai asistant in book who can help you with writing your first book.
156
+
157
+ #### Your AI twin
158
+
159
+ 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.
160
+
161
+ #### AI persona workpool
162
+
163
+ 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.
52
164
 
53
165
 
54
166
 
@@ -165,78 +277,207 @@ Join our growing community of developers and users:
165
277
 
166
278
  ## 📘 Book Language Blueprint
167
279
 
168
- _A concise, Markdown-based DSL for crafting AI workflows and automations._
280
+ <blockquote style="color:#FFE600">
281
+ ⚠ This file is a work in progress and may be incomplete or inaccurate.
282
+ </blockquote>
169
283
 
170
- ### Introduction
284
+ ---
171
285
 
172
- 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.
286
+ 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.
173
287
 
174
- ### Example
288
+ Book is defined in file with `.book` extension
175
289
 
176
- ```book
177
- # 🌟 My First Book
290
+ ### Examples
178
291
 
179
- - BOOK VERSION 1.0.0
180
- - URL https://promptbook.studio/hello.book
181
- - INPUT PARAMETER {topic}
182
- - OUTPUT PARAMETER {article}
183
292
 
184
- # Write an Article
185
293
 
186
- - PERSONA Jane, marketing specialist with prior experience in tech and AI writing
187
- - KNOWLEDGE https://wikipedia.org/
188
- - KNOWLEDGE ./journalist-ethics.pdf
189
- - EXPECT MIN 1 Sentence
190
- - EXPECT MAX 5 Pages
294
+ <img
295
+ alt="Write an article about {topic} Book"
296
+ 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"
297
+ />
191
298
 
192
- > Write an article about {topic}
299
+ ---
193
300
 
194
- → {article}
195
- ```
196
301
 
197
- Each part of the book defines one of three circles:
198
302
 
199
- ### **1. What:** Workflows, Tasks and Parameters
303
+ <img
304
+ alt="Make post on LinkedIn based on @Input. Book"
305
+ 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"
306
+ />
307
+
308
+ ---
309
+
310
+
311
+
312
+ <img
313
+ alt="Odpověz na Email Book"
314
+ 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"
315
+ />
316
+
317
+ ---
318
+
319
+
320
+
321
+ <img
322
+ alt="Analyzuj {Případ}. Book"
323
+ 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"
324
+ />
325
+
326
+ iframe:
327
+
328
+ <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>
329
+
330
+ books.svg
331
+
332
+ ![Books](./books/diagram/books.svg)
333
+
334
+ books.png
335
+
336
+ ![Books](./books/diagram/books.png)
337
+
338
+ ### Basic Commitments:
339
+
340
+ 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.
341
+
342
+ #### `PERSONA`
343
+
344
+ defines basic contour of
345
+
346
+ > PERSONA @Joe Average man with
347
+
348
+ also the PERSONA is
349
+
350
+ Describes
351
+
352
+ #### `RULE` or `RULES`
353
+
354
+ defines
355
+
356
+ #### `STYLE`
357
+
358
+ xxx
359
+
360
+ #### `SAMPLE`
361
+
362
+ xxx
363
+
364
+ #### `KNOWLEDGE`
365
+
366
+ xxx
367
+
368
+ #### `EXPECT`
369
+
370
+ xxx
371
+
372
+ #### `FORMAT`
373
+
374
+ xxx
375
+
376
+ #### `JOKER`
377
+
378
+ xxx
379
+
380
+ #### `MODEL`
381
+
382
+ xxx
383
+
384
+ #### `ACTION`
385
+
386
+ xxx
387
+
388
+ #### `META`
389
+
390
+ ### Names
391
+
392
+ each commitment is
393
+
394
+ `PERSONA`
395
+
396
+ Variable names
397
+
398
+ ### Types
399
+
400
+ ### Miscellaneous aspects of Book language
401
+
402
+ #### Named vs Anonymous commitments
403
+
404
+ #### Single line vs multiline
405
+
406
+ #### Bookish vs Non-bookish definitions
407
+
408
+ ---
409
+
410
+ ## **\_\_\_\_**
411
+
412
+ 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.
413
+
414
+ 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.
415
+
416
+
417
+
418
+ <img
419
+ alt="Franz Kafka Book"
420
+ 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"
421
+ />
422
+
423
+ ## Who, what and how?
424
+
425
+ To write a good prompt and the book you will be answering 3 main questions
426
+
427
+ - **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?
428
+ You rather want `Paul, an typescript developer who prefers SOLID code` not `gemini-2`
429
+ - **What**
430
+ - **How**
200
431
 
201
- 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.
432
+ each commitment (described bellow) is connected with one of theese 3 questions.
202
433
 
203
- **Related commands:**
434
+ ### Commitments
204
435
 
205
- - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
436
+ Commitment is one piece of book, you can imagine it as one paragraph of book.
206
437
 
207
- ### **2. Who:** Personas
438
+ 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.
208
439
 
209
- 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.
440
+ Commitments are chained one after another, in general commitments which are written later are more important and redefines things defined earlier.
210
441
 
211
- 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",...`.
442
+ Each commitment falls into one or more of cathegory who, what or how
212
443
 
213
- Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
444
+ Here are some basic commintemts:
214
445
 
215
- **Related commands:**
446
+ - `PERSONA` tells **who** is working on the task
447
+ - `KNOWLEDGE` describes **what** knowledge the person has
448
+ - `GOAL` describes **what** is the goal of the task
449
+ - `ACTION` describes **what** actions can be done
450
+ - `RULE` describes **what** rules should be followed
451
+ - `STYLE` describes **how** the output should be presented
216
452
 
217
- - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
453
+ ### Variables and references
218
454
 
219
- ### **3. How:** Knowledge, Instruments and Actions
455
+ When the prompt should be to be useful it should have some fixed static part and some variable dynamic part
220
456
 
221
- The resources used by the personas are used to do the work.
222
457
 
223
- **Related commands:**
224
458
 
225
- - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
226
- - [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.
227
- - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
459
+ <img
460
+ alt="Untitled Book"
461
+ src="https://promptbook.studio/embed/book-preview.png?book=&width=800&height=450&nonce=0"
462
+ />
228
463
 
229
- ### General Principles
464
+ ### Imports
230
465
 
231
- 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.
466
+ ### Layering
232
467
 
233
- The file has a `.book` extension and uses UTF-8 encoding without BOM.
468
+ ### Book defined in book
234
469
 
235
- Books have two variants: flat — just a prompt without structure, and full — with tasks, commands, and prompts.
470
+ ###
236
471
 
237
- 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.
472
+ Book vs:
238
473
 
239
- But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
474
+ - Why just dont pick the right model
475
+ - Orchestration frameworks - Langchain, Google Agent ..., Semantic Kernel,...
476
+ - Finetunning
477
+ - Temperature, top_t, top_k,... etc.
478
+ - System message
479
+ - MCP server
480
+ - function calling
240
481
 
241
482
 
242
483
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "promptbook",
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,
@@ -88,36 +88,36 @@
88
88
  "npm": ">=8.0.0"
89
89
  },
90
90
  "peerDependencies": {
91
- "@promptbook/core": "0.103.0-1"
91
+ "@promptbook/core": "0.103.0-2"
92
92
  },
93
93
  "dependencies": {
94
- "@promptbook/anthropic-claude": "0.103.0-1",
95
- "@promptbook/azure-openai": "0.103.0-1",
96
- "@promptbook/browser": "0.103.0-1",
97
- "@promptbook/cli": "0.103.0-1",
98
- "@promptbook/color": "0.103.0-1",
99
- "@promptbook/components": "0.103.0-1",
100
- "@promptbook/core": "0.103.0-1",
101
- "@promptbook/deepseek": "0.103.0-1",
102
- "@promptbook/documents": "0.103.0-1",
103
- "@promptbook/editable": "0.103.0-1",
104
- "@promptbook/fake-llm": "0.103.0-1",
105
- "@promptbook/google": "0.103.0-1",
106
- "@promptbook/javascript": "0.103.0-1",
107
- "@promptbook/legacy-documents": "0.103.0-1",
108
- "@promptbook/markdown-utils": "0.103.0-1",
109
- "@promptbook/markitdown": "0.103.0-1",
110
- "@promptbook/node": "0.103.0-1",
111
- "@promptbook/ollama": "0.103.0-1",
112
- "@promptbook/openai": "0.103.0-1",
113
- "@promptbook/pdf": "0.103.0-1",
114
- "@promptbook/remote-client": "0.103.0-1",
115
- "@promptbook/remote-server": "0.103.0-1",
116
- "@promptbook/templates": "0.103.0-1",
117
- "@promptbook/types": "0.103.0-1",
118
- "@promptbook/utils": "0.103.0-1",
119
- "@promptbook/vercel": "0.103.0-1",
120
- "@promptbook/website-crawler": "0.103.0-1",
121
- "@promptbook/wizard": "0.103.0-1"
94
+ "@promptbook/anthropic-claude": "0.103.0-2",
95
+ "@promptbook/azure-openai": "0.103.0-2",
96
+ "@promptbook/browser": "0.103.0-2",
97
+ "@promptbook/cli": "0.103.0-2",
98
+ "@promptbook/color": "0.103.0-2",
99
+ "@promptbook/components": "0.103.0-2",
100
+ "@promptbook/core": "0.103.0-2",
101
+ "@promptbook/deepseek": "0.103.0-2",
102
+ "@promptbook/documents": "0.103.0-2",
103
+ "@promptbook/editable": "0.103.0-2",
104
+ "@promptbook/fake-llm": "0.103.0-2",
105
+ "@promptbook/google": "0.103.0-2",
106
+ "@promptbook/javascript": "0.103.0-2",
107
+ "@promptbook/legacy-documents": "0.103.0-2",
108
+ "@promptbook/markdown-utils": "0.103.0-2",
109
+ "@promptbook/markitdown": "0.103.0-2",
110
+ "@promptbook/node": "0.103.0-2",
111
+ "@promptbook/ollama": "0.103.0-2",
112
+ "@promptbook/openai": "0.103.0-2",
113
+ "@promptbook/pdf": "0.103.0-2",
114
+ "@promptbook/remote-client": "0.103.0-2",
115
+ "@promptbook/remote-server": "0.103.0-2",
116
+ "@promptbook/templates": "0.103.0-2",
117
+ "@promptbook/types": "0.103.0-2",
118
+ "@promptbook/utils": "0.103.0-2",
119
+ "@promptbook/vercel": "0.103.0-2",
120
+ "@promptbook/website-crawler": "0.103.0-2",
121
+ "@promptbook/wizard": "0.103.0-2"
122
122
  }
123
123
  }