@promptbook/pdf 0.86.0-6 → 0.86.5
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 +48 -58
- package/esm/index.es.js +2 -2
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/cli/test/ptbk2.d.ts +5 -0
- package/esm/typings/src/conversion/compilePipeline.d.ts +1 -1
- package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +1 -1
- package/esm/typings/src/conversion/parsePipeline.d.ts +1 -1
- package/esm/typings/src/conversion/pipelineJsonToString.d.ts +1 -1
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +6 -6
- package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +2 -2
- package/umd/index.umd.js.map +1 -1
package/README.md
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
[ Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
|
|
9
|
+
[ Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
|
|
10
10
|
[](https://snyk.io/test/github/webgptorg/promptbook)
|
|
11
11
|
[](https://github.com/webgptorg/promptbook/issues)
|
|
12
12
|
|
|
@@ -17,18 +17,12 @@
|
|
|
17
17
|
## 🌟 New Features
|
|
18
18
|
|
|
19
19
|
- 📂 We have plugin for [VSCode](https://github.com/webgptorg/book-extension) to support `.book` file extension
|
|
20
|
+
- 🐳 Available [Docker image](https://hub.docker.com/r/hejny/promptbook/)
|
|
20
21
|
- 💫 Support of [`o3-mini` model by OpenAI](https://openai.com/index/openai-o3-mini/)
|
|
21
22
|
- 🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
|
|
22
|
-
- 💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
|
|
23
|
-
- 🖤 Run books from CLI - `npx ptbk run path/to/your/book`
|
|
24
|
-
- 📚 Support of `.docx`, `.doc` and `.pdf` documents as knowledge
|
|
25
23
|
|
|
26
24
|
|
|
27
25
|
|
|
28
|
-
<blockquote style="color: #ff8811">
|
|
29
|
-
<b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
|
|
30
|
-
</blockquote>
|
|
31
|
-
|
|
32
26
|
## 📦 Package `@promptbook/pdf`
|
|
33
27
|
|
|
34
28
|
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
@@ -62,6 +56,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
62
56
|
|
|
63
57
|
During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
|
|
64
58
|
|
|
59
|
+
|
|
60
|
+
|
|
65
61
|
It's a revolution of writing software in **plain human language** that is understandable and executable by both humans and machines – and it's going to change everything!
|
|
66
62
|
|
|
67
63
|
The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
|
|
@@ -119,34 +115,41 @@ We also have a community of developers and users of **Promptbook**:
|
|
|
119
115
|
- [Landing page `ptbk.io`](https://ptbk.io)
|
|
120
116
|
- [Github discussions](https://github.com/webgptorg/promptbook/discussions)
|
|
121
117
|
- [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
|
|
122
|
-
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
118
|
+
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
123
119
|
|
|
124
120
|
And **Promptbook.studio** branded socials:
|
|
125
121
|
|
|
122
|
+
|
|
123
|
+
|
|
126
124
|
- [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
|
|
127
125
|
|
|
126
|
+
|
|
127
|
+
|
|
128
128
|
And **Promptujeme** sub-brand:
|
|
129
129
|
|
|
130
|
-
|
|
130
|
+
*/Subbrand for Czech clients/*
|
|
131
|
+
|
|
132
|
+
|
|
131
133
|
|
|
132
134
|
- [Promptujeme.cz](https://www.promptujeme.cz/)
|
|
133
135
|
- [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
|
|
134
136
|
|
|
137
|
+
|
|
135
138
|
And **Promptbook.city** branded socials:
|
|
136
139
|
|
|
137
|
-
|
|
140
|
+
*/Sub-brand for images and graphics generated via Promptbook prompting/*
|
|
138
141
|
|
|
139
142
|
- [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
|
|
140
|
-
- [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
|
|
143
|
+
- [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
|
|
141
144
|
|
|
142
145
|
|
|
143
146
|
|
|
144
|
-
## 💙 Book language _(for prompt-engineer)_
|
|
145
147
|
|
|
146
148
|
|
|
147
149
|
|
|
150
|
+
## 💙 The Book language
|
|
151
|
+
|
|
148
152
|
|
|
149
|
-
## 💙 The blueprint of book language
|
|
150
153
|
|
|
151
154
|
Following is the documentation and blueprint of the Book language.
|
|
152
155
|
|
|
@@ -155,6 +158,11 @@ Following is the documentation and blueprint of the Book language.
|
|
|
155
158
|
```markdown
|
|
156
159
|
# 🌟 My first Book
|
|
157
160
|
|
|
161
|
+
- BOOK VERSION 1.0.0
|
|
162
|
+
- URL https://promptbook.studio/my-first-book/
|
|
163
|
+
|
|
164
|
+
# Write an article
|
|
165
|
+
|
|
158
166
|
- PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
|
|
159
167
|
- KNOWLEDGE https://ptbk.io
|
|
160
168
|
- KNOWLEDGE ./promptbook.pdf
|
|
@@ -167,59 +175,31 @@ Following is the documentation and blueprint of the Book language.
|
|
|
167
175
|
-> {article}
|
|
168
176
|
```
|
|
169
177
|
|
|
170
|
-
###
|
|
171
|
-
|
|
172
|
-
File is designed to be easy to read and write. It is strict subset of markdown. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
|
|
173
|
-
|
|
174
|
-
It has file with `.book.md` or `.book` extension with `UTF-8` non BOM encoding.
|
|
175
|
-
|
|
176
|
-
As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
|
|
177
|
-
|
|
178
|
-
But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
|
|
179
|
-
|
|
180
|
-
### Structure
|
|
181
|
-
|
|
182
|
-
Book is divided into sections. Each section starts with heading. The language itself is not sensitive to the type of heading _(`h1`, `h2`, `h3`, ...)_ but it is recommended to use `h1` for header section and `h2` for other sections.
|
|
183
|
-
|
|
184
|
-
### Header
|
|
185
|
-
|
|
186
|
-
Header is the first section of the book. It contains metadata about the pipeline. It is recommended to use `h1` heading for header section but it is not required.
|
|
187
|
-
|
|
188
|
-
### Parameter
|
|
178
|
+
### **What:** Workflows, Tasks and Parameters
|
|
189
179
|
|
|
190
|
-
|
|
180
|
+
- [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
|
|
191
181
|
|
|
192
|
-
|
|
182
|
+
### **Who:** Personas
|
|
193
183
|
|
|
194
|
-
|
|
184
|
+
- [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
|
|
195
185
|
|
|
196
|
-
|
|
197
|
-
- `content`
|
|
198
|
-
- `context`
|
|
199
|
-
- `knowledge`
|
|
200
|
-
- `examples`
|
|
201
|
-
- `modelName`
|
|
202
|
-
- `currentDate`
|
|
186
|
+
### **How:** Knowledge, Instruments and Actions
|
|
203
187
|
|
|
204
|
-
|
|
188
|
+
- [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md)
|
|
189
|
+
- [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md)
|
|
190
|
+
- [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md)
|
|
205
191
|
|
|
206
|
-
###
|
|
192
|
+
### General principles of book language
|
|
207
193
|
|
|
208
|
-
|
|
194
|
+
Book language is based on markdown. It is subset of markdown. It is designed to be easy to read and write. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
|
|
209
195
|
|
|
210
|
-
|
|
196
|
+
The file has `.book` extension. It uses `UTF-8` non BOM encoding.
|
|
211
197
|
|
|
212
|
-
|
|
198
|
+
Book has two variants: flat - which is just a prompt with no structure, and full - which has a structure with tasks, commands and prompts.
|
|
213
199
|
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
### Block
|
|
217
|
-
|
|
218
|
-
Todo todo
|
|
219
|
-
|
|
220
|
-
### Return parameter
|
|
200
|
+
As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
|
|
221
201
|
|
|
222
|
-
|
|
202
|
+
But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
|
|
223
203
|
|
|
224
204
|
|
|
225
205
|
|
|
@@ -265,6 +245,7 @@ Or you can install them separately:
|
|
|
265
245
|
- **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
|
|
266
246
|
- **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
|
|
267
247
|
- ⭐ **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
|
|
248
|
+
- 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
|
|
268
249
|
|
|
269
250
|
|
|
270
251
|
|
|
@@ -273,6 +254,11 @@ Or you can install them separately:
|
|
|
273
254
|
|
|
274
255
|
## 📚 Dictionary
|
|
275
256
|
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
276
262
|
### 📚 Dictionary
|
|
277
263
|
|
|
278
264
|
The following glossary is used to clarify certain concepts:
|
|
@@ -288,6 +274,8 @@ The following glossary is used to clarify certain concepts:
|
|
|
288
274
|
- **Retrieval-augmented generation** is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
|
|
289
275
|
- **Longtail** refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.
|
|
290
276
|
|
|
277
|
+
|
|
278
|
+
|
|
291
279
|
_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
292
280
|
|
|
293
281
|
#### Promptbook core
|
|
@@ -348,6 +336,8 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
348
336
|
- [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
|
|
349
337
|
- [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
|
|
350
338
|
|
|
339
|
+
|
|
340
|
+
|
|
351
341
|
### Terms specific to Promptbook TypeScript implementation
|
|
352
342
|
|
|
353
343
|
- Anonymous mode
|
|
@@ -427,7 +417,7 @@ See [TODO.md](./TODO.md)
|
|
|
427
417
|
<div style="display: flex; align-items: center; gap: 20px;">
|
|
428
418
|
|
|
429
419
|
<a href="https://promptbook.studio/">
|
|
430
|
-
<img src="./
|
|
420
|
+
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="100">
|
|
431
421
|
</a>
|
|
432
422
|
|
|
433
423
|
<a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
|
package/esm/index.es.js
CHANGED
|
@@ -26,7 +26,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
26
26
|
* @generated
|
|
27
27
|
* @see https://github.com/webgptorg/promptbook
|
|
28
28
|
*/
|
|
29
|
-
var PROMPTBOOK_ENGINE_VERSION = '0.86.
|
|
29
|
+
var PROMPTBOOK_ENGINE_VERSION = '0.86.5';
|
|
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
|
|
@@ -1097,7 +1097,7 @@ function capitalize(word) {
|
|
|
1097
1097
|
* Converts promptbook in JSON format to string format
|
|
1098
1098
|
*
|
|
1099
1099
|
* @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
|
|
1100
|
-
* @param pipelineJson Promptbook in JSON format (.
|
|
1100
|
+
* @param pipelineJson Promptbook in JSON format (.bookc)
|
|
1101
1101
|
* @returns Promptbook in string format (.book.md)
|
|
1102
1102
|
* @public exported from `@promptbook/core`
|
|
1103
1103
|
*/
|