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