@promptbook/types 0.72.0 → 0.73.0
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 +34 -246
- package/esm/typings/src/commands/TEMPLATE/TemplateTypes.d.ts +1 -1
- package/esm/typings/src/config.d.ts +1 -1
- package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -3
- package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts +1 -1
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
- package/esm/typings/src/conversion/validation/validatePipeline.d.ts +2 -2
- package/esm/typings/src/execution/createPipelineExecutor/{getSamplesForTemplate.d.ts → getExamplesForTemplate.d.ts} +1 -1
- package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
- package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +1 -1
- package/esm/typings/src/personas/preparePersona.d.ts +1 -1
- package/esm/typings/src/prepare/isPipelinePrepared.d.ts +2 -2
- package/esm/typings/src/prepare/prepareTemplates.d.ts +1 -1
- package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +1 -1
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +1 -1
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +2 -2
- package/esm/typings/src/types/PipelineJson/PreparationJson.d.ts +1 -1
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -18,6 +18,8 @@ Build responsible, controlled and transparent applications on top of LLM models!
|
|
|
18
18
|
|
|
19
19
|
## ✨ New Features
|
|
20
20
|
|
|
21
|
+
- 💙 Working on [the **Book** language v1](https://github.com/webgptorg/book)
|
|
22
|
+
- 📚 Support of `.docx`, `.doc` and `.pdf` documents
|
|
21
23
|
- ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
|
|
22
24
|
|
|
23
25
|
|
|
@@ -45,7 +47,7 @@ import { pipelineStringToJson } from '@promptbook/core';
|
|
|
45
47
|
const promptbook: PipelineJson = pipelineStringToJson(
|
|
46
48
|
spaceTrim(`
|
|
47
49
|
|
|
48
|
-
# ✨
|
|
50
|
+
# ✨ Example prompt
|
|
49
51
|
|
|
50
52
|
- OUTPUT PARAMETER {greeting}
|
|
51
53
|
|
|
@@ -71,11 +73,9 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
71
73
|
|
|
72
74
|
## 🤍 The Promptbook Whitepaper
|
|
73
75
|
|
|
74
|
-
|
|
75
|
-
|
|
76
76
|
If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
|
|
77
77
|
|
|
78
|
-
But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd
|
|
78
|
+
But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd resp0nses**. When this happens, you generally have three options:
|
|
79
79
|
|
|
80
80
|
1. **Fine-tune** the model to your specifications or even train your own.
|
|
81
81
|
2. **Prompt-engineer** the prompt to the best shape you can achieve.
|
|
@@ -83,248 +83,38 @@ But often you will struggle with the **limitations of LLMs**, such as **hallucin
|
|
|
83
83
|
|
|
84
84
|
In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
|
|
85
85
|
|
|
86
|
-
- [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic.
|
|
87
|
-
-
|
|
88
|
-
- **Forget** about **low-level details** like choosing the right model, tokens, context size, temperature
|
|
89
|
-
-
|
|
86
|
+
- [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic. For this purpose, it introduces a new language called [the **💙 Book**](https://github.com/webgptorg/book).
|
|
87
|
+
- Book allows you to **focus on the business** logic without having to write code or deal with the technicalities of LLMs.
|
|
88
|
+
- **Forget** about **low-level details** like choosing the right model, tokens, context size, `temperature`, `top-k`, `top-p`, or kernel sampling. **Just write your intent** and [**persona**](https://github.com/webgptorg/promptbook/discussions/22) who should be responsible for the task and let the library do the rest.
|
|
89
|
+
- We have built-in **orchestration** of [pipeline](https://github.com/webgptorg/promptbook/discussions/64) execution and many tools to make the process easier, more reliable, and more efficient, such as caching, [compilation+preparation](https://github.com/webgptorg/promptbook/discussions/78), [just-in-time fine-tuning](https://github.com/webgptorg/promptbook/discussions/33), [expectation-aware generation](https://github.com/webgptorg/promptbook/discussions/37), [agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39), and more.
|
|
90
90
|
- Sometimes even the best prompts with the best framework like Promptbook `:)` can't avoid the problems. In this case, the library has built-in **[anomaly detection](https://github.com/webgptorg/promptbook/discussions/40) and logging** to help you find and fix the problems.
|
|
91
|
-
-
|
|
92
|
-
- Promptbook is designed to
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
##
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
- Multiple pipelines forms a **collection** which will handle core **know-how of your LLM application**.
|
|
101
|
-
- Theese pipelines are designed such as they **can be written by non-programmers**.
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
### Sample:
|
|
106
|
-
|
|
107
|
-
File `write-website-content.ptbk.md`:
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
> # 🌍 Create website content
|
|
114
|
-
>
|
|
115
|
-
> Instructions for creating web page content.
|
|
116
|
-
>
|
|
117
|
-
> - PIPELINE URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
|
|
118
|
-
> - INPUT PARAM `{rawTitle}` Automatically suggested a site name or empty text
|
|
119
|
-
> - INPUT PARAM `{rawAssigment}` Automatically generated site entry from image recognition
|
|
120
|
-
> - OUTPUT PARAM `{websiteContent}` Web content
|
|
121
|
-
> - OUTPUT PARAM `{keywords}` Keywords
|
|
122
|
-
>
|
|
123
|
-
> ## 👤 Specifying the assigment
|
|
124
|
-
>
|
|
125
|
-
> What is your web about?
|
|
126
|
-
>
|
|
127
|
-
> - DIALOG TEMPLATE
|
|
128
|
-
>
|
|
129
|
-
> ```
|
|
130
|
-
> {rawAssigment}
|
|
131
|
-
> ```
|
|
132
|
-
>
|
|
133
|
-
> `-> {assigment}` Website assignment and specification
|
|
134
|
-
>
|
|
135
|
-
> ## ✨ Improving the title
|
|
136
|
-
>
|
|
137
|
-
> - PERSONA Jane, Copywriter and Marketing Specialist.
|
|
138
|
-
>
|
|
139
|
-
> ```
|
|
140
|
-
> As an experienced marketing specialist, you have been entrusted with improving the name of your client's business.
|
|
141
|
-
>
|
|
142
|
-
> A suggested name from a client:
|
|
143
|
-
> "{rawTitle}"
|
|
144
|
-
>
|
|
145
|
-
> Assignment from customer:
|
|
146
|
-
>
|
|
147
|
-
> > {assigment}
|
|
148
|
-
>
|
|
149
|
-
> ## Instructions:
|
|
150
|
-
>
|
|
151
|
-
> - Write only one name suggestion
|
|
152
|
-
> - The name will be used on the website, business cards, visuals, etc.
|
|
153
|
-
> ```
|
|
154
|
-
>
|
|
155
|
-
> `-> {enhancedTitle}` Enhanced title
|
|
156
|
-
>
|
|
157
|
-
> ## 👤 Website title approval
|
|
158
|
-
>
|
|
159
|
-
> Is the title for your website okay?
|
|
160
|
-
>
|
|
161
|
-
> - DIALOG TEMPLATE
|
|
162
|
-
>
|
|
163
|
-
> ```
|
|
164
|
-
> {enhancedTitle}
|
|
165
|
-
> ```
|
|
166
|
-
>
|
|
167
|
-
> `-> {title}` Title for the website
|
|
168
|
-
>
|
|
169
|
-
> ## 🐰 Cunning subtitle
|
|
170
|
-
>
|
|
171
|
-
> - PERSONA Josh, a copywriter, tasked with creating a claim for the website.
|
|
172
|
-
>
|
|
173
|
-
> ```
|
|
174
|
-
> As an experienced copywriter, you have been entrusted with creating a claim for the "{title}" web page.
|
|
175
|
-
>
|
|
176
|
-
> A website assignment from a customer:
|
|
177
|
-
>
|
|
178
|
-
> > {assigment}
|
|
179
|
-
>
|
|
180
|
-
> ## Instructions:
|
|
181
|
-
>
|
|
182
|
-
> - Write only one name suggestion
|
|
183
|
-
> - Claim will be used on website, business cards, visuals, etc.
|
|
184
|
-
> - Claim should be punchy, funny, original
|
|
185
|
-
> ```
|
|
186
|
-
>
|
|
187
|
-
> `-> {claim}` Claim for the web
|
|
188
|
-
>
|
|
189
|
-
> ## 🚦 Keyword analysis
|
|
190
|
-
>
|
|
191
|
-
> - PERSONA Paul, extremely creative SEO specialist.
|
|
192
|
-
>
|
|
193
|
-
> ```
|
|
194
|
-
> As an experienced SEO specialist, you have been entrusted with creating keywords for the website "{title}".
|
|
195
|
-
>
|
|
196
|
-
> Website assignment from the customer:
|
|
197
|
-
>
|
|
198
|
-
> > {assigment}
|
|
199
|
-
>
|
|
200
|
-
> ## Instructions:
|
|
201
|
-
>
|
|
202
|
-
> - Write a list of keywords
|
|
203
|
-
> - Keywords are in basic form
|
|
204
|
-
>
|
|
205
|
-
> ## Example:
|
|
206
|
-
>
|
|
207
|
-
> - Ice cream
|
|
208
|
-
> - Olomouc
|
|
209
|
-
> - Quality
|
|
210
|
-
> - Family
|
|
211
|
-
> - Tradition
|
|
212
|
-
> - Italy
|
|
213
|
-
> - Craft
|
|
214
|
-
>
|
|
215
|
-
> ```
|
|
216
|
-
>
|
|
217
|
-
> `-> {keywords}` Keywords
|
|
218
|
-
>
|
|
219
|
-
> ## 🔗 Combine the beginning
|
|
220
|
-
>
|
|
221
|
-
> - SIMPLE TEMPLATE
|
|
222
|
-
>
|
|
223
|
-
> ```
|
|
224
|
-
>
|
|
225
|
-
> # {title}
|
|
226
|
-
>
|
|
227
|
-
> > {claim}
|
|
228
|
-
>
|
|
229
|
-
> ```
|
|
230
|
-
>
|
|
231
|
-
> `-> {contentBeginning}` Beginning of web content
|
|
232
|
-
>
|
|
233
|
-
> ## 🖋 Write the content
|
|
234
|
-
>
|
|
235
|
-
> - PERSONA Jane
|
|
236
|
-
>
|
|
237
|
-
> ```
|
|
238
|
-
> As an experienced copywriter and web designer, you have been entrusted with creating text for a new website {title}.
|
|
239
|
-
>
|
|
240
|
-
> A website assignment from a customer:
|
|
241
|
-
>
|
|
242
|
-
> > {assigment}
|
|
243
|
-
>
|
|
244
|
-
> ## Instructions:
|
|
245
|
-
>
|
|
246
|
-
> - Text formatting is in Markdown
|
|
247
|
-
> - Be concise and to the point
|
|
248
|
-
> - Use keywords, but they should be naturally in the text
|
|
249
|
-
> - This is the complete content of the page, so don't forget all the important information and elements the page should contain
|
|
250
|
-
> - Use headings, bullets, text formatting
|
|
251
|
-
>
|
|
252
|
-
> ## Keywords:
|
|
253
|
-
>
|
|
254
|
-
> {keywords}
|
|
255
|
-
>
|
|
256
|
-
> ## Web Content:
|
|
257
|
-
>
|
|
258
|
-
> {contentBeginning}
|
|
259
|
-
> ```
|
|
260
|
-
>
|
|
261
|
-
> `-> {contentBody}` Middle of the web content
|
|
262
|
-
>
|
|
263
|
-
> ## 🔗 Combine the content
|
|
264
|
-
>
|
|
265
|
-
> - SIMPLE TEMPLATE
|
|
266
|
-
>
|
|
267
|
-
> ```markdown
|
|
268
|
-
> {contentBeginning}
|
|
269
|
-
>
|
|
270
|
-
> {contentBody}
|
|
271
|
-
> ```
|
|
272
|
-
>
|
|
273
|
-
> `-> {websiteContent}`
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
Following is the scheme how the promptbook above is executed:
|
|
278
|
-
|
|
279
|
-
```mermaid
|
|
280
|
-
%% 🔮 Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually
|
|
281
|
-
|
|
282
|
-
flowchart LR
|
|
283
|
-
subgraph "🌍 Create website content"
|
|
284
|
-
|
|
285
|
-
direction TB
|
|
286
|
-
|
|
287
|
-
input((Input)):::input
|
|
288
|
-
templateSpecifyingTheAssigment(👤 Specifying the assigment)
|
|
289
|
-
input--"{rawAssigment}"-->templateSpecifyingTheAssigment
|
|
290
|
-
templateImprovingTheTitle(✨ Improving the title)
|
|
291
|
-
input--"{rawTitle}"-->templateImprovingTheTitle
|
|
292
|
-
templateSpecifyingTheAssigment--"{assigment}"-->templateImprovingTheTitle
|
|
293
|
-
templateWebsiteTitleApproval(👤 Website title approval)
|
|
294
|
-
templateImprovingTheTitle--"{enhancedTitle}"-->templateWebsiteTitleApproval
|
|
295
|
-
templateCunningSubtitle(🐰 Cunning subtitle)
|
|
296
|
-
templateWebsiteTitleApproval--"{title}"-->templateCunningSubtitle
|
|
297
|
-
templateSpecifyingTheAssigment--"{assigment}"-->templateCunningSubtitle
|
|
298
|
-
templateKeywordAnalysis(🚦 Keyword analysis)
|
|
299
|
-
templateWebsiteTitleApproval--"{title}"-->templateKeywordAnalysis
|
|
300
|
-
templateSpecifyingTheAssigment--"{assigment}"-->templateKeywordAnalysis
|
|
301
|
-
templateCombineTheBeginning(🔗 Combine the beginning)
|
|
302
|
-
templateWebsiteTitleApproval--"{title}"-->templateCombineTheBeginning
|
|
303
|
-
templateCunningSubtitle--"{claim}"-->templateCombineTheBeginning
|
|
304
|
-
templateWriteTheContent(🖋 Write the content)
|
|
305
|
-
templateWebsiteTitleApproval--"{title}"-->templateWriteTheContent
|
|
306
|
-
templateSpecifyingTheAssigment--"{assigment}"-->templateWriteTheContent
|
|
307
|
-
templateKeywordAnalysis--"{keywords}"-->templateWriteTheContent
|
|
308
|
-
templateCombineTheBeginning--"{contentBeginning}"-->templateWriteTheContent
|
|
309
|
-
templateCombineTheContent(🔗 Combine the content)
|
|
310
|
-
templateCombineTheBeginning--"{contentBeginning}"-->templateCombineTheContent
|
|
311
|
-
templateWriteTheContent--"{contentBody}"-->templateCombineTheContent
|
|
312
|
-
|
|
313
|
-
templateCombineTheContent--"{websiteContent}"-->output
|
|
314
|
-
output((Output)):::output
|
|
315
|
-
|
|
316
|
-
classDef input color: grey;
|
|
317
|
-
classDef output color: grey;
|
|
318
|
-
|
|
319
|
-
end;
|
|
320
|
-
```
|
|
91
|
+
- Versioning is build in. You can test multiple **A/B versions** of pipelines and see which one works best.
|
|
92
|
+
- Promptbook is designed to use [**RAG** (Retrieval-Augmented Generation)](https://github.com/webgptorg/promptbook/discussions/41) and other advanced techniques to bring the context of your business to generic LLM. You can use **knowledge** to improve the quality of the output.
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
## 💙 Book language _(for prompt-engineer)_
|
|
97
|
+
|
|
98
|
+
Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) are written in markdown-like language called [Book](https://github.com/webgptorg/book). It is designed to be understandable by non-programmers and non-technical people.
|
|
321
99
|
|
|
322
|
-
- [More template samples](./samples/pipelines/)
|
|
323
|
-
- [Read more about `.ptbk.md` file format here](https://github.com/webgptorg/promptbook/discussions/categories/concepts?discussions_q=is%3Aopen+label%3A.ptbk.md+category%3AConcepts)
|
|
324
100
|
|
|
325
|
-
_Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
|
|
326
101
|
|
|
327
|
-
|
|
102
|
+
```markdown
|
|
103
|
+
# 🌟 My first Book
|
|
104
|
+
|
|
105
|
+
- PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
|
|
106
|
+
- KNOWLEDGE https://ptbk.io
|
|
107
|
+
- KNOWLEDGE ./promptbook.pdf
|
|
108
|
+
- EXPECT MIN 1 Sentence
|
|
109
|
+
- EXPECT MAX 1 Paragraph
|
|
110
|
+
|
|
111
|
+
> Write an article about the future of artificial intelligence in the next 10 years and how metalanguages will change the way AI is used in the world.
|
|
112
|
+
> Look specifically at the impact of Promptbook on the AI industry.
|
|
113
|
+
|
|
114
|
+
-> {article}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## 📦 Packages _(for developers)_
|
|
328
118
|
|
|
329
119
|
This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
330
120
|
You can install all of them at once:
|
|
@@ -366,8 +156,6 @@ Or you can install them separately:
|
|
|
366
156
|
|
|
367
157
|
The following glossary is used to clarify certain concepts:
|
|
368
158
|
|
|
369
|
-
|
|
370
|
-
|
|
371
159
|
### Core concepts
|
|
372
160
|
|
|
373
161
|
- [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|
|
@@ -398,8 +186,8 @@ The following glossary is used to clarify certain concepts:
|
|
|
398
186
|
|
|
399
187
|
## 🔌 Usage in Typescript / Javascript
|
|
400
188
|
|
|
401
|
-
- [Simple usage](./
|
|
402
|
-
- [Usage with client and remote server](./
|
|
189
|
+
- [Simple usage](./examples/usage/simple-script)
|
|
190
|
+
- [Usage with client and remote server](./examples/usage/remote)
|
|
403
191
|
|
|
404
192
|
## ➕➖ When to use Promptbook?
|
|
405
193
|
|
|
@@ -12,4 +12,4 @@ export type TemplateType = TupleToUnion<typeof TemplateTypes>;
|
|
|
12
12
|
* @see https://github.com/webgptorg/promptbook#template-type
|
|
13
13
|
* @public exported from `@promptbook/core`
|
|
14
14
|
*/
|
|
15
|
-
export declare const TemplateTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT_TEMPLATE", "DIALOG_TEMPLATE", "
|
|
15
|
+
export declare const TemplateTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT_TEMPLATE", "DIALOG_TEMPLATE", "EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];
|
|
@@ -121,7 +121,7 @@ export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
|
|
|
121
121
|
*
|
|
122
122
|
* @public exported from `@promptbook/core`
|
|
123
123
|
*/
|
|
124
|
-
export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "
|
|
124
|
+
export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "examples", "modelName", "currentDate"];
|
|
125
125
|
/**
|
|
126
126
|
* @@@
|
|
127
127
|
*
|
|
@@ -22,9 +22,9 @@ export type renderPipelineMermaidOptions = {
|
|
|
22
22
|
*/
|
|
23
23
|
export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
|
|
24
24
|
/**
|
|
25
|
-
* TODO:
|
|
26
|
-
* TODO:
|
|
27
|
-
* TODO:
|
|
25
|
+
* TODO: [🧠] !! FOREACH in mermaid graph
|
|
26
|
+
* TODO: [🧠] !! Knowledge in mermaid graph
|
|
27
|
+
* TODO: [🧠] !! Personas in mermaid graph
|
|
28
28
|
* TODO: Maybe use some Mermaid package instead of string templating
|
|
29
29
|
* TODO: [🕌] When more than 2 functionalities, split into separate functions
|
|
30
30
|
*/
|
|
@@ -9,7 +9,7 @@ import type { string_json } from '../../types/typeAliases';
|
|
|
9
9
|
*/
|
|
10
10
|
export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
|
|
11
11
|
/**
|
|
12
|
-
* TODO: [🐝] Not Working propperly @see https://promptbook.studio/
|
|
12
|
+
* TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.ptbk.md
|
|
13
13
|
* TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
|
|
14
14
|
* TODO: [🧠] Maybe more elegant solution than replacing via regex
|
|
15
15
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -7,7 +7,7 @@ import type { string_json } from '../../types/typeAliases';
|
|
|
7
7
|
* Note: Using here custom import to work in jest tests
|
|
8
8
|
* Note: Using sync version is 💩 in the production code, but it's ok here in tests
|
|
9
9
|
*
|
|
10
|
-
* @param path - The path to the file relative to
|
|
10
|
+
* @param path - The path to the file relative to examples/pipelines directory
|
|
11
11
|
* @private internal function of tests
|
|
12
12
|
*/
|
|
13
13
|
export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
|
|
@@ -20,7 +20,7 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
|
|
|
20
20
|
*/
|
|
21
21
|
export declare function validatePipelineCore(pipeline: PipelineJson): void;
|
|
22
22
|
/**
|
|
23
|
-
* TODO:
|
|
23
|
+
* TODO: !! [🧞♀️] Do not allow joker + foreach
|
|
24
24
|
* TODO: [🧠] Work with promptbookVersion
|
|
25
25
|
* TODO: Use here some json-schema, Zod or something similar and change it to:
|
|
26
26
|
* > /**
|
|
@@ -32,7 +32,7 @@ export declare function validatePipelineCore(pipeline: PipelineJson): void;
|
|
|
32
32
|
* > ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
|
|
33
33
|
*/
|
|
34
34
|
/**
|
|
35
|
-
* TODO: [🧳][main] !!!! Validate that all
|
|
35
|
+
* TODO: [🧳][main] !!!! Validate that all examples match expectations
|
|
36
36
|
* TODO: [🧳][🐝][main] !!!! Validate that knowledge is valid (non-void)
|
|
37
37
|
* TODO: [🧳][main] !!!! Validate that persona can be used only with CHAT variant
|
|
38
38
|
* TODO: [🧳][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
|
|
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
|
|
|
7
7
|
*
|
|
8
8
|
* @private internal utility of `createPipelineExecutor`
|
|
9
9
|
*/
|
|
10
|
-
export declare function
|
|
10
|
+
export declare function getExamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
|
|
@@ -15,7 +15,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
|
|
|
15
15
|
/**
|
|
16
16
|
* The name of the format used in .ptbk.md files
|
|
17
17
|
*
|
|
18
|
-
* @
|
|
18
|
+
* @example "JSON"
|
|
19
19
|
*/
|
|
20
20
|
readonly formatName: string_name & string_SCREAMING_CASE;
|
|
21
21
|
/**
|
|
@@ -25,7 +25,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
|
|
|
25
25
|
/**
|
|
26
26
|
* The mime type of the format (if any)
|
|
27
27
|
*
|
|
28
|
-
* @
|
|
28
|
+
* @example "application/json"
|
|
29
29
|
*/
|
|
30
30
|
readonly mimeType?: string_mime_type;
|
|
31
31
|
/**
|
|
@@ -11,7 +11,7 @@ export type FormatSubvalueDefinition<TValue extends string, TSettings extends em
|
|
|
11
11
|
/**
|
|
12
12
|
* The name of the format used in .ptbk.md files
|
|
13
13
|
*
|
|
14
|
-
* @
|
|
14
|
+
* @example "CELL"
|
|
15
15
|
*/
|
|
16
16
|
readonly subvalueName: string_name & string_SCREAMING_CASE;
|
|
17
17
|
/**
|
|
@@ -10,7 +10,7 @@ import type { string_persona_description } from '../types/typeAliases';
|
|
|
10
10
|
*/
|
|
11
11
|
export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
|
|
12
12
|
/**
|
|
13
|
-
* TODO: [🔃][main]
|
|
13
|
+
* TODO: [🔃][main] !! If the persona was prepared with different version or different set of models, prepare it once again
|
|
14
14
|
* TODO: [🏢] !! Check validity of `modelName` in pipeline
|
|
15
15
|
* TODO: [🏢] !! Check validity of `systemMessage` in pipeline
|
|
16
16
|
* TODO: [🏢] !! Check validity of `temperature` in pipeline
|
|
@@ -6,11 +6,11 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
|
|
8
8
|
/**
|
|
9
|
-
* TODO: [🔃][main]
|
|
9
|
+
* TODO: [🔃][main] !! If the pipeline was prepared with different version or different set of models, prepare it once again
|
|
10
10
|
* TODO: [🐠] Maybe base this on `makeValidator`
|
|
11
11
|
* TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
|
|
12
12
|
* TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
|
|
13
13
|
* - [🏍] ? Is context in each template
|
|
14
|
-
* - [♨] Are
|
|
14
|
+
* - [♨] Are examples prepared
|
|
15
15
|
* - [♨] Are templates prepared
|
|
16
16
|
*/
|
|
@@ -24,7 +24,7 @@ export {};
|
|
|
24
24
|
/**
|
|
25
25
|
* TODO: [🧠] Add context to each template (if missing)
|
|
26
26
|
* TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
|
|
27
|
-
* TODO: [♨][main] !!! Prepare index the
|
|
27
|
+
* TODO: [♨][main] !!! Prepare index the examples and maybe templates
|
|
28
28
|
* TODO: Write tests for `preparePipeline`
|
|
29
29
|
* TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
|
|
30
30
|
* TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
|
|
@@ -27,10 +27,10 @@ export type ParameterJson = {
|
|
|
27
27
|
*/
|
|
28
28
|
readonly description?: string_markdown_text;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Example values of the parameter
|
|
31
31
|
* Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
|
|
32
32
|
*/
|
|
33
|
-
readonly
|
|
33
|
+
readonly exampleValues?: Array<string_parameter_value>;
|
|
34
34
|
};
|
|
35
35
|
/**
|
|
36
36
|
* TODO: [🧠] Should be here registered subparameters from foreach or not?
|
|
@@ -18,5 +18,5 @@ export type PreparationJson = {
|
|
|
18
18
|
/**
|
|
19
19
|
* TODO: [🍙] Make some standard order of json properties
|
|
20
20
|
* TODO: Maybe put here used `modelName`
|
|
21
|
-
* TODO: [🍥] When using `date` it changes all
|
|
21
|
+
* TODO: [🍥] When using `date` it changes all examples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
|
|
22
22
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/types",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.73.0",
|
|
4
4
|
"description": "Supercharge your use of large language models",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -31,7 +31,8 @@
|
|
|
31
31
|
"o1",
|
|
32
32
|
"o1-mini",
|
|
33
33
|
"o1-preview",
|
|
34
|
-
"anthropic"
|
|
34
|
+
"anthropic",
|
|
35
|
+
"LLMOps"
|
|
35
36
|
],
|
|
36
37
|
"license": "CC-BY-4.0",
|
|
37
38
|
"bugs": {
|
|
@@ -50,6 +51,6 @@
|
|
|
50
51
|
],
|
|
51
52
|
"typings": "./esm/typings/src/_packages/types.index.d.ts",
|
|
52
53
|
"peerDependencies": {
|
|
53
|
-
"@promptbook/core": "0.
|
|
54
|
+
"@promptbook/core": "0.73.0"
|
|
54
55
|
}
|
|
55
56
|
}
|