@promptbook/types 0.88.0-11 → 0.88.0-12
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 +7 -19
- package/esm/typings/src/config.d.ts +1 -1
- package/esm/typings/src/errors/PipelineExecutionError.d.ts +5 -0
- package/esm/typings/src/errors/utils/ErrorJson.d.ts +5 -0
- package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countLines.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countPages.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countWords.d.ts +3 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -83,8 +83,6 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
83
83
|
|
|
84
84
|
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**!
|
|
85
85
|
|
|
86
|
-
|
|
87
|
-
|
|
88
86
|
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!
|
|
89
87
|
|
|
90
88
|
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.
|
|
@@ -95,6 +93,9 @@ This shift is going to happen, whether we are ready for it or not. Our mission i
|
|
|
95
93
|
|
|
96
94
|
|
|
97
95
|
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
98
99
|
## 🚀 Get started
|
|
99
100
|
|
|
100
101
|
Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
|
|
@@ -106,6 +107,8 @@ Take a look at the simple starter kit with books integrated into the **Hello Wor
|
|
|
106
107
|
|
|
107
108
|
|
|
108
109
|
|
|
110
|
+
|
|
111
|
+
|
|
109
112
|
## 💜 The Promptbook Project
|
|
110
113
|
|
|
111
114
|
Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
|
|
@@ -147,29 +150,22 @@ Hello world examples:
|
|
|
147
150
|
- [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
|
|
148
151
|
- [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
|
|
149
152
|
|
|
150
|
-
|
|
151
|
-
|
|
152
153
|
We also have a community of developers and users of **Promptbook**:
|
|
153
154
|
|
|
154
155
|
- [Discord community](https://discord.gg/x3QWNaa89N)
|
|
155
156
|
- [Landing page `ptbk.io`](https://ptbk.io)
|
|
156
157
|
- [Github discussions](https://github.com/webgptorg/promptbook/discussions)
|
|
157
158
|
- [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
|
|
158
|
-
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
159
|
+
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
159
160
|
|
|
160
161
|
And **Promptbook.studio** branded socials:
|
|
161
162
|
|
|
162
|
-
|
|
163
|
-
|
|
164
163
|
- [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
|
|
165
164
|
|
|
166
165
|
And **Promptujeme** sub-brand:
|
|
167
166
|
|
|
168
167
|
_/Subbrand for Czech clients/_
|
|
169
168
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
169
|
- [Promptujeme.cz](https://www.promptujeme.cz/)
|
|
174
170
|
- [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
|
|
175
171
|
|
|
@@ -187,8 +183,6 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
|
187
183
|
|
|
188
184
|
## 💙 The Book language
|
|
189
185
|
|
|
190
|
-
|
|
191
|
-
|
|
192
186
|
Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
|
|
193
187
|
|
|
194
188
|
Book is a language that can be used to write AI applications, agents, workflows, automations, knowledgebases, translators, sheet processors, email automations and more. It allows you to harness the power of AI models in human-like terms, without the need to know the specifics and technicalities of the models.
|
|
@@ -238,8 +232,6 @@ Personas can have access to different knowledge, tools and actions. They can als
|
|
|
238
232
|
|
|
239
233
|
- [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
|
|
240
234
|
|
|
241
|
-
|
|
242
|
-
|
|
243
235
|
### **How:** Knowledge, Instruments and Actions
|
|
244
236
|
|
|
245
237
|
The resources used by the personas are used to do the work.
|
|
@@ -328,12 +320,8 @@ The following glossary is used to clarify certain concepts:
|
|
|
328
320
|
- **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.
|
|
329
321
|
- **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.
|
|
330
322
|
|
|
331
|
-
|
|
332
|
-
|
|
333
323
|
_Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
334
324
|
|
|
335
|
-
|
|
336
|
-
|
|
337
325
|
### 💯 Core concepts
|
|
338
326
|
|
|
339
327
|
- [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|
|
@@ -438,7 +426,7 @@ See [TODO.md](./TODO.md)
|
|
|
438
426
|
<a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
|
|
439
427
|
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
|
|
440
428
|
</a>
|
|
441
|
-
|
|
429
|
+
|
|
442
430
|
</div>
|
|
443
431
|
|
|
444
432
|
## 🖋️ Contributing
|
|
@@ -162,7 +162,7 @@ export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
|
|
|
162
162
|
*
|
|
163
163
|
* @public exported from `@promptbook/core`
|
|
164
164
|
*/
|
|
165
|
-
export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS =
|
|
165
|
+
export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10;
|
|
166
166
|
/**
|
|
167
167
|
* @@@
|
|
168
168
|
* TODO: [🐝][main] !!3 Use
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { task_id } from '../types/typeAliases';
|
|
1
2
|
/**
|
|
2
3
|
* This error indicates errors during the execution of the pipeline
|
|
3
4
|
*
|
|
@@ -5,5 +6,9 @@
|
|
|
5
6
|
*/
|
|
6
7
|
export declare class PipelineExecutionError extends Error {
|
|
7
8
|
readonly name = "PipelineExecutionError";
|
|
9
|
+
readonly id?: task_id;
|
|
8
10
|
constructor(message: string);
|
|
9
11
|
}
|
|
12
|
+
/**
|
|
13
|
+
* TODO: !!!!!! Add id to all errors
|
|
14
|
+
*/
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { task_id } from '../../types/typeAliases';
|
|
1
2
|
import type { ALL_ERRORS } from '../0-index';
|
|
2
3
|
/**
|
|
3
4
|
* Represents a serialized error or custom Promptbook error
|
|
@@ -5,6 +6,10 @@ import type { ALL_ERRORS } from '../0-index';
|
|
|
5
6
|
* Note: [🚉] This is fully serializable as JSON
|
|
6
7
|
*/
|
|
7
8
|
export type ErrorJson = {
|
|
9
|
+
/**
|
|
10
|
+
* The unique identifier of the error
|
|
11
|
+
*/
|
|
12
|
+
readonly id?: task_id;
|
|
8
13
|
/**
|
|
9
14
|
* The type of the error
|
|
10
15
|
*/
|
|
@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
|
|
|
5
5
|
* @public exported from `@promptbook/utils`
|
|
6
6
|
*/
|
|
7
7
|
export declare function countCharacters(text: string): ExpectationAmount;
|
|
8
|
+
/**
|
|
9
|
+
* TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
|
|
10
|
+
*/
|
|
@@ -7,3 +7,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
|
|
|
7
7
|
* @public exported from `@promptbook/utils`
|
|
8
8
|
*/
|
|
9
9
|
export declare function countLines(text: string): ExpectationAmount;
|
|
10
|
+
/**
|
|
11
|
+
* TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
|
|
12
|
+
*/
|
|
@@ -7,3 +7,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
|
|
|
7
7
|
* @public exported from `@promptbook/utils`
|
|
8
8
|
*/
|
|
9
9
|
export declare function countPages(text: string): ExpectationAmount;
|
|
10
|
+
/**
|
|
11
|
+
* TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
|
|
12
|
+
*/
|
|
@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
|
|
|
5
5
|
* @public exported from `@promptbook/utils`
|
|
6
6
|
*/
|
|
7
7
|
export declare function countParagraphs(text: string): ExpectationAmount;
|
|
8
|
+
/**
|
|
9
|
+
* TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
|
|
10
|
+
*/
|
|
@@ -11,3 +11,6 @@ export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
|
|
|
11
11
|
* @public exported from `@promptbook/utils`
|
|
12
12
|
*/
|
|
13
13
|
export declare function countSentences(text: string): ExpectationAmount;
|
|
14
|
+
/**
|
|
15
|
+
* TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
|
|
16
|
+
*/
|
|
@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
|
|
|
5
5
|
* @public exported from `@promptbook/utils`
|
|
6
6
|
*/
|
|
7
7
|
export declare function countWords(text: string): ExpectationAmount;
|
|
8
|
+
/**
|
|
9
|
+
* TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
|
|
10
|
+
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/types",
|
|
3
|
-
"version": "0.88.0-
|
|
3
|
+
"version": "0.88.0-12",
|
|
4
4
|
"description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
"homepage": "https://ptbk.io/",
|
|
46
46
|
"typings": "./esm/typings/src/_packages/types.index.d.ts",
|
|
47
47
|
"peerDependencies": {
|
|
48
|
-
"@promptbook/core": "0.88.0-
|
|
48
|
+
"@promptbook/core": "0.88.0-12"
|
|
49
49
|
}
|
|
50
50
|
}
|