@promptbook/cli 0.103.0-2 → 0.103.0-21
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 +6 -207
- package/esm/index.es.js +74 -12
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/browser.index.d.ts +6 -0
- package/esm/typings/src/_packages/components.index.d.ts +4 -4
- package/esm/typings/src/_packages/core.index.d.ts +6 -0
- package/esm/typings/src/book-2.0/agent-source/padBook.d.ts +16 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +5 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileTooltip.d.ts +15 -0
- package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +66 -8
- package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +11 -0
- package/esm/typings/src/book-components/BookEditor/BookEditorMonaco.d.ts +5 -0
- package/esm/typings/src/book-components/BookEditor/config.d.ts +1 -0
- package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +12 -0
- package/esm/typings/src/book-components/Chat/types/ChatParticipant.d.ts +5 -0
- package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts +15 -0
- package/esm/typings/src/book-components/_common/Modal/Modal.d.ts +13 -0
- package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +1 -1
- package/esm/typings/src/book-components/icons/AboutIcon.d.ts +9 -0
- package/esm/typings/src/book-components/icons/DownloadIcon.d.ts +9 -0
- package/esm/typings/src/book-components/icons/MenuIcon.d.ts +12 -0
- package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/about.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/start-server.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
- package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
- package/esm/typings/src/config.d.ts +14 -1
- package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
- package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
- package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
- package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
- package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
- package/esm/typings/src/types/typeAliases.d.ts +1 -1
- package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
- package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
- package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
- package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
- package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
- package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +1 -0
- package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
- package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +1 -1
- package/umd/index.umd.js +74 -12
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +0 -5
- package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts +0 -21
- package/esm/typings/src/book-components/Chat/utils/renderMarkdown.test.d.ts +0 -1
package/README.md
CHANGED
|
@@ -190,7 +190,6 @@ The main challenge is to narrow it down, constrain it, set the proper **context,
|
|
|
190
190
|
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.
|
|
191
191
|
|
|
192
192
|
|
|
193
|
-
|
|
194
193
|
<img
|
|
195
194
|
alt="Paul Smith & Associés Book"
|
|
196
195
|
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"
|
|
@@ -209,7 +208,6 @@ You can look at it as prompting (or writing a system message), but decorated by
|
|
|
209
208
|
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.
|
|
210
209
|
|
|
211
210
|
|
|
212
|
-
|
|
213
211
|
<img
|
|
214
212
|
alt="Paul Smith & Associés Book"
|
|
215
213
|
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"
|
|
@@ -224,7 +222,6 @@ This can include domain-specific knowledge, company policies, or any other relev
|
|
|
224
222
|
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.
|
|
225
223
|
|
|
226
224
|
|
|
227
|
-
|
|
228
225
|
<img
|
|
229
226
|
alt="Paul Smith & Associés Book"
|
|
230
227
|
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"
|
|
@@ -237,7 +234,6 @@ Rules will enforce specific behaviors or constraints on the AI's responses. This
|
|
|
237
234
|
Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
|
|
238
235
|
|
|
239
236
|
|
|
240
|
-
|
|
241
237
|
<img
|
|
242
238
|
alt="Paul Smith & Associés Book"
|
|
243
239
|
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"
|
|
@@ -248,7 +244,6 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
|
|
|
248
244
|
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.
|
|
249
245
|
|
|
250
246
|
|
|
251
|
-
|
|
252
247
|
<img
|
|
253
248
|
alt="Paul Smith & Associés Book"
|
|
254
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%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"
|
|
@@ -299,10 +294,14 @@ Now you want to use it. There are several ways how to write your first book:
|
|
|
299
294
|
|
|
300
295
|
We have written ai asistant in book who can help you with writing your first book.
|
|
301
296
|
|
|
297
|
+
|
|
298
|
+
|
|
302
299
|
#### Your AI twin
|
|
303
300
|
|
|
304
301
|
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.
|
|
305
302
|
|
|
303
|
+
|
|
304
|
+
|
|
306
305
|
#### AI persona workpool
|
|
307
306
|
|
|
308
307
|
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.
|
|
@@ -420,209 +419,7 @@ Join our growing community of developers and users:
|
|
|
420
419
|
|
|
421
420
|
|
|
422
421
|
|
|
423
|
-
## 📘 Book Language Blueprint
|
|
424
|
-
|
|
425
|
-
<blockquote style="color:#FFE600">
|
|
426
|
-
⚠ This file is a work in progress and may be incomplete or inaccurate.
|
|
427
|
-
</blockquote>
|
|
428
|
-
|
|
429
|
-
---
|
|
430
|
-
|
|
431
|
-
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.
|
|
432
|
-
|
|
433
|
-
Book is defined in file with `.book` extension
|
|
434
|
-
|
|
435
|
-
### Examples
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
<img
|
|
440
|
-
alt="Write an article about {topic} Book"
|
|
441
|
-
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"
|
|
442
|
-
/>
|
|
443
|
-
|
|
444
|
-
---
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
<img
|
|
449
|
-
alt="Make post on LinkedIn based on @Input. Book"
|
|
450
|
-
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"
|
|
451
|
-
/>
|
|
452
|
-
|
|
453
|
-
---
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
<img
|
|
458
|
-
alt="Odpověz na Email Book"
|
|
459
|
-
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"
|
|
460
|
-
/>
|
|
461
|
-
|
|
462
|
-
---
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
<img
|
|
467
|
-
alt="Analyzuj {Případ}. Book"
|
|
468
|
-
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"
|
|
469
|
-
/>
|
|
470
|
-
|
|
471
|
-
iframe:
|
|
472
|
-
|
|
473
|
-
<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>
|
|
474
|
-
|
|
475
|
-
books.svg
|
|
476
|
-
|
|
477
|
-

|
|
478
|
-
|
|
479
|
-
books.png
|
|
480
|
-
|
|
481
|
-

|
|
482
|
-
|
|
483
|
-
### Basic Commitments:
|
|
484
|
-
|
|
485
|
-
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.
|
|
486
|
-
|
|
487
|
-
#### `PERSONA`
|
|
488
|
-
|
|
489
|
-
defines basic contour of
|
|
490
|
-
|
|
491
|
-
> PERSONA @Joe Average man with
|
|
492
|
-
|
|
493
|
-
also the PERSONA is
|
|
494
|
-
|
|
495
|
-
Describes
|
|
496
|
-
|
|
497
|
-
#### `RULE` or `RULES`
|
|
498
|
-
|
|
499
|
-
defines
|
|
500
|
-
|
|
501
|
-
#### `STYLE`
|
|
502
|
-
|
|
503
|
-
xxx
|
|
504
422
|
|
|
505
|
-
#### `SAMPLE`
|
|
506
|
-
|
|
507
|
-
xxx
|
|
508
|
-
|
|
509
|
-
#### `KNOWLEDGE`
|
|
510
|
-
|
|
511
|
-
xxx
|
|
512
|
-
|
|
513
|
-
#### `EXPECT`
|
|
514
|
-
|
|
515
|
-
xxx
|
|
516
|
-
|
|
517
|
-
#### `FORMAT`
|
|
518
|
-
|
|
519
|
-
xxx
|
|
520
|
-
|
|
521
|
-
#### `JOKER`
|
|
522
|
-
|
|
523
|
-
xxx
|
|
524
|
-
|
|
525
|
-
#### `MODEL`
|
|
526
|
-
|
|
527
|
-
xxx
|
|
528
|
-
|
|
529
|
-
#### `ACTION`
|
|
530
|
-
|
|
531
|
-
xxx
|
|
532
|
-
|
|
533
|
-
#### `META`
|
|
534
|
-
|
|
535
|
-
### Names
|
|
536
|
-
|
|
537
|
-
each commitment is
|
|
538
|
-
|
|
539
|
-
`PERSONA`
|
|
540
|
-
|
|
541
|
-
Variable names
|
|
542
|
-
|
|
543
|
-
### Types
|
|
544
|
-
|
|
545
|
-
### Miscellaneous aspects of Book language
|
|
546
|
-
|
|
547
|
-
#### Named vs Anonymous commitments
|
|
548
|
-
|
|
549
|
-
#### Single line vs multiline
|
|
550
|
-
|
|
551
|
-
#### Bookish vs Non-bookish definitions
|
|
552
|
-
|
|
553
|
-
---
|
|
554
|
-
|
|
555
|
-
## **\_\_\_\_**
|
|
556
|
-
|
|
557
|
-
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.
|
|
558
|
-
|
|
559
|
-
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.
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
<img
|
|
564
|
-
alt="Franz Kafka Book"
|
|
565
|
-
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"
|
|
566
|
-
/>
|
|
567
|
-
|
|
568
|
-
## Who, what and how?
|
|
569
|
-
|
|
570
|
-
To write a good prompt and the book you will be answering 3 main questions
|
|
571
|
-
|
|
572
|
-
- **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?
|
|
573
|
-
You rather want `Paul, an typescript developer who prefers SOLID code` not `gemini-2`
|
|
574
|
-
- **What**
|
|
575
|
-
- **How**
|
|
576
|
-
|
|
577
|
-
each commitment (described bellow) is connected with one of theese 3 questions.
|
|
578
|
-
|
|
579
|
-
### Commitments
|
|
580
|
-
|
|
581
|
-
Commitment is one piece of book, you can imagine it as one paragraph of book.
|
|
582
|
-
|
|
583
|
-
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.
|
|
584
|
-
|
|
585
|
-
Commitments are chained one after another, in general commitments which are written later are more important and redefines things defined earlier.
|
|
586
|
-
|
|
587
|
-
Each commitment falls into one or more of cathegory who, what or how
|
|
588
|
-
|
|
589
|
-
Here are some basic commintemts:
|
|
590
|
-
|
|
591
|
-
- `PERSONA` tells **who** is working on the task
|
|
592
|
-
- `KNOWLEDGE` describes **what** knowledge the person has
|
|
593
|
-
- `GOAL` describes **what** is the goal of the task
|
|
594
|
-
- `ACTION` describes **what** actions can be done
|
|
595
|
-
- `RULE` describes **what** rules should be followed
|
|
596
|
-
- `STYLE` describes **how** the output should be presented
|
|
597
|
-
|
|
598
|
-
### Variables and references
|
|
599
|
-
|
|
600
|
-
When the prompt should be to be useful it should have some fixed static part and some variable dynamic part
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
<img
|
|
605
|
-
alt="Untitled Book"
|
|
606
|
-
src="https://promptbook.studio/embed/book-preview.png?book=&width=800&height=450&nonce=0"
|
|
607
|
-
/>
|
|
608
|
-
|
|
609
|
-
### Imports
|
|
610
|
-
|
|
611
|
-
### Layering
|
|
612
|
-
|
|
613
|
-
### Book defined in book
|
|
614
|
-
|
|
615
|
-
###
|
|
616
|
-
|
|
617
|
-
Book vs:
|
|
618
|
-
|
|
619
|
-
- Why just dont pick the right model
|
|
620
|
-
- Orchestration frameworks - Langchain, Google Agent ..., Semantic Kernel,...
|
|
621
|
-
- Finetunning
|
|
622
|
-
- Temperature, top_t, top_k,... etc.
|
|
623
|
-
- System message
|
|
624
|
-
- MCP server
|
|
625
|
-
- function calling
|
|
626
423
|
|
|
627
424
|
|
|
628
425
|
|
|
@@ -702,6 +499,8 @@ The following glossary is used to clarify certain concepts:
|
|
|
702
499
|
|
|
703
500
|
_Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
704
501
|
|
|
502
|
+
|
|
503
|
+
|
|
705
504
|
### 💯 Core concepts
|
|
706
505
|
|
|
707
506
|
- [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|