@promptbook/markitdown 0.112.0-15 → 0.112.0-17

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
@@ -2,7 +2,7 @@
2
2
 
3
3
  # ✨ Promptbook: AI Agents
4
4
 
5
- Turn your company's scattered knowledge into AI ready Books
5
+ Create persistent AI agents that turn your company's scattered knowledge into action powered by the [Agents Server](https://gallery.ptbk.io/)
6
6
 
7
7
 
8
8
 
@@ -58,11 +58,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
58
58
 
59
59
  ## 📖 The Book Whitepaper
60
60
 
61
+ Promptbook lets you create **persistent AI agents** that work on real goals for your company. The [**Agents Server**](https://gallery.ptbk.io/) is the heart of the project — a place where your AI agents live, remember context, collaborate in teams, and get things done.
62
+
61
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.
62
64
 
63
65
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
64
66
 
65
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
67
+ In Promptbook, you define your agents **using simple Books** — a human-readable language that is explicit, easy to understand and write, reliable, and highly portable. You then deploy them to the **Agents Server**, where they run persistently and work toward their goals.
66
68
 
67
69
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
68
70
 
@@ -70,8 +72,13 @@ In Promptbook, you can define your context **using simple Books** that are very
70
72
  <br/>
71
73
  **PERSONA** You are a company lawyer.<br/>
72
74
  Your job is to provide legal advice and support to the company and its employees.<br/>
75
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
73
76
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
74
- 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
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
78
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
79
+ **USE EMAIL**<br/>
80
+ **USE BROWSER**<br/>
81
+ **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/>
75
82
 
76
83
  </td></tr></table>
77
84
 
@@ -94,6 +101,22 @@ Personas define the character of your AI persona, its role, and how it should in
94
101
  **<ins>Paul Smith & Associés</ins>**<br/>
95
102
  <br/>
96
103
  **PERSONA** You are a company lawyer.<br/>
104
+ Your job is to provide legal advice and support to the company and its employees.<br/>
105
+
106
+ </td></tr></table>
107
+
108
+ #### `Goal` commitment
109
+
110
+ Goals define what the agent should actively work toward. Unlike a chatbot that only responds when asked, an agent with goals takes initiative and works on tasks persistently on the Agents Server.
111
+
112
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
113
+
114
+ **<ins>Paul Smith & Associés</ins>**<br/>
115
+ <br/>
116
+ **PERSONA** You are a company lawyer.<br/>
117
+ Your job is to provide legal advice and support to the company and its employees.<br/>
118
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
119
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
97
120
 
98
121
  </td></tr></table>
99
122
 
@@ -111,9 +134,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
111
134
  <br/>
112
135
  **PERSONA** You are a company lawyer.<br/>
113
136
  Your job is to provide legal advice and support to the company and its employees.<br/>
114
- You are knowledgeable, professional, and detail-oriented.<br/>
115
- <br/>
116
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
137
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
138
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
139
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
117
140
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
118
141
 
119
142
  </td></tr></table>
@@ -130,13 +153,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
130
153
  <br/>
131
154
  **PERSONA** You are a company lawyer.<br/>
132
155
  Your job is to provide legal advice and support to the company and its employees.<br/>
133
- You are knowledgeable, professional, and detail-oriented.<br/>
156
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
157
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
158
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
159
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
160
+ **RULE** Never provide legal advice about criminal law.<br/>
161
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
162
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
163
+
164
+ </td></tr></table>
165
+
166
+ #### `Use` commitments
167
+
168
+ Use commitments grant the agent real capabilities — tools it can use to interact with the outside world. `USE EMAIL` lets the agent send emails, `USE BROWSER` lets it access and read web content, `USE SEARCH ENGINE` lets it search the web, and many more.
169
+
170
+ These are what turn a chatbot into a persistent agent that actually does work.
171
+
172
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
173
+
174
+ **<ins>Paul Smith & Associés</ins>**<br/>
134
175
  <br/>
135
- **RULE** Always ensure compliance with laws and regulations.<br/>
176
+ **PERSONA** You are a company lawyer.<br/>
177
+ Your job is to provide legal advice and support to the company and its employees.<br/>
178
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
179
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
180
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
136
181
  **RULE** Never provide legal advice outside your area of expertise.<br/>
137
182
  **RULE** Never provide legal advice about criminal law.<br/>
138
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
183
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
139
184
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
185
+ **USE EMAIL**<br/>
186
+ **USE BROWSER**<br/>
187
+ **USE SEARCH ENGINE**<br/>
140
188
 
141
189
  </td></tr></table>
142
190
 
@@ -150,32 +198,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
150
198
  <br/>
151
199
  **PERSONA** You are a company lawyer.<br/>
152
200
  Your job is to provide legal advice and support to the company and its employees.<br/>
153
- You are knowledgeable, professional, and detail-oriented.<br/>
154
- <br/>
155
- **RULE** Always ensure compliance with laws and regulations.<br/>
201
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
202
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
203
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
156
204
  **RULE** Never provide legal advice outside your area of expertise.<br/>
157
205
  **RULE** Never provide legal advice about criminal law.<br/>
158
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
206
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
159
207
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<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/>
208
+ **USE EMAIL**<br/>
209
+ **USE BROWSER**<br/>
210
+ **USE SEARCH ENGINE**<br/>
211
+ **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/>
161
212
 
162
213
  </td></tr></table>
163
214
 
164
-
165
-
166
215
  ### Promptbook Ecosystem
167
216
 
168
- !!!@@@
217
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
169
218
 
170
- #### Promptbook Server
219
+ #### Agents Server
171
220
 
172
- !!!@@@
221
+ The [**Agents Server**](https://gallery.ptbk.io/) is the primary way to use Promptbook. It is a web application where your AI agents live and work. You can create agents, give them knowledge and rules using the Book language, organize them into teams, and let them work on goals persistently. The Agents Server provides a UI for managing agents, an API for integrating them into your applications, and can be self-hosted via [Docker](https://hub.docker.com/r/hejny/promptbook/) or deployed on Vercel.
173
222
 
174
223
  #### Promptbook Engine
175
224
 
176
- !!!@@@
177
-
178
-
225
+ The [Promptbook Engine](https://github.com/webgptorg/promptbook) is the open-source core that powers everything. It parses the Book language, applies commitments, manages LLM provider integrations, and executes agents. The Agents Server is built on top of the Engine. If you need to embed agent capabilities directly into your own application, you can use the Engine as a standalone TypeScript/JavaScript library via [NPM packages](https://www.npmjs.com/package/@promptbook/core).
179
226
 
180
227
 
181
228
 
@@ -189,7 +236,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
189
236
 
190
237
  ## 💜 The Promptbook Project
191
238
 
192
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
239
+ Promptbook project is an ecosystem centered around the **Agents Server** — a platform for creating, deploying, and running persistent AI agents. Following is a list of the most important pieces of the project:
193
240
 
194
241
  <table>
195
242
  <thead>
@@ -200,9 +247,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
200
247
  </thead>
201
248
  <tbody>
202
249
  <tr>
203
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
250
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
204
251
  <td>
205
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
252
+ The primary way to use Promptbook. A production-ready platform where your AI agents live create, manage, deploy, and interact with persistent agents that work on goals. Available as a hosted service or <a href="https://hub.docker.com/r/hejny/promptbook/">self-hosted via Docker</a>.
206
253
  </td>
207
254
  </tr>
208
255
  <tr>
@@ -216,17 +263,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
216
263
  <tr>
217
264
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
218
265
  <td>
219
- Promptbook engine can run AI agents based on Book language.
220
- 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>
221
- Agent Server is based on Promptbook Engine.
266
+ The open-source core that powers the Agents Server. Can also be used as a standalone TypeScript/JavaScript library to embed agent capabilities into your own applications.
267
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
222
268
  </td>
223
269
  </tr>
224
270
 
225
271
  </tbody>
226
272
  </table>
227
273
 
228
-
229
-
230
274
  ### 🌐 Community & Social Media
231
275
 
232
276
  Join our growing community of developers and users:
@@ -283,8 +327,6 @@ Join our growing community of developers and users:
283
327
 
284
328
 
285
329
 
286
-
287
-
288
330
  ## 📚 Documentation
289
331
 
290
332
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -293,9 +335,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
293
335
 
294
336
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
295
337
 
296
- ## 📦 Packages _(for developers)_
338
+ ## 📦 Deployment & Packages
339
+
340
+ The fastest way to get started is with the **Agents Server**:
297
341
 
298
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
342
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
343
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
344
+
345
+ ### NPM Packages _(for developers embedding the Engine)_
346
+
347
+ If you want to embed the Promptbook Engine directly into your application, the library is divided into several packages published from a [single monorepo](https://github.com/webgptorg/promptbook).
299
348
  You can install all of them at once:
300
349
 
301
350
  ```bash
@@ -314,7 +363,6 @@ Or you can install them separately:
314
363
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
315
364
  - ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
316
365
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
317
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
318
366
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
319
367
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
320
368
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -336,8 +384,7 @@ Or you can install them separately:
336
384
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
337
385
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
338
386
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
339
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
340
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
387
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
341
388
 
342
389
 
343
390
 
@@ -361,8 +408,6 @@ The following glossary is used to clarify certain concepts:
361
408
 
362
409
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
363
410
 
364
-
365
-
366
411
  ### 💯 Core concepts
367
412
 
368
413
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -424,31 +469,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
424
469
 
425
470
 
426
471
 
472
+ ## � Agents Server
473
+
474
+ The **[Agents Server](https://gallery.ptbk.io/)** is the primary way to use Promptbook. It is a production-ready platform where you create, deploy, and manage persistent AI agents that work toward goals. Agents remember context across conversations, collaborate in teams, and follow the rules and knowledge you define in the Book language.
475
+
476
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
477
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
478
+ - **API** for integrating agents into your own applications
479
+
427
480
  ## 🚂 Promptbook Engine
428
481
 
482
+ The Engine is the open-source core that powers the Agents Server. If you need to embed agent capabilities directly into your TypeScript/JavaScript application, you can use it as a standalone library.
483
+
429
484
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
430
485
 
431
486
  ## ➕➖ When to use Promptbook?
432
487
 
433
488
  ### ➕ When to use
434
489
 
435
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
436
- - When you want to **separate code from text prompts**
437
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
438
- - When you want to **orchestrate multiple prompts** together
439
- - When you want to **reuse** parts of prompts in multiple places
440
- - When you want to **version** your prompts and **test multiple versions**
441
- - When you want to **log** the execution of prompts and backtrace the issues
490
+ - When you want to **deploy persistent AI agents** that work on goals for your company
491
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
492
+ - When you want agents that **collaborate in teams** and consult each other
493
+ - When you need to **integrate AI agents into your existing applications** via API
494
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
495
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
496
+ - When you want to **version** your agent definitions and **test multiple versions**
497
+ - When you want to **log** agent execution and backtrace issues
442
498
 
443
499
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
444
500
 
445
501
  ### ➖ When not to use
446
502
 
447
- - When you have already implemented single simple prompt and it works fine for your job
503
+ - When a single simple prompt already works fine for your job
448
504
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
449
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
505
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
450
506
  - When you need to use something other than JavaScript or TypeScript _(other languages are on the way, [see the discussion](https://github.com/webgptorg/promptbook/discussions/101))_
451
- - When your main focus is on something other than text - like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
507
+ - When your main focus is on something other than text like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
452
508
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
453
509
 
454
510
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -24,7 +24,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
24
24
  * @generated
25
25
  * @see https://github.com/webgptorg/promptbook
26
26
  */
27
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-15';
27
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
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
@@ -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.112.0-14`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/markitdown",
3
- "version": "0.112.0-15",
3
+ "version": "0.112.0-17",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -94,7 +94,7 @@
94
94
  "module": "./esm/index.es.js",
95
95
  "typings": "./esm/typings/src/_packages/markitdown.index.d.ts",
96
96
  "peerDependencies": {
97
- "@promptbook/core": "0.112.0-15"
97
+ "@promptbook/core": "0.112.0-17"
98
98
  },
99
99
  "dependencies": {
100
100
  "crypto": "1.0.1",
package/umd/index.umd.js CHANGED
@@ -23,7 +23,7 @@
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-15';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
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.112.0-14`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */