@promptbook/vercel 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 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 apps in plain Language
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
 
@@ -118,19 +120,131 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
118
120
 
119
121
 
120
122
 
121
- ## 🤍 The Book Abstract
123
+ ## 📖 The Book Whitepaper
124
+
125
+ 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.
126
+
127
+ 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.
128
+
129
+ 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.
130
+
131
+
132
+
133
+ <img
134
+ alt="Paul Smith & Associés Book"
135
+ 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"
136
+ />
137
+
138
+ <div style="page-break-after: always;"></div>
139
+
140
+ ### Aspects of great AI agent
141
+
142
+ 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.
143
+
144
+ You can look at it as prompting (or writing a system message), but decorated by **commitments**.
145
+
146
+ #### `Persona` commitment
147
+
148
+ 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.
149
+
150
+
151
+
152
+ <img
153
+ alt="Paul Smith & Associés Book"
154
+ 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"
155
+ />
156
+
157
+ #### `Knowledge` commitment
158
+
159
+ Knowledge Commitment allows you to provide specific information, facts, or context that the AI should be aware of when responding.
160
+
161
+ This can include domain-specific knowledge, company policies, or any other relevant information.
162
+
163
+ 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.
164
+
165
+
166
+
167
+ <img
168
+ alt="Paul Smith & Associés Book"
169
+ 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"
170
+ />
171
+
172
+ #### `Rule` commitment
173
+
174
+ 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.
175
+
176
+ Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
177
+
178
+
179
+
180
+ <img
181
+ alt="Paul Smith & Associés Book"
182
+ 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"
183
+ />
184
+
185
+ #### `Action` commitment
122
186
 
123
- **It's time for a paradigm shift! The future of software is written in plain English, French, or Latin.**
187
+ 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.
124
188
 
125
- 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**!
126
189
 
127
- 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!
128
190
 
129
- 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.
191
+ <img
192
+ alt="Paul Smith & Associés Book"
193
+ 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"
194
+ />
130
195
 
131
- This shift will happen whether we're ready or not. Our mission is to make it excellent, not just good.
196
+ [Read more about the language](./BLUEPRINT.md)
132
197
 
133
- **Join us in this journey!**
198
+ <div style="page-break-after: always;"></div>
199
+
200
+ ### Where to use your AI agent in book
201
+
202
+ Books can be useful in various applications and scenarios. Here are some examples:
203
+
204
+ #### Chat apps:
205
+
206
+ Create your own chat shopping assistant and place it in your eShop.
207
+ 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.
208
+
209
+ #### Reply Agent:
210
+
211
+ 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.
212
+
213
+ #### Coding Agent:
214
+
215
+ 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.
216
+
217
+ This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
218
+
219
+ They will work the same as you are used to, but with your specific rules written in book.
220
+
221
+ #### Internal Expertise
222
+
223
+ Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
224
+
225
+ 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.
226
+
227
+ 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.
228
+
229
+ Even works in no-code platforms!
230
+
231
+ <div style="page-break-after: always;"></div>
232
+
233
+ ### How to create your AI agent in book
234
+
235
+ Now you want to use it. There are several ways how to write your first book:
236
+
237
+ #### From scratch with help from Paul
238
+
239
+ We have written ai asistant in book who can help you with writing your first book.
240
+
241
+ #### Your AI twin
242
+
243
+ 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.
244
+
245
+ #### AI persona workpool
246
+
247
+ 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.
134
248
 
135
249
 
136
250
 
@@ -247,78 +361,207 @@ Join our growing community of developers and users:
247
361
 
248
362
  ## 📘 Book Language Blueprint
249
363
 
250
- _A concise, Markdown-based DSL for crafting AI workflows and automations._
364
+ <blockquote style="color:#FFE600">
365
+ ⚠ This file is a work in progress and may be incomplete or inaccurate.
366
+ </blockquote>
251
367
 
252
- ### Introduction
368
+ ---
253
369
 
254
- 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.
370
+ 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.
255
371
 
256
- ### Example
372
+ Book is defined in file with `.book` extension
257
373
 
258
- ```book
259
- # 🌟 My First Book
374
+ ### Examples
260
375
 
261
- - BOOK VERSION 1.0.0
262
- - URL https://promptbook.studio/hello.book
263
- - INPUT PARAMETER {topic}
264
- - OUTPUT PARAMETER {article}
265
376
 
266
- # Write an Article
267
377
 
268
- - PERSONA Jane, marketing specialist with prior experience in tech and AI writing
269
- - KNOWLEDGE https://wikipedia.org/
270
- - KNOWLEDGE ./journalist-ethics.pdf
271
- - EXPECT MIN 1 Sentence
272
- - EXPECT MAX 5 Pages
378
+ <img
379
+ alt="Write an article about {topic} Book"
380
+ 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"
381
+ />
273
382
 
274
- > Write an article about {topic}
383
+ ---
275
384
 
276
- → {article}
277
- ```
278
385
 
279
- Each part of the book defines one of three circles:
280
386
 
281
- ### **1. What:** Workflows, Tasks and Parameters
387
+ <img
388
+ alt="Make post on LinkedIn based on @Input. Book"
389
+ 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"
390
+ />
391
+
392
+ ---
393
+
394
+
395
+
396
+ <img
397
+ alt="Odpověz na Email Book"
398
+ 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"
399
+ />
400
+
401
+ ---
402
+
403
+
404
+
405
+ <img
406
+ alt="Analyzuj {Případ}. Book"
407
+ 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"
408
+ />
409
+
410
+ iframe:
411
+
412
+ <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>
413
+
414
+ books.svg
415
+
416
+ ![Books](./books/diagram/books.svg)
417
+
418
+ books.png
419
+
420
+ ![Books](./books/diagram/books.png)
421
+
422
+ ### Basic Commitments:
423
+
424
+ 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.
425
+
426
+ #### `PERSONA`
427
+
428
+ defines basic contour of
429
+
430
+ > PERSONA @Joe Average man with
431
+
432
+ also the PERSONA is
433
+
434
+ Describes
435
+
436
+ #### `RULE` or `RULES`
437
+
438
+ defines
439
+
440
+ #### `STYLE`
441
+
442
+ xxx
443
+
444
+ #### `SAMPLE`
445
+
446
+ xxx
447
+
448
+ #### `KNOWLEDGE`
449
+
450
+ xxx
451
+
452
+ #### `EXPECT`
453
+
454
+ xxx
455
+
456
+ #### `FORMAT`
457
+
458
+ xxx
459
+
460
+ #### `JOKER`
461
+
462
+ xxx
463
+
464
+ #### `MODEL`
465
+
466
+ xxx
467
+
468
+ #### `ACTION`
469
+
470
+ xxx
471
+
472
+ #### `META`
473
+
474
+ ### Names
475
+
476
+ each commitment is
477
+
478
+ `PERSONA`
479
+
480
+ Variable names
481
+
482
+ ### Types
483
+
484
+ ### Miscellaneous aspects of Book language
485
+
486
+ #### Named vs Anonymous commitments
487
+
488
+ #### Single line vs multiline
489
+
490
+ #### Bookish vs Non-bookish definitions
491
+
492
+ ---
493
+
494
+ ## **\_\_\_\_**
495
+
496
+ 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.
497
+
498
+ 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.
499
+
500
+
501
+
502
+ <img
503
+ alt="Franz Kafka Book"
504
+ 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"
505
+ />
506
+
507
+ ## Who, what and how?
508
+
509
+ To write a good prompt and the book you will be answering 3 main questions
510
+
511
+ - **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?
512
+ You rather want `Paul, an typescript developer who prefers SOLID code` not `gemini-2`
513
+ - **What**
514
+ - **How**
282
515
 
283
- 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.
516
+ each commitment (described bellow) is connected with one of theese 3 questions.
284
517
 
285
- **Related commands:**
518
+ ### Commitments
286
519
 
287
- - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
520
+ Commitment is one piece of book, you can imagine it as one paragraph of book.
288
521
 
289
- ### **2. Who:** Personas
522
+ 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.
290
523
 
291
- 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.
524
+ Commitments are chained one after another, in general commitments which are written later are more important and redefines things defined earlier.
292
525
 
293
- 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",...`.
526
+ Each commitment falls into one or more of cathegory who, what or how
294
527
 
295
- Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
528
+ Here are some basic commintemts:
296
529
 
297
- **Related commands:**
530
+ - `PERSONA` tells **who** is working on the task
531
+ - `KNOWLEDGE` describes **what** knowledge the person has
532
+ - `GOAL` describes **what** is the goal of the task
533
+ - `ACTION` describes **what** actions can be done
534
+ - `RULE` describes **what** rules should be followed
535
+ - `STYLE` describes **how** the output should be presented
298
536
 
299
- - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
537
+ ### Variables and references
300
538
 
301
- ### **3. How:** Knowledge, Instruments and Actions
539
+ When the prompt should be to be useful it should have some fixed static part and some variable dynamic part
302
540
 
303
- The resources used by the personas are used to do the work.
304
541
 
305
- **Related commands:**
306
542
 
307
- - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
308
- - [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.
309
- - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
543
+ <img
544
+ alt="Untitled Book"
545
+ src="https://promptbook.studio/embed/book-preview.png?book=&width=800&height=450&nonce=0"
546
+ />
310
547
 
311
- ### General Principles
548
+ ### Imports
312
549
 
313
- 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.
550
+ ### Layering
314
551
 
315
- The file has a `.book` extension and uses UTF-8 encoding without BOM.
552
+ ### Book defined in book
316
553
 
317
- Books have two variants: flat — just a prompt without structure, and full — with tasks, commands, and prompts.
554
+ ###
318
555
 
319
- 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.
556
+ Book vs:
320
557
 
321
- But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
558
+ - Why just dont pick the right model
559
+ - Orchestration frameworks - Langchain, Google Agent ..., Semantic Kernel,...
560
+ - Finetunning
561
+ - Temperature, top_t, top_k,... etc.
562
+ - System message
563
+ - MCP server
564
+ - function calling
322
565
 
323
566
 
324
567
 
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-0';
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
@@ -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 = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
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.102.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/vercel",
3
- "version": "0.103.0-0",
4
- "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
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": {
@@ -94,7 +94,7 @@
94
94
  "module": "./esm/index.es.js",
95
95
  "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
96
96
  "peerDependencies": {
97
- "@promptbook/core": "0.103.0-0"
97
+ "@promptbook/core": "0.103.0-2"
98
98
  },
99
99
  "dependencies": {
100
100
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -23,7 +23,7 @@
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-0';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-2';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * Note: [💞] Ignore a discrepancy between file name and entity name