@promptbook/markdown-utils 0.105.0-3 → 0.105.0-4

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
@@ -144,19 +144,20 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
144
144
 
145
145
  ## 📖 The Book Whitepaper
146
146
 
147
- For most business applications nowadays, the biggest challenge isn't about the raw capabilities of AI models. Large language models like GPT-5 or Claude-4.1 are extremely capable.
147
+ Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as GPT-5.2 and Claude-4.5 are incredibly capable.
148
148
 
149
- The main challenge is to narrow it down, constrain it, set the proper **context, rules, knowledge, and personality**. There are a lot of tools which can do exactly this. On one side, there are no-code platforms which can launch your agent in seconds. On the other side, there are heavy frameworks like Langchain or Semantic Kernel, which can give you deep control.
149
+ The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
150
150
 
151
- 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.
151
+ In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
152
152
 
153
153
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
154
154
 
155
- **<ins>Paul Smith & Associés</ins>**<br/>
155
+ **<ins>Paul Smith</ins>**<br/>
156
156
  <br/>
157
157
  **PERSONA** You are a company lawyer.<br/>
158
158
  Your job is to provide legal advice and support to the company and its employees.<br/>
159
- You are knowledgeable, professional, and detail-oriented.<br/>
159
+ **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
160
+ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
160
161
 
161
162
  </td></tr></table>
162
163
 
@@ -166,7 +167,9 @@ You are knowledgeable, professional, and detail-oriented.<br/>
166
167
 
167
168
  We have created a language called **Book**, which allows you to write AI agents in their native language and create your own AI persona. Book provides a guide to define all the traits and commitments.
168
169
 
169
- You can look at it as prompting (or writing a system message), but decorated by **commitments**.
170
+ You can look at it as "prompting" _(or writing a system message)_, but decorated by **commitments**.
171
+
172
+ **Commitments** are special syntax elements that define contracts between you and the AI agent. They are transformed by Promptbook Engine into low-level parameters like which model to use, its temperature, system message, RAG index, MCP servers, and many other parameters. For some commitments _(for example `RULE` commitment)_ Promptbook Engine can even create adversary agents and extra checks to enforce the rules.
170
173
 
171
174
  #### `Persona` commitment
172
175
 
@@ -177,8 +180,6 @@ Personas define the character of your AI persona, its role, and how it should in
177
180
  **<ins>Paul Smith & Associés</ins>**<br/>
178
181
  <br/>
179
182
  **PERSONA** You are a company lawyer.<br/>
180
- Your job is to provide legal advice and support to the company and its employees.<br/>
181
- You are knowledgeable, professional, and detail-oriented.<br/>
182
183
 
183
184
  </td></tr></table>
184
185
 
@@ -198,7 +199,7 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
198
199
  Your job is to provide legal advice and support to the company and its employees.<br/>
199
200
  You are knowledgeable, professional, and detail-oriented.<br/>
200
201
  <br/>
201
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
202
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
202
203
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
203
204
 
204
205
  </td></tr></table>
@@ -220,14 +221,14 @@ You are knowledgeable, professional, and detail-oriented.<br/>
220
221
  **RULE** Always ensure compliance with laws and regulations.<br/>
221
222
  **RULE** Never provide legal advice outside your area of expertise.<br/>
222
223
  **RULE** Never provide legal advice about criminal law.<br/>
223
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
224
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
224
225
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
225
226
 
226
227
  </td></tr></table>
227
228
 
228
- #### `Action` commitment
229
+ #### `Team` commitment
229
230
 
230
- 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.
231
+ Team commitment allows you to define the team structure and advisory fellow members the AI can consult with. This allows the AI to simulate collaboration and consultation with other experts, enhancing the quality of its responses.
231
232
 
232
233
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
233
234
 
@@ -240,81 +241,36 @@ You are knowledgeable, professional, and detail-oriented.<br/>
240
241
  **RULE** Always ensure compliance with laws and regulations.<br/>
241
242
  **RULE** Never provide legal advice outside your area of expertise.<br/>
242
243
  **RULE** Never provide legal advice about criminal law.<br/>
243
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
244
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
244
245
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
245
- **ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
246
+ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
246
247
 
247
248
  </td></tr></table>
248
249
 
249
- [Read more about the language](./BLUEPRINT.md)
250
-
251
- <div style="page-break-after: always;"></div>
252
-
253
- ### Where to use your AI agent in book
254
-
255
- Books can be useful in various applications and scenarios. Here are some examples:
256
-
257
- #### Chat apps:
258
250
 
259
- Create your own chat shopping assistant and place it in your eShop.
260
- You will be able to answer customer questions, help them find products, and provide personalized recommendations. Everything is tightly controlled by the book you have written.
261
251
 
262
- #### Reply Agent:
252
+ ### Promptbook Ecosystem
263
253
 
264
- Create your own AI agent, which will look at your emails and reply to them. It can even create drafts for you to review before sending.
254
+ !!!@@@
265
255
 
266
- #### Coding Agent:
267
-
268
- Do you love Vibecoding, but the AI code is not always aligned with your coding style and architecture, rules, security, etc.? Create your own coding agent to help enforce your specific coding standards and practices.
269
-
270
- This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
271
-
272
- They will work the same as you are used to, but with your specific rules written in book.
273
-
274
- #### Internal Expertise
275
-
276
- Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
277
-
278
- You can avoid struggle with choosing the best model, its settings like temperature, max tokens, etc., by writing a book agent and using it as your AI expertise.
279
-
280
- Doesn't matter if you do automations, data analysis, customer support, sentiment analysis, classification, or any other task. Your AI agent will be tailored to your specific needs and requirements.
281
-
282
- Even works in no-code platforms!
283
-
284
- <div style="page-break-after: always;"></div>
256
+ #### Promptbook Server
285
257
 
286
- ### How to create your AI agent in book
258
+ !!!@@@
287
259
 
288
- Now you want to use it. There are several ways how to write your first book:
260
+ #### Promptbook Engine
289
261
 
290
- #### From scratch with help from Paul
262
+ !!!@@@
291
263
 
292
- We have written ai asistant in book who can help you with writing your first book.
293
264
 
294
- #### Your AI twin
295
265
 
296
- 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.
297
266
 
298
- #### AI persona workpool
299
267
 
300
- 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.
301
268
 
302
269
 
303
270
 
304
271
 
305
272
 
306
273
 
307
- ## 🚀 Get started
308
-
309
- Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
310
-
311
- - [Hello Book](https://github.com/webgptorg/hello-world)
312
- - [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
313
- - [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
314
-
315
-
316
-
317
-
318
274
 
319
275
 
320
276
  ## 💜 The Promptbook Project
@@ -330,33 +286,32 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
330
286
  </thead>
331
287
  <tbody>
332
288
  <tr>
333
- <td><a href="https://github.com/webgptorg/book">Book language</a></td>
289
+ <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
334
290
  <td>
335
- Book is a human-understandable markup language for writing AI applications such as chatbots, knowledge bases, agents, avarars, translators, automations and more.
336
- <hr>
337
- There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
291
+ Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
338
292
  </td>
339
293
  </tr>
340
294
  <tr>
341
- <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
295
+ <td><a href="https://github.com/webgptorg/book">Book language</a></td>
342
296
  <td>
343
- Promptbook engine can run applications written in Book language. It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Docker HUB</a>
297
+ Human-friendly, high-level language that abstracts away low-level details of AI. It allows to focus on personality, behavior, knowledge, and rules of AI agents rather than on models, parameters, and prompt engineering.
298
+ <hr>
299
+ There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
344
300
  </td>
345
301
  </tr>
346
302
  <tr>
347
- <td><a href="https://promptbook.studio">Promptbook Studio</a></td>
303
+ <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
348
304
  <td>
349
- Promptbook.studio is a web-based editor and runner for book applications. It is still in the experimental MVP stage.
305
+ Promptbook engine can run AI agents based on Book language.
306
+ It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Promptbook Agent Server as Docker Package</a>
307
+ Agent Server is based on Promptbook Engine.
350
308
  </td>
351
309
  </tr>
310
+
352
311
  </tbody>
353
312
  </table>
354
313
 
355
- Hello world examples:
356
314
 
357
- - [Hello world](https://github.com/webgptorg/hello-world)
358
- - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
359
- - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
360
315
 
361
316
  ### 🌐 Community & Social Media
362
317
 
@@ -414,6 +369,8 @@ Join our growing community of developers and users:
414
369
 
415
370
 
416
371
 
372
+
373
+
417
374
  ## 📚 Documentation
418
375
 
419
376
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -490,6 +447,8 @@ The following glossary is used to clarify certain concepts:
490
447
 
491
448
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
492
449
 
450
+
451
+
493
452
  ### 💯 Core concepts
494
453
 
495
454
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
package/esm/index.es.js CHANGED
@@ -23,7 +23,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.105.0-3';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.105.0-4';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -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.105.0-2`).
18
+ * It follows semantic versioning (e.g., `0.105.0-3`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/markdown-utils",
3
- "version": "0.105.0-3",
3
+ "version": "0.105.0-4",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -24,7 +24,7 @@
24
24
  * @generated
25
25
  * @see https://github.com/webgptorg/promptbook
26
26
  */
27
- const PROMPTBOOK_ENGINE_VERSION = '0.105.0-3';
27
+ const PROMPTBOOK_ENGINE_VERSION = '0.105.0-4';
28
28
  /**
29
29
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
30
30
  * Note: [💞] Ignore a discrepancy between file name and entity name