@promptbook/components 0.103.0-3 → 0.103.0-30

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 (93) hide show
  1. package/README.md +6 -208
  2. package/esm/index.es.js +8377 -1326
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/misc/logo-blue-white-256.png +0 -0
  5. package/esm/misc/logo-design-cube.stl +0 -0
  6. package/esm/typings/src/_packages/browser.index.d.ts +6 -0
  7. package/esm/typings/src/_packages/cli.index.d.ts +4 -0
  8. package/esm/typings/src/_packages/components.index.d.ts +12 -8
  9. package/esm/typings/src/_packages/core.index.d.ts +10 -0
  10. package/esm/typings/src/_packages/types.index.d.ts +10 -0
  11. package/esm/typings/src/_packages/wizard.index.d.ts +4 -0
  12. package/esm/typings/src/book-2.0/agent-source/padBook.d.ts +16 -0
  13. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +76 -15
  14. package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +14 -0
  15. package/esm/typings/src/book-components/BookEditor/BookEditorMonaco.d.ts +5 -0
  16. package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +15 -0
  17. package/esm/typings/src/book-components/Chat/MockedChat/MockedChat.d.ts +5 -0
  18. package/esm/typings/src/book-components/Qr/BrandedQrCode.d.ts +18 -0
  19. package/esm/typings/src/book-components/Qr/GenericQrCode.d.ts +10 -0
  20. package/esm/typings/src/book-components/Qr/PromptbookQrCode.d.ts +18 -0
  21. package/esm/typings/src/book-components/Qr/useQrCode.d.ts +15 -0
  22. package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts +15 -0
  23. package/esm/typings/src/book-components/_common/Modal/Modal.d.ts +4 -1
  24. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +1 -1
  25. package/esm/typings/src/book-components/icons/AboutIcon.d.ts +9 -0
  26. package/esm/typings/src/book-components/icons/CloseIcon.d.ts +4 -8
  27. package/esm/typings/src/book-components/icons/DownloadIcon.d.ts +9 -0
  28. package/esm/typings/src/book-components/icons/ExitFullscreenIcon.d.ts +7 -0
  29. package/esm/typings/src/book-components/icons/FullscreenIcon.d.ts +7 -0
  30. package/esm/typings/src/book-components/icons/MenuIcon.d.ts +12 -0
  31. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
  32. package/esm/typings/src/cli/cli-commands/about.d.ts +3 -1
  33. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  34. package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
  35. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
  36. package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
  37. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
  38. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  39. package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
  40. package/esm/typings/src/cli/cli-commands/start-server.d.ts +3 -1
  41. package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
  42. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
  43. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
  44. package/esm/typings/src/config.d.ts +14 -1
  45. package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
  46. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
  47. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  48. package/esm/typings/src/remote-server/startRemoteServer.d.ts +1 -0
  49. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
  50. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
  51. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
  52. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
  53. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
  54. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
  55. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
  56. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
  57. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
  58. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
  59. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
  60. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
  61. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
  62. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
  63. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
  64. package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts +19 -0
  65. package/esm/typings/src/transpilers/_common/BookTranspilerDefinition.d.ts +37 -0
  66. package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts +19 -0
  67. package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +15 -0
  68. package/esm/typings/src/transpilers/langchain/LangchainTranspiler.d.ts +7 -0
  69. package/esm/typings/src/transpilers/langchain/register.d.ts +15 -0
  70. package/esm/typings/src/transpilers/openai/OpenAiSdkTranspiler.d.ts +13 -0
  71. package/esm/typings/src/transpilers/openai/register.d.ts +15 -0
  72. package/esm/typings/src/types/typeAliases.d.ts +1 -1
  73. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
  74. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
  75. package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
  76. package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
  77. package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
  78. package/esm/typings/src/utils/misc/aboutPromptbookInformation.d.ts +21 -0
  79. package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +1 -0
  80. package/esm/typings/src/utils/misc/xAboutPromptbookInformation.d.ts +13 -0
  81. package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
  82. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
  83. package/esm/typings/src/version.d.ts +1 -1
  84. package/package.json +11 -5
  85. package/umd/index.umd.js +8324 -1277
  86. package/umd/index.umd.js.map +1 -1
  87. package/umd/misc/logo-blue-white-256.png +0 -0
  88. package/umd/misc/logo-design-cube.stl +0 -0
  89. package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +0 -5
  90. package/esm/typings/src/book-components/BookEditor/BookEditorWrapper.d.ts +0 -6
  91. package/esm/typings/src/book-components/BookEditor/config.d.ts +0 -10
  92. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts +0 -21
  93. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.test.d.ts +0 -1
package/README.md CHANGED
@@ -171,7 +171,6 @@ The component comes with built-in styles. You can pass your own `className` and
171
171
 
172
172
  - `BookEditor` - Main book editor component with syntax highlighting
173
173
  - `BookEditorProps` - Props interface for BookEditor (type)
174
- - `DEFAULT_BOOK_FONT_CLASS` - Default font class for book editor
175
174
 
176
175
  ### Chat Components
177
176
 
@@ -213,7 +212,6 @@ The main challenge is to narrow it down, constrain it, set the proper **context,
213
212
  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.
214
213
 
215
214
 
216
-
217
215
  <img
218
216
  alt="Paul Smith & Associés Book"
219
217
  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"
@@ -232,7 +230,6 @@ You can look at it as prompting (or writing a system message), but decorated by
232
230
  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.
233
231
 
234
232
 
235
-
236
233
  <img
237
234
  alt="Paul Smith & Associés Book"
238
235
  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"
@@ -247,7 +244,6 @@ This can include domain-specific knowledge, company policies, or any other relev
247
244
  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.
248
245
 
249
246
 
250
-
251
247
  <img
252
248
  alt="Paul Smith & Associés Book"
253
249
  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"
@@ -260,7 +256,6 @@ Rules will enforce specific behaviors or constraints on the AI's responses. This
260
256
  Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
261
257
 
262
258
 
263
-
264
259
  <img
265
260
  alt="Paul Smith & Associés Book"
266
261
  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"
@@ -271,7 +266,6 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
271
266
  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.
272
267
 
273
268
 
274
-
275
269
  <img
276
270
  alt="Paul Smith & Associés Book"
277
271
  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"
@@ -322,10 +316,14 @@ Now you want to use it. There are several ways how to write your first book:
322
316
 
323
317
  We have written ai asistant in book who can help you with writing your first book.
324
318
 
319
+
320
+
325
321
  #### Your AI twin
326
322
 
327
323
  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.
328
324
 
325
+
326
+
329
327
  #### AI persona workpool
330
328
 
331
329
  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.
@@ -443,209 +441,7 @@ Join our growing community of developers and users:
443
441
 
444
442
 
445
443
 
446
- ## 📘 Book Language Blueprint
447
-
448
- <blockquote style="color:#FFE600">
449
- ⚠ This file is a work in progress and may be incomplete or inaccurate.
450
- </blockquote>
451
-
452
- ---
453
-
454
- 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.
455
-
456
- Book is defined in file with `.book` extension
457
-
458
- ### Examples
459
-
460
-
461
-
462
- <img
463
- alt="Write an article about {topic} Book"
464
- 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"
465
- />
466
-
467
- ---
468
-
469
-
470
-
471
- <img
472
- alt="Make post on LinkedIn based on @Input. Book"
473
- 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"
474
- />
475
-
476
- ---
477
-
478
-
479
-
480
- <img
481
- alt="Odpověz na Email Book"
482
- 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"
483
- />
484
-
485
- ---
486
-
487
-
488
-
489
- <img
490
- alt="Analyzuj {Případ}. Book"
491
- 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"
492
- />
493
-
494
- iframe:
495
-
496
- <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>
497
-
498
- books.svg
499
-
500
- ![Books](./books/diagram/books.svg)
501
-
502
- books.png
503
-
504
- ![Books](./books/diagram/books.png)
505
-
506
- ### Basic Commitments:
507
-
508
- 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.
509
-
510
- #### `PERSONA`
511
-
512
- defines basic contour of
513
-
514
- > PERSONA @Joe Average man with
515
-
516
- also the PERSONA is
517
-
518
- Describes
519
-
520
- #### `RULE` or `RULES`
521
-
522
- defines
523
-
524
- #### `STYLE`
525
-
526
- xxx
527
444
 
528
- #### `SAMPLE`
529
-
530
- xxx
531
-
532
- #### `KNOWLEDGE`
533
-
534
- xxx
535
-
536
- #### `EXPECT`
537
-
538
- xxx
539
-
540
- #### `FORMAT`
541
-
542
- xxx
543
-
544
- #### `JOKER`
545
-
546
- xxx
547
-
548
- #### `MODEL`
549
-
550
- xxx
551
-
552
- #### `ACTION`
553
-
554
- xxx
555
-
556
- #### `META`
557
-
558
- ### Names
559
-
560
- each commitment is
561
-
562
- `PERSONA`
563
-
564
- Variable names
565
-
566
- ### Types
567
-
568
- ### Miscellaneous aspects of Book language
569
-
570
- #### Named vs Anonymous commitments
571
-
572
- #### Single line vs multiline
573
-
574
- #### Bookish vs Non-bookish definitions
575
-
576
- ---
577
-
578
- ## **\_\_\_\_**
579
-
580
- 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.
581
-
582
- 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.
583
-
584
-
585
-
586
- <img
587
- alt="Franz Kafka Book"
588
- 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"
589
- />
590
-
591
- ## Who, what and how?
592
-
593
- To write a good prompt and the book you will be answering 3 main questions
594
-
595
- - **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?
596
- You rather want `Paul, an typescript developer who prefers SOLID code` not `gemini-2`
597
- - **What**
598
- - **How**
599
-
600
- each commitment (described bellow) is connected with one of theese 3 questions.
601
-
602
- ### Commitments
603
-
604
- Commitment is one piece of book, you can imagine it as one paragraph of book.
605
-
606
- 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.
607
-
608
- Commitments are chained one after another, in general commitments which are written later are more important and redefines things defined earlier.
609
-
610
- Each commitment falls into one or more of cathegory who, what or how
611
-
612
- Here are some basic commintemts:
613
-
614
- - `PERSONA` tells **who** is working on the task
615
- - `KNOWLEDGE` describes **what** knowledge the person has
616
- - `GOAL` describes **what** is the goal of the task
617
- - `ACTION` describes **what** actions can be done
618
- - `RULE` describes **what** rules should be followed
619
- - `STYLE` describes **how** the output should be presented
620
-
621
- ### Variables and references
622
-
623
- When the prompt should be to be useful it should have some fixed static part and some variable dynamic part
624
-
625
-
626
-
627
- <img
628
- alt="Untitled Book"
629
- src="https://promptbook.studio/embed/book-preview.png?book=&width=800&height=450&nonce=0"
630
- />
631
-
632
- ### Imports
633
-
634
- ### Layering
635
-
636
- ### Book defined in book
637
-
638
- ###
639
-
640
- Book vs:
641
-
642
- - Why just dont pick the right model
643
- - Orchestration frameworks - Langchain, Google Agent ..., Semantic Kernel,...
644
- - Finetunning
645
- - Temperature, top_t, top_k,... etc.
646
- - System message
647
- - MCP server
648
- - function calling
649
445
 
650
446
 
651
447
 
@@ -725,6 +521,8 @@ The following glossary is used to clarify certain concepts:
725
521
 
726
522
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
727
523
 
524
+
525
+
728
526
  ### 💯 Core concepts
729
527
 
730
528
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)