@promptbook/utils 0.103.0-34 → 0.103.0-35

package/README.md

@@ -371,11 +371,15 @@ The main challenge is to narrow it down, constrain it, set the proper **context,
 
 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.
 
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
 
-<img
-    alt="Paul Smith & Associés Book"
-    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"
-/>
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
+
+</td></tr></table>
 
 <div style="page-break-after: always;"></div>
 
@@ -389,11 +393,15 @@ You can look at it as prompting (or writing a system message), but decorated by
 
 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.
 
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
 
-<img
-    alt="Paul Smith & Associés Book"
-    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"
-/>
+</td></tr></table>
 
 #### `Knowledge` commitment
 
@@ -403,11 +411,18 @@ This can include domain-specific knowledge, company policies, or any other relev
 
 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.
 
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
+<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
 
-<img
-    alt="Paul Smith & Associés Book"
-    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"
-/>
+</td></tr></table>
 
 #### `Rule` commitment
 
@@ -415,21 +430,42 @@ Rules will enforce specific behaviors or constraints on the AI's responses. This
 
 Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
 
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
 
-<img
-    alt="Paul Smith & Associés Book"
-    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"
-/>
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
+<br/>
+**RULE** Always ensure compliance with laws and regulations.<br/>
+**RULE** Never provide legal advice outside your area of expertise.<br/>
+**RULE** Never provide legal advice about criminal law.<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
+
+</td></tr></table>
 
 #### `Action` commitment
 
 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.
 
-
-<img
-    alt="Paul Smith & Associés Book"
-    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"
-/>
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
+<br/>
+**RULE** Always ensure compliance with laws and regulations.<br/>
+**RULE** Never provide legal advice outside your area of expertise.<br/>
+**RULE** Never provide legal advice about criminal law.<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
+**ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
+
+</td></tr></table>
 
 [Read more about the language](./BLUEPRINT.md)
 

package/esm/index.es.js

@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-34';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-35';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/cli.index.d.ts

@@ -30,7 +30,8 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
-import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai/register';
+import { _FormattedBookInMarkdownTranspilerRegistration } from '../transpilers/formatted-book-in-markdown/register';
+import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai-sdk/register';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { _CLI };
 export { _AnthropicClaudeMetadataRegistration };
@@ -63,4 +64,5 @@ export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };
 export { _WebsiteScraperMetadataRegistration };
+export { _FormattedBookInMarkdownTranspilerRegistration };
 export { _OpenAiSdkTranspilerRegistration };

package/esm/typings/src/_packages/core.index.d.ts

@@ -172,7 +172,8 @@ import { BlackholeStorage } from '../storage/blackhole/BlackholeStorage';
 import { MemoryStorage } from '../storage/memory/MemoryStorage';
 import { PrefixStorage } from '../storage/utils/PrefixStorage';
 import { $bookTranspilersRegister } from '../transpilers/_common/register/$bookTranspilersRegister';
-import { OpenAiSdkTranspiler } from '../transpilers/openai/OpenAiSdkTranspiler';
+import { FormattedBookInMarkdownTranspiler } from '../transpilers/formatted-book-in-markdown/FormattedBookInMarkdownTranspiler';
+import { OpenAiSdkTranspiler } from '../transpilers/openai-sdk/OpenAiSdkTranspiler';
 import { MODEL_VARIANTS } from '../types/ModelVariant';
 import { NonTaskSectionTypes } from '../types/SectionType';
 import { SectionTypes } from '../types/SectionType';
@@ -353,6 +354,7 @@ export { BlackholeStorage };
 export { MemoryStorage };
 export { PrefixStorage };
 export { $bookTranspilersRegister };
+export { FormattedBookInMarkdownTranspiler };
 export { OpenAiSdkTranspiler };
 export { MODEL_VARIANTS };
 export { NonTaskSectionTypes };

package/esm/typings/src/_packages/wizard.index.d.ts

@@ -29,7 +29,8 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
-import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai/register';
+import { _FormattedBookInMarkdownTranspilerRegistration } from '../transpilers/formatted-book-in-markdown/register';
+import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai-sdk/register';
 import { wizard } from '../wizard/wizard';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { _AnthropicClaudeMetadataRegistration };
@@ -62,5 +63,6 @@ export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };
 export { _WebsiteScraperMetadataRegistration };
+export { _FormattedBookInMarkdownTranspilerRegistration };
 export { _OpenAiSdkTranspilerRegistration };
 export { wizard };

package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts

@@ -1,3 +1,4 @@
+import { Promisable } from 'type-fest';
 import { BookTranspilerOptions, ExecutionTools, Registered, string_book, string_name, string_script, string_title } from '../../_packages/types.index';
 /**
  * Transpiler takes a book and transpiles it into another format (e.g., Langchain).
@@ -24,5 +25,5 @@ export type BookTranspiler = Registered & {
      * @param options additional options for the transpiler
      * @returns transpiled book
      */
-    transpileBook(book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions): Promise<string_script>;
+    transpileBook(book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions): Promisable<string_script>;
 };

package/esm/typings/src/transpilers/formatted-book-in-markdown/FormattedBookInMarkdownTranspiler.d.ts

@@ -0,0 +1,13 @@
+import { BookTranspilerOptions, ExecutionTools, string_book, string_markdown } from '../../_packages/types.index';
+/**
+ * Converts a book into a 1:1 formatted markdown
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const FormattedBookInMarkdownTranspiler: {
+    readonly name: "formatted-book-in-markdown";
+    readonly title: "Formatted Book in Markdown";
+    readonly packageName: "@promptbook/core";
+    readonly className: "FormattedBookInMarkdownTranspiler";
+    readonly transpileBook: (book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions) => string_markdown;
+};

package/esm/typings/src/transpilers/formatted-book-in-markdown/register.d.ts

@@ -0,0 +1,15 @@
+import { Registration } from '../../_packages/types.index';
+/**
+ * Registration of transpiler
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ *
+ * TODO: !!!! Which package should export this?
+ */
+export declare const _FormattedBookInMarkdownTranspilerRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/transpilers/{openai → openai-sdk}/register.d.ts

@@ -1,6 +1,6 @@
 import { Registration } from '../../_packages/types.index';
 /**
- * Registration of LLM provider
+ * Registration of transpiler
  *
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.103.0-33`).
+ * It follows semantic versioning (e.g., `0.103.0-34`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.103.0-34",
+    "version": "0.103.0-35",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-34';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-35';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name