@promptbook/browser 0.103.0-3 → 0.103.0-7

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
@@ -111,7 +111,6 @@ The main challenge is to narrow it down, constrain it, set the proper **context,
111
111
  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.
112
112
 
113
113
 
114
-
115
114
  <img
116
115
  alt="Paul Smith & Associés Book"
117
116
  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"
@@ -130,7 +129,6 @@ You can look at it as prompting (or writing a system message), but decorated by
130
129
  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.
131
130
 
132
131
 
133
-
134
132
  <img
135
133
  alt="Paul Smith & Associés Book"
136
134
  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"
@@ -145,7 +143,6 @@ This can include domain-specific knowledge, company policies, or any other relev
145
143
  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.
146
144
 
147
145
 
148
-
149
146
  <img
150
147
  alt="Paul Smith & Associés Book"
151
148
  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"
@@ -158,7 +155,6 @@ Rules will enforce specific behaviors or constraints on the AI's responses. This
158
155
  Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
159
156
 
160
157
 
161
-
162
158
  <img
163
159
  alt="Paul Smith & Associés Book"
164
160
  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"
@@ -169,7 +165,6 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
169
165
  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.
170
166
 
171
167
 
172
-
173
168
  <img
174
169
  alt="Paul Smith & Associés Book"
175
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%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"
@@ -220,10 +215,14 @@ Now you want to use it. There are several ways how to write your first book:
220
215
 
221
216
  We have written ai asistant in book who can help you with writing your first book.
222
217
 
218
+
219
+
223
220
  #### Your AI twin
224
221
 
225
222
  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.
226
223
 
224
+
225
+
227
226
  #### AI persona workpool
228
227
 
229
228
  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.
@@ -341,209 +340,7 @@ Join our growing community of developers and users:
341
340
 
342
341
 
343
342
 
344
- ## 📘 Book Language Blueprint
345
-
346
- <blockquote style="color:#FFE600">
347
- ⚠ This file is a work in progress and may be incomplete or inaccurate.
348
- </blockquote>
349
-
350
- ---
351
-
352
- 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.
353
-
354
- Book is defined in file with `.book` extension
355
-
356
- ### Examples
357
-
358
-
359
-
360
- <img
361
- alt="Write an article about {topic} Book"
362
- 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"
363
- />
364
-
365
- ---
366
-
367
-
368
-
369
- <img
370
- alt="Make post on LinkedIn based on @Input. Book"
371
- 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"
372
- />
373
-
374
- ---
375
-
376
-
377
-
378
- <img
379
- alt="Odpověz na Email Book"
380
- 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"
381
- />
382
-
383
- ---
384
-
385
-
386
-
387
- <img
388
- alt="Analyzuj {Případ}. Book"
389
- 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"
390
- />
391
-
392
- iframe:
393
-
394
- <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>
395
-
396
- books.svg
397
-
398
- ![Books](./books/diagram/books.svg)
399
-
400
- books.png
401
-
402
- ![Books](./books/diagram/books.png)
403
-
404
- ### Basic Commitments:
405
-
406
- 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.
407
-
408
- #### `PERSONA`
409
-
410
- defines basic contour of
411
-
412
- > PERSONA @Joe Average man with
413
-
414
- also the PERSONA is
415
-
416
- Describes
417
-
418
- #### `RULE` or `RULES`
419
-
420
- defines
421
-
422
- #### `STYLE`
423
-
424
- xxx
425
343
 
426
- #### `SAMPLE`
427
-
428
- xxx
429
-
430
- #### `KNOWLEDGE`
431
-
432
- xxx
433
-
434
- #### `EXPECT`
435
-
436
- xxx
437
-
438
- #### `FORMAT`
439
-
440
- xxx
441
-
442
- #### `JOKER`
443
-
444
- xxx
445
-
446
- #### `MODEL`
447
-
448
- xxx
449
-
450
- #### `ACTION`
451
-
452
- xxx
453
-
454
- #### `META`
455
-
456
- ### Names
457
-
458
- each commitment is
459
-
460
- `PERSONA`
461
-
462
- Variable names
463
-
464
- ### Types
465
-
466
- ### Miscellaneous aspects of Book language
467
-
468
- #### Named vs Anonymous commitments
469
-
470
- #### Single line vs multiline
471
-
472
- #### Bookish vs Non-bookish definitions
473
-
474
- ---
475
-
476
- ## **\_\_\_\_**
477
-
478
- 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.
479
-
480
- 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.
481
-
482
-
483
-
484
- <img
485
- alt="Franz Kafka Book"
486
- 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"
487
- />
488
-
489
- ## Who, what and how?
490
-
491
- To write a good prompt and the book you will be answering 3 main questions
492
-
493
- - **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?
494
- You rather want `Paul, an typescript developer who prefers SOLID code` not `gemini-2`
495
- - **What**
496
- - **How**
497
-
498
- each commitment (described bellow) is connected with one of theese 3 questions.
499
-
500
- ### Commitments
501
-
502
- Commitment is one piece of book, you can imagine it as one paragraph of book.
503
-
504
- 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.
505
-
506
- Commitments are chained one after another, in general commitments which are written later are more important and redefines things defined earlier.
507
-
508
- Each commitment falls into one or more of cathegory who, what or how
509
-
510
- Here are some basic commintemts:
511
-
512
- - `PERSONA` tells **who** is working on the task
513
- - `KNOWLEDGE` describes **what** knowledge the person has
514
- - `GOAL` describes **what** is the goal of the task
515
- - `ACTION` describes **what** actions can be done
516
- - `RULE` describes **what** rules should be followed
517
- - `STYLE` describes **how** the output should be presented
518
-
519
- ### Variables and references
520
-
521
- When the prompt should be to be useful it should have some fixed static part and some variable dynamic part
522
-
523
-
524
-
525
- <img
526
- alt="Untitled Book"
527
- src="https://promptbook.studio/embed/book-preview.png?book=&width=800&height=450&nonce=0"
528
- />
529
-
530
- ### Imports
531
-
532
- ### Layering
533
-
534
- ### Book defined in book
535
-
536
- ###
537
-
538
- Book vs:
539
-
540
- - Why just dont pick the right model
541
- - Orchestration frameworks - Langchain, Google Agent ..., Semantic Kernel,...
542
- - Finetunning
543
- - Temperature, top_t, top_k,... etc.
544
- - System message
545
- - MCP server
546
- - function calling
547
344
 
548
345
 
549
346
 
@@ -623,6 +420,8 @@ The following glossary is used to clarify certain concepts:
623
420
 
624
421
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
625
422
 
423
+
424
+
626
425
  ### 💯 Core concepts
627
426
 
628
427
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
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-3';
19
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-7';
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
@@ -4,3 +4,6 @@ import type { BookEditorProps } from './BookEditor';
4
4
  * @private util of `<BookEditor />`
5
5
  */
6
6
  export declare function BookEditorWrapper(props: BookEditorProps): import("react").ReactPortal;
7
+ /**
8
+ * TODO: !!! Maybe remove
9
+ */
@@ -8,3 +8,6 @@ export declare function Modal({ children, onClose, className, }: {
8
8
  onClose: () => void;
9
9
  className?: string;
10
10
  }): import("react").ReactPortal;
11
+ /**
12
+ * TODO: !!!! Use this also for feedback modal in Chat component -Make modals DRY
13
+ */
@@ -4,4 +4,4 @@ import type { string_css_class } from '../../../types/typeAliases';
4
4
  *
5
5
  * @private within the `@promptbook/components`
6
6
  */
7
- export declare function classNames(...classes: Array<string_css_class | undefined | false | null>): string_css_class;
7
+ export declare function classNames(...classes: Array<string_css_class | undefined | false | null | 0>): string_css_class;
@@ -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.103.0-2`).
18
+ * It follows semantic versioning (e.g., `0.103.0-6`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/browser",
3
- "version": "0.103.0-3",
3
+ "version": "0.103.0-7",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -94,7 +94,7 @@
94
94
  "module": "./esm/index.es.js",
95
95
  "typings": "./esm/typings/src/_packages/browser.index.d.ts",
96
96
  "peerDependencies": {
97
- "@promptbook/core": "0.103.0-3"
97
+ "@promptbook/core": "0.103.0-7"
98
98
  },
99
99
  "dependencies": {
100
100
  "crypto": "1.0.1",
package/umd/index.umd.js CHANGED
@@ -22,7 +22,7 @@
22
22
  * @generated
23
23
  * @see https://github.com/webgptorg/promptbook
24
24
  */
25
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-3';
25
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-7';
26
26
  /**
27
27
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
28
28
  * Note: [💞] Ignore a discrepancy between file name and entity name