promptbook 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.
Files changed (2) hide show
  1. package/README.md +36 -77
  2. package/package.json +30 -30
package/README.md CHANGED
@@ -34,19 +34,20 @@ Turn your company's scattered knowledge into AI ready Books
34
34
 
35
35
  ## 📖 The Book Whitepaper
36
36
 
37
- 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.
37
+ 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.
38
38
 
39
- 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.
39
+ The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
40
40
 
41
- 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.
41
+ In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
42
42
 
43
43
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
44
44
 
45
- **<ins>Paul Smith & Associés</ins>**<br/>
45
+ **<ins>Paul Smith</ins>**<br/>
46
46
  <br/>
47
47
  **PERSONA** You are a company lawyer.<br/>
48
48
  Your job is to provide legal advice and support to the company and its employees.<br/>
49
- You are knowledgeable, professional, and detail-oriented.<br/>
49
+ **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
50
+ 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/>
50
51
 
51
52
  </td></tr></table>
52
53
 
@@ -56,7 +57,9 @@ You are knowledgeable, professional, and detail-oriented.<br/>
56
57
 
57
58
  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.
58
59
 
59
- You can look at it as prompting (or writing a system message), but decorated by **commitments**.
60
+ You can look at it as "prompting" _(or writing a system message)_, but decorated by **commitments**.
61
+
62
+ **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.
60
63
 
61
64
  #### `Persona` commitment
62
65
 
@@ -67,8 +70,6 @@ Personas define the character of your AI persona, its role, and how it should in
67
70
  **<ins>Paul Smith & Associés</ins>**<br/>
68
71
  <br/>
69
72
  **PERSONA** You are a company lawyer.<br/>
70
- Your job is to provide legal advice and support to the company and its employees.<br/>
71
- You are knowledgeable, professional, and detail-oriented.<br/>
72
73
 
73
74
  </td></tr></table>
74
75
 
@@ -88,7 +89,7 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
88
89
  Your job is to provide legal advice and support to the company and its employees.<br/>
89
90
  You are knowledgeable, professional, and detail-oriented.<br/>
90
91
  <br/>
91
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
92
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
92
93
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
93
94
 
94
95
  </td></tr></table>
@@ -110,14 +111,14 @@ You are knowledgeable, professional, and detail-oriented.<br/>
110
111
  **RULE** Always ensure compliance with laws and regulations.<br/>
111
112
  **RULE** Never provide legal advice outside your area of expertise.<br/>
112
113
  **RULE** Never provide legal advice about criminal law.<br/>
113
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
114
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
114
115
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
115
116
 
116
117
  </td></tr></table>
117
118
 
118
- #### `Action` commitment
119
+ #### `Team` commitment
119
120
 
120
- 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.
121
+ 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.
121
122
 
122
123
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
123
124
 
@@ -130,81 +131,36 @@ You are knowledgeable, professional, and detail-oriented.<br/>
130
131
  **RULE** Always ensure compliance with laws and regulations.<br/>
131
132
  **RULE** Never provide legal advice outside your area of expertise.<br/>
132
133
  **RULE** Never provide legal advice about criminal law.<br/>
133
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
134
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
134
135
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
135
- **ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
136
+ 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/>
136
137
 
137
138
  </td></tr></table>
138
139
 
139
- [Read more about the language](./BLUEPRINT.md)
140
-
141
- <div style="page-break-after: always;"></div>
142
-
143
- ### Where to use your AI agent in book
144
-
145
- Books can be useful in various applications and scenarios. Here are some examples:
146
-
147
- #### Chat apps:
148
140
 
149
- Create your own chat shopping assistant and place it in your eShop.
150
- 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.
151
141
 
152
- #### Reply Agent:
142
+ ### Promptbook Ecosystem
153
143
 
154
- 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.
144
+ !!!@@@
155
145
 
156
- #### Coding Agent:
157
-
158
- 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.
159
-
160
- This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
161
-
162
- They will work the same as you are used to, but with your specific rules written in book.
163
-
164
- #### Internal Expertise
165
-
166
- Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
167
-
168
- 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.
169
-
170
- 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.
171
-
172
- Even works in no-code platforms!
173
-
174
- <div style="page-break-after: always;"></div>
146
+ #### Promptbook Server
175
147
 
176
- ### How to create your AI agent in book
148
+ !!!@@@
177
149
 
178
- Now you want to use it. There are several ways how to write your first book:
150
+ #### Promptbook Engine
179
151
 
180
- #### From scratch with help from Paul
152
+ !!!@@@
181
153
 
182
- We have written ai asistant in book who can help you with writing your first book.
183
154
 
184
- #### Your AI twin
185
155
 
186
- 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.
187
156
 
188
- #### AI persona workpool
189
157
 
190
- 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.
191
158
 
192
159
 
193
160
 
194
161
 
195
162
 
196
163
 
197
- ## 🚀 Get started
198
-
199
- Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
200
-
201
- - [Hello Book](https://github.com/webgptorg/hello-world)
202
- - [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
203
- - [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
204
-
205
-
206
-
207
-
208
164
 
209
165
 
210
166
  ## 💜 The Promptbook Project
@@ -220,33 +176,32 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
220
176
  </thead>
221
177
  <tbody>
222
178
  <tr>
223
- <td><a href="https://github.com/webgptorg/book">Book language</a></td>
179
+ <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
224
180
  <td>
225
- Book is a human-understandable markup language for writing AI applications such as chatbots, knowledge bases, agents, avarars, translators, automations and more.
226
- <hr>
227
- There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
181
+ Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
228
182
  </td>
229
183
  </tr>
230
184
  <tr>
231
- <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
185
+ <td><a href="https://github.com/webgptorg/book">Book language</a></td>
232
186
  <td>
233
- 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>
187
+ 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.
188
+ <hr>
189
+ There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
234
190
  </td>
235
191
  </tr>
236
192
  <tr>
237
- <td><a href="https://promptbook.studio">Promptbook Studio</a></td>
193
+ <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
238
194
  <td>
239
- Promptbook.studio is a web-based editor and runner for book applications. It is still in the experimental MVP stage.
195
+ Promptbook engine can run AI agents based on Book language.
196
+ 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>
197
+ Agent Server is based on Promptbook Engine.
240
198
  </td>
241
199
  </tr>
200
+
242
201
  </tbody>
243
202
  </table>
244
203
 
245
- Hello world examples:
246
204
 
247
- - [Hello world](https://github.com/webgptorg/hello-world)
248
- - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
249
- - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
250
205
 
251
206
  ### 🌐 Community & Social Media
252
207
 
@@ -304,6 +259,8 @@ Join our growing community of developers and users:
304
259
 
305
260
 
306
261
 
262
+
263
+
307
264
  ## 📚 Documentation
308
265
 
309
266
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -380,6 +337,8 @@ The following glossary is used to clarify certain concepts:
380
337
 
381
338
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
382
339
 
340
+
341
+
383
342
  ### 💯 Core concepts
384
343
 
385
344
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "promptbook",
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,
@@ -88,36 +88,36 @@
88
88
  "npm": ">=8.0.0"
89
89
  },
90
90
  "peerDependencies": {
91
- "@promptbook/core": "0.105.0-3"
91
+ "@promptbook/core": "0.105.0-4"
92
92
  },
93
93
  "dependencies": {
94
- "@promptbook/anthropic-claude": "0.105.0-3",
95
- "@promptbook/azure-openai": "0.105.0-3",
96
- "@promptbook/browser": "0.105.0-3",
97
- "@promptbook/cli": "0.105.0-3",
98
- "@promptbook/color": "0.105.0-3",
99
- "@promptbook/components": "0.105.0-3",
100
- "@promptbook/core": "0.105.0-3",
101
- "@promptbook/deepseek": "0.105.0-3",
102
- "@promptbook/documents": "0.105.0-3",
103
- "@promptbook/editable": "0.105.0-3",
104
- "@promptbook/fake-llm": "0.105.0-3",
105
- "@promptbook/google": "0.105.0-3",
106
- "@promptbook/javascript": "0.105.0-3",
107
- "@promptbook/legacy-documents": "0.105.0-3",
108
- "@promptbook/markdown-utils": "0.105.0-3",
109
- "@promptbook/markitdown": "0.105.0-3",
110
- "@promptbook/node": "0.105.0-3",
111
- "@promptbook/ollama": "0.105.0-3",
112
- "@promptbook/openai": "0.105.0-3",
113
- "@promptbook/pdf": "0.105.0-3",
114
- "@promptbook/remote-client": "0.105.0-3",
115
- "@promptbook/remote-server": "0.105.0-3",
116
- "@promptbook/templates": "0.105.0-3",
117
- "@promptbook/types": "0.105.0-3",
118
- "@promptbook/utils": "0.105.0-3",
119
- "@promptbook/vercel": "0.105.0-3",
120
- "@promptbook/website-crawler": "0.105.0-3",
121
- "@promptbook/wizard": "0.105.0-3"
94
+ "@promptbook/anthropic-claude": "0.105.0-4",
95
+ "@promptbook/azure-openai": "0.105.0-4",
96
+ "@promptbook/browser": "0.105.0-4",
97
+ "@promptbook/cli": "0.105.0-4",
98
+ "@promptbook/color": "0.105.0-4",
99
+ "@promptbook/components": "0.105.0-4",
100
+ "@promptbook/core": "0.105.0-4",
101
+ "@promptbook/deepseek": "0.105.0-4",
102
+ "@promptbook/documents": "0.105.0-4",
103
+ "@promptbook/editable": "0.105.0-4",
104
+ "@promptbook/fake-llm": "0.105.0-4",
105
+ "@promptbook/google": "0.105.0-4",
106
+ "@promptbook/javascript": "0.105.0-4",
107
+ "@promptbook/legacy-documents": "0.105.0-4",
108
+ "@promptbook/markdown-utils": "0.105.0-4",
109
+ "@promptbook/markitdown": "0.105.0-4",
110
+ "@promptbook/node": "0.105.0-4",
111
+ "@promptbook/ollama": "0.105.0-4",
112
+ "@promptbook/openai": "0.105.0-4",
113
+ "@promptbook/pdf": "0.105.0-4",
114
+ "@promptbook/remote-client": "0.105.0-4",
115
+ "@promptbook/remote-server": "0.105.0-4",
116
+ "@promptbook/templates": "0.105.0-4",
117
+ "@promptbook/types": "0.105.0-4",
118
+ "@promptbook/utils": "0.105.0-4",
119
+ "@promptbook/vercel": "0.105.0-4",
120
+ "@promptbook/website-crawler": "0.105.0-4",
121
+ "@promptbook/wizard": "0.105.0-4"
122
122
  }
123
123
  }