@promptbook/node 0.103.0-3 → 0.103.0-31

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 (89) hide show
  1. package/README.md +6 -207
  2. package/esm/index.es.js +68 -8
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/browser.index.d.ts +6 -0
  5. package/esm/typings/src/_packages/cli.index.d.ts +4 -0
  6. package/esm/typings/src/_packages/components.index.d.ts +12 -8
  7. package/esm/typings/src/_packages/core.index.d.ts +10 -0
  8. package/esm/typings/src/_packages/types.index.d.ts +10 -0
  9. package/esm/typings/src/_packages/wizard.index.d.ts +4 -0
  10. package/esm/typings/src/book-2.0/agent-source/padBook.d.ts +16 -0
  11. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +76 -15
  12. package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +14 -0
  13. package/esm/typings/src/book-components/BookEditor/BookEditorMonaco.d.ts +5 -0
  14. package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +15 -0
  15. package/esm/typings/src/book-components/Chat/MockedChat/MockedChat.d.ts +5 -0
  16. package/esm/typings/src/book-components/Qr/BrandedQrCode.d.ts +18 -0
  17. package/esm/typings/src/book-components/Qr/GenericQrCode.d.ts +10 -0
  18. package/esm/typings/src/book-components/Qr/PromptbookQrCode.d.ts +18 -0
  19. package/esm/typings/src/book-components/Qr/useQrCode.d.ts +15 -0
  20. package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts +15 -0
  21. package/esm/typings/src/book-components/_common/Modal/Modal.d.ts +4 -1
  22. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +1 -1
  23. package/esm/typings/src/book-components/icons/AboutIcon.d.ts +9 -0
  24. package/esm/typings/src/book-components/icons/CloseIcon.d.ts +4 -8
  25. package/esm/typings/src/book-components/icons/DownloadIcon.d.ts +9 -0
  26. package/esm/typings/src/book-components/icons/ExitFullscreenIcon.d.ts +7 -0
  27. package/esm/typings/src/book-components/icons/FullscreenIcon.d.ts +7 -0
  28. package/esm/typings/src/book-components/icons/MenuIcon.d.ts +12 -0
  29. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
  30. package/esm/typings/src/cli/cli-commands/about.d.ts +3 -1
  31. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  32. package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
  33. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
  34. package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
  35. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
  36. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  37. package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
  38. package/esm/typings/src/cli/cli-commands/start-server.d.ts +3 -1
  39. package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
  40. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
  41. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
  42. package/esm/typings/src/config.d.ts +14 -1
  43. package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
  44. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
  45. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  46. package/esm/typings/src/remote-server/startRemoteServer.d.ts +1 -0
  47. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
  48. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
  49. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
  50. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
  51. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
  52. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
  53. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
  54. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
  55. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
  56. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
  57. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
  58. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
  59. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
  60. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
  61. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
  62. package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts +19 -0
  63. package/esm/typings/src/transpilers/_common/BookTranspilerDefinition.d.ts +37 -0
  64. package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts +19 -0
  65. package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +15 -0
  66. package/esm/typings/src/transpilers/langchain/LangchainTranspiler.d.ts +7 -0
  67. package/esm/typings/src/transpilers/langchain/register.d.ts +15 -0
  68. package/esm/typings/src/transpilers/openai/OpenAiSdkTranspiler.d.ts +13 -0
  69. package/esm/typings/src/transpilers/openai/register.d.ts +15 -0
  70. package/esm/typings/src/types/typeAliases.d.ts +1 -1
  71. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
  72. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
  73. package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
  74. package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
  75. package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
  76. package/esm/typings/src/utils/misc/aboutPromptbookInformation.d.ts +21 -0
  77. package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +1 -0
  78. package/esm/typings/src/utils/misc/xAboutPromptbookInformation.d.ts +13 -0
  79. package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
  80. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
  81. package/esm/typings/src/version.d.ts +1 -1
  82. package/package.json +6 -6
  83. package/umd/index.umd.js +68 -8
  84. package/umd/index.umd.js.map +1 -1
  85. package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +0 -5
  86. package/esm/typings/src/book-components/BookEditor/BookEditorWrapper.d.ts +0 -6
  87. package/esm/typings/src/book-components/BookEditor/config.d.ts +0 -10
  88. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts +0 -21
  89. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.test.d.ts +0 -1
package/README.md CHANGED
@@ -121,7 +121,6 @@ The main challenge is to narrow it down, constrain it, set the proper **context,
121
121
  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.
122
122
 
123
123
 
124
-
125
124
  <img
126
125
  alt="Paul Smith & Associés Book"
127
126
  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"
@@ -140,7 +139,6 @@ You can look at it as prompting (or writing a system message), but decorated by
140
139
  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.
141
140
 
142
141
 
143
-
144
142
  <img
145
143
  alt="Paul Smith & Associés Book"
146
144
  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,7 +153,6 @@ This can include domain-specific knowledge, company policies, or any other relev
155
153
  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.
156
154
 
157
155
 
158
-
159
156
  <img
160
157
  alt="Paul Smith & Associés Book"
161
158
  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"
@@ -168,7 +165,6 @@ Rules will enforce specific behaviors or constraints on the AI's responses. This
168
165
  Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
169
166
 
170
167
 
171
-
172
168
  <img
173
169
  alt="Paul Smith & Associés Book"
174
170
  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"
@@ -179,7 +175,6 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
179
175
  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.
180
176
 
181
177
 
182
-
183
178
  <img
184
179
  alt="Paul Smith & Associés Book"
185
180
  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"
@@ -230,10 +225,14 @@ Now you want to use it. There are several ways how to write your first book:
230
225
 
231
226
  We have written ai asistant in book who can help you with writing your first book.
232
227
 
228
+
229
+
233
230
  #### Your AI twin
234
231
 
235
232
  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.
236
233
 
234
+
235
+
237
236
  #### AI persona workpool
238
237
 
239
238
  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.
@@ -351,209 +350,7 @@ Join our growing community of developers and users:
351
350
 
352
351
 
353
352
 
354
- ## 📘 Book Language Blueprint
355
-
356
- <blockquote style="color:#FFE600">
357
- ⚠ This file is a work in progress and may be incomplete or inaccurate.
358
- </blockquote>
359
-
360
- ---
361
-
362
- 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.
363
-
364
- Book is defined in file with `.book` extension
365
-
366
- ### Examples
367
-
368
-
369
-
370
- <img
371
- alt="Write an article about {topic} Book"
372
- 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"
373
- />
374
-
375
- ---
376
-
377
-
378
-
379
- <img
380
- alt="Make post on LinkedIn based on @Input. Book"
381
- 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"
382
- />
383
-
384
- ---
385
-
386
-
387
-
388
- <img
389
- alt="Odpověz na Email Book"
390
- 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"
391
- />
392
-
393
- ---
394
-
395
-
396
-
397
- <img
398
- alt="Analyzuj {Případ}. Book"
399
- 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"
400
- />
401
-
402
- iframe:
403
-
404
- <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>
405
-
406
- books.svg
407
-
408
- ![Books](./books/diagram/books.svg)
409
-
410
- books.png
411
-
412
- ![Books](./books/diagram/books.png)
413
-
414
- ### Basic Commitments:
415
-
416
- 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.
417
-
418
- #### `PERSONA`
419
-
420
- defines basic contour of
421
-
422
- > PERSONA @Joe Average man with
423
-
424
- also the PERSONA is
425
-
426
- Describes
427
-
428
- #### `RULE` or `RULES`
429
-
430
- defines
431
-
432
- #### `STYLE`
433
-
434
- xxx
435
353
 
436
- #### `SAMPLE`
437
-
438
- xxx
439
-
440
- #### `KNOWLEDGE`
441
-
442
- xxx
443
-
444
- #### `EXPECT`
445
-
446
- xxx
447
-
448
- #### `FORMAT`
449
-
450
- xxx
451
-
452
- #### `JOKER`
453
-
454
- xxx
455
-
456
- #### `MODEL`
457
-
458
- xxx
459
-
460
- #### `ACTION`
461
-
462
- xxx
463
-
464
- #### `META`
465
-
466
- ### Names
467
-
468
- each commitment is
469
-
470
- `PERSONA`
471
-
472
- Variable names
473
-
474
- ### Types
475
-
476
- ### Miscellaneous aspects of Book language
477
-
478
- #### Named vs Anonymous commitments
479
-
480
- #### Single line vs multiline
481
-
482
- #### Bookish vs Non-bookish definitions
483
-
484
- ---
485
-
486
- ## **\_\_\_\_**
487
-
488
- 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.
489
-
490
- 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.
491
-
492
-
493
-
494
- <img
495
- alt="Franz Kafka Book"
496
- 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"
497
- />
498
-
499
- ## Who, what and how?
500
-
501
- To write a good prompt and the book you will be answering 3 main questions
502
-
503
- - **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?
504
- You rather want `Paul, an typescript developer who prefers SOLID code` not `gemini-2`
505
- - **What**
506
- - **How**
507
-
508
- each commitment (described bellow) is connected with one of theese 3 questions.
509
-
510
- ### Commitments
511
-
512
- Commitment is one piece of book, you can imagine it as one paragraph of book.
513
-
514
- 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.
515
-
516
- Commitments are chained one after another, in general commitments which are written later are more important and redefines things defined earlier.
517
-
518
- Each commitment falls into one or more of cathegory who, what or how
519
-
520
- Here are some basic commintemts:
521
-
522
- - `PERSONA` tells **who** is working on the task
523
- - `KNOWLEDGE` describes **what** knowledge the person has
524
- - `GOAL` describes **what** is the goal of the task
525
- - `ACTION` describes **what** actions can be done
526
- - `RULE` describes **what** rules should be followed
527
- - `STYLE` describes **how** the output should be presented
528
-
529
- ### Variables and references
530
-
531
- When the prompt should be to be useful it should have some fixed static part and some variable dynamic part
532
-
533
-
534
-
535
- <img
536
- alt="Untitled Book"
537
- src="https://promptbook.studio/embed/book-preview.png?book=&width=800&height=450&nonce=0"
538
- />
539
-
540
- ### Imports
541
-
542
- ### Layering
543
-
544
- ### Book defined in book
545
-
546
- ###
547
-
548
- Book vs:
549
-
550
- - Why just dont pick the right model
551
- - Orchestration frameworks - Langchain, Google Agent ..., Semantic Kernel,...
552
- - Finetunning
553
- - Temperature, top_t, top_k,... etc.
554
- - System message
555
- - MCP server
556
- - function calling
557
354
 
558
355
 
559
356
 
@@ -633,6 +430,8 @@ The following glossary is used to clarify certain concepts:
633
430
 
634
431
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
635
432
 
433
+
434
+
636
435
  ### 💯 Core concepts
637
436
 
638
437
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)