@promptbook/documents 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
@@ -61,19 +61,20 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
61
61
 
62
62
  ## 📖 The Book Whitepaper
63
63
 
64
- 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.
64
+ 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.
65
65
 
66
- 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.
66
+ The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
67
67
 
68
- 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.
68
+ In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
69
69
 
70
70
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
71
71
 
72
- **<ins>Paul Smith & Associés</ins>**<br/>
72
+ **<ins>Paul Smith</ins>**<br/>
73
73
  <br/>
74
74
  **PERSONA** You are a company lawyer.<br/>
75
75
  Your job is to provide legal advice and support to the company and its employees.<br/>
76
- You are knowledgeable, professional, and detail-oriented.<br/>
76
+ **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
77
+ 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/>
77
78
 
78
79
  </td></tr></table>
79
80
 
@@ -83,7 +84,9 @@ You are knowledgeable, professional, and detail-oriented.<br/>
83
84
 
84
85
  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.
85
86
 
86
- You can look at it as prompting (or writing a system message), but decorated by **commitments**.
87
+ You can look at it as "prompting" _(or writing a system message)_, but decorated by **commitments**.
88
+
89
+ **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.
87
90
 
88
91
  #### `Persona` commitment
89
92
 
@@ -94,8 +97,6 @@ Personas define the character of your AI persona, its role, and how it should in
94
97
  **<ins>Paul Smith & Associés</ins>**<br/>
95
98
  <br/>
96
99
  **PERSONA** You are a company lawyer.<br/>
97
- Your job is to provide legal advice and support to the company and its employees.<br/>
98
- You are knowledgeable, professional, and detail-oriented.<br/>
99
100
 
100
101
  </td></tr></table>
101
102
 
@@ -115,7 +116,7 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
115
116
  Your job is to provide legal advice and support to the company and its employees.<br/>
116
117
  You are knowledgeable, professional, and detail-oriented.<br/>
117
118
  <br/>
118
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
119
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
119
120
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
120
121
 
121
122
  </td></tr></table>
@@ -137,14 +138,14 @@ You are knowledgeable, professional, and detail-oriented.<br/>
137
138
  **RULE** Always ensure compliance with laws and regulations.<br/>
138
139
  **RULE** Never provide legal advice outside your area of expertise.<br/>
139
140
  **RULE** Never provide legal advice about criminal law.<br/>
140
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
141
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
141
142
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
142
143
 
143
144
  </td></tr></table>
144
145
 
145
- #### `Action` commitment
146
+ #### `Team` commitment
146
147
 
147
- 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.
148
+ 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.
148
149
 
149
150
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
150
151
 
@@ -157,81 +158,36 @@ You are knowledgeable, professional, and detail-oriented.<br/>
157
158
  **RULE** Always ensure compliance with laws and regulations.<br/>
158
159
  **RULE** Never provide legal advice outside your area of expertise.<br/>
159
160
  **RULE** Never provide legal advice about criminal law.<br/>
160
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
161
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
161
162
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
162
- **ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
163
+ 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/>
163
164
 
164
165
  </td></tr></table>
165
166
 
166
- [Read more about the language](./BLUEPRINT.md)
167
-
168
- <div style="page-break-after: always;"></div>
169
-
170
- ### Where to use your AI agent in book
171
-
172
- Books can be useful in various applications and scenarios. Here are some examples:
173
-
174
- #### Chat apps:
175
167
 
176
- Create your own chat shopping assistant and place it in your eShop.
177
- 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.
178
168
 
179
- #### Reply Agent:
169
+ ### Promptbook Ecosystem
180
170
 
181
- 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.
171
+ !!!@@@
182
172
 
183
- #### Coding Agent:
184
-
185
- 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.
186
-
187
- This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
188
-
189
- They will work the same as you are used to, but with your specific rules written in book.
190
-
191
- #### Internal Expertise
192
-
193
- Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
194
-
195
- 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.
196
-
197
- 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.
198
-
199
- Even works in no-code platforms!
200
-
201
- <div style="page-break-after: always;"></div>
173
+ #### Promptbook Server
202
174
 
203
- ### How to create your AI agent in book
175
+ !!!@@@
204
176
 
205
- Now you want to use it. There are several ways how to write your first book:
177
+ #### Promptbook Engine
206
178
 
207
- #### From scratch with help from Paul
179
+ !!!@@@
208
180
 
209
- We have written ai asistant in book who can help you with writing your first book.
210
181
 
211
- #### Your AI twin
212
182
 
213
- 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.
214
183
 
215
- #### AI persona workpool
216
184
 
217
- 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.
218
185
 
219
186
 
220
187
 
221
188
 
222
189
 
223
190
 
224
- ## 🚀 Get started
225
-
226
- Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
227
-
228
- - [Hello Book](https://github.com/webgptorg/hello-world)
229
- - [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
230
- - [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
231
-
232
-
233
-
234
-
235
191
 
236
192
 
237
193
  ## 💜 The Promptbook Project
@@ -247,33 +203,32 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
247
203
  </thead>
248
204
  <tbody>
249
205
  <tr>
250
- <td><a href="https://github.com/webgptorg/book">Book language</a></td>
206
+ <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
251
207
  <td>
252
- Book is a human-understandable markup language for writing AI applications such as chatbots, knowledge bases, agents, avarars, translators, automations and more.
253
- <hr>
254
- There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
208
+ Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
255
209
  </td>
256
210
  </tr>
257
211
  <tr>
258
- <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
212
+ <td><a href="https://github.com/webgptorg/book">Book language</a></td>
259
213
  <td>
260
- 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>
214
+ 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.
215
+ <hr>
216
+ There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
261
217
  </td>
262
218
  </tr>
263
219
  <tr>
264
- <td><a href="https://promptbook.studio">Promptbook Studio</a></td>
220
+ <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
265
221
  <td>
266
- Promptbook.studio is a web-based editor and runner for book applications. It is still in the experimental MVP stage.
222
+ Promptbook engine can run AI agents based on Book language.
223
+ 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>
224
+ Agent Server is based on Promptbook Engine.
267
225
  </td>
268
226
  </tr>
227
+
269
228
  </tbody>
270
229
  </table>
271
230
 
272
- Hello world examples:
273
231
 
274
- - [Hello world](https://github.com/webgptorg/hello-world)
275
- - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
276
- - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
277
232
 
278
233
  ### 🌐 Community & Social Media
279
234
 
@@ -331,6 +286,8 @@ Join our growing community of developers and users:
331
286
 
332
287
 
333
288
 
289
+
290
+
334
291
  ## 📚 Documentation
335
292
 
336
293
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -407,6 +364,8 @@ The following glossary is used to clarify certain concepts:
407
364
 
408
365
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
409
366
 
367
+
368
+
410
369
  ### 💯 Core concepts
411
370
 
412
371
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
package/esm/index.es.js CHANGED
@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
26
26
  * @generated
27
27
  * @see https://github.com/webgptorg/promptbook
28
28
  */
29
- const PROMPTBOOK_ENGINE_VERSION = '0.105.0-3';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.105.0-4';
30
30
  /**
31
31
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
32
32
  * 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/documents",
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,
@@ -95,7 +95,7 @@
95
95
  "module": "./esm/index.es.js",
96
96
  "typings": "./esm/typings/src/_packages/documents.index.d.ts",
97
97
  "peerDependencies": {
98
- "@promptbook/core": "0.105.0-3"
98
+ "@promptbook/core": "0.105.0-4"
99
99
  },
100
100
  "dependencies": {
101
101
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.105.0-3';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.105.0-4';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name