@promptbook/vercel 0.86.10 → 0.86.22
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 +35 -42
- package/esm/index.es.js +256 -364
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/types.index.d.ts +2 -0
- package/esm/typings/src/conversion/utils/extractVariablesFromScript.d.ts +5 -5
- package/esm/typings/src/execution/AbstractTaskResult.d.ts +3 -3
- package/esm/typings/src/execution/PipelineExecutorResult.d.ts +1 -1
- package/esm/typings/src/execution/utils/usageToHuman.d.ts +11 -1
- package/esm/typings/src/execution/utils/usageToWorktime.d.ts +9 -1
- package/esm/typings/src/formats/_common/FormatDefinition.d.ts +1 -1
- package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +1 -1
- package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +1 -1
- package/esm/typings/src/types/typeAliases.d.ts +6 -0
- package/package.json +2 -2
- package/umd/index.umd.js +256 -364
- package/umd/index.umd.js.map +1 -1
package/README.md
CHANGED
|
@@ -201,9 +201,7 @@ And **Promptbook.city** branded socials:
|
|
|
201
201
|
_/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
202
202
|
|
|
203
203
|
- [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
|
|
204
|
-
- [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
|
|
205
|
-
|
|
206
|
-
##
|
|
204
|
+
- [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
|
|
207
205
|
|
|
208
206
|
|
|
209
207
|
|
|
@@ -214,7 +212,9 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
|
214
212
|
|
|
215
213
|
|
|
216
214
|
|
|
217
|
-
Following is the documentation and blueprint of the Book language.
|
|
215
|
+
Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
|
|
216
|
+
|
|
217
|
+
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.
|
|
218
218
|
|
|
219
219
|
### Example
|
|
220
220
|
|
|
@@ -222,35 +222,56 @@ Following is the documentation and blueprint of the Book language.
|
|
|
222
222
|
# 🌟 My first Book
|
|
223
223
|
|
|
224
224
|
- BOOK VERSION 1.0.0
|
|
225
|
-
- URL https://promptbook.studio/
|
|
225
|
+
- URL https://promptbook.studio/hello.book
|
|
226
|
+
- INPUT PARAMETER {topic}
|
|
227
|
+
- OUTPUT PARAMETER {article}
|
|
226
228
|
|
|
227
229
|
# Write an article
|
|
228
230
|
|
|
229
231
|
- PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
|
|
230
|
-
- KNOWLEDGE https://
|
|
231
|
-
- KNOWLEDGE ./
|
|
232
|
+
- KNOWLEDGE https://wikipedia.org/
|
|
233
|
+
- KNOWLEDGE ./journalist-ethics.pdf
|
|
232
234
|
- EXPECT MIN 1 Sentence
|
|
233
|
-
- EXPECT MAX
|
|
235
|
+
- EXPECT MAX 5 Pages
|
|
234
236
|
|
|
235
|
-
> Write an article about
|
|
236
|
-
> Look specifically at the impact of Promptbook on the AI industry.
|
|
237
|
+
> Write an article about {topic}
|
|
237
238
|
|
|
238
239
|
-> {article}
|
|
239
240
|
```
|
|
240
241
|
|
|
242
|
+
Each part of the book defines one of 3 circles:
|
|
243
|
+
|
|
241
244
|
### **What:** Workflows, Tasks and Parameters
|
|
242
245
|
|
|
246
|
+
What work needs to be done. Each book defines a workflow, which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
|
|
247
|
+
|
|
248
|
+
**Related commands:**
|
|
249
|
+
|
|
243
250
|
- [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
|
|
244
251
|
|
|
245
252
|
### **Who:** Personas
|
|
246
253
|
|
|
254
|
+
Who does the work. Each task is performed by a persona. A persona is a description of your virtual employee. It is a higher abstraction than the model, tokens, temperature, top-k, top-p and other model parameters.
|
|
255
|
+
|
|
256
|
+
You can describe what you want in human language like `Jane, creative writer with a sense of sharp humour` instead of `gpt-4-2024-13-31, temperature 1.2, top-k 40, STOP token ".\n",...`.
|
|
257
|
+
|
|
258
|
+
Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
|
|
259
|
+
|
|
260
|
+
**Related commands:**
|
|
261
|
+
|
|
247
262
|
- [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
|
|
248
263
|
|
|
264
|
+
|
|
265
|
+
|
|
249
266
|
### **How:** Knowledge, Instruments and Actions
|
|
250
267
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
268
|
+
The resources used by the personas are used to do the work.
|
|
269
|
+
|
|
270
|
+
**Related commands:**
|
|
271
|
+
|
|
272
|
+
- [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
|
|
273
|
+
- [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md) for real-time data like time, location, weather, stock prices, searching the internet, calculations, etc.
|
|
274
|
+
- [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
|
|
254
275
|
|
|
255
276
|
### General principles of book language
|
|
256
277
|
|
|
@@ -341,35 +362,7 @@ The following glossary is used to clarify certain concepts:
|
|
|
341
362
|
|
|
342
363
|
_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
343
364
|
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
- **Organization** _(legacy name collection)_ group jobs, workforce, knowledge, instruments, and actions into one package. Entities in one organization can share resources (= import resources from each other).
|
|
347
|
-
- **Jobs**
|
|
348
|
-
- **Task**
|
|
349
|
-
- **Subtask**
|
|
350
|
-
- **Workforce**
|
|
351
|
-
- **Persona**
|
|
352
|
-
- **Team**
|
|
353
|
-
- **Role**
|
|
354
|
-
- **Knowledge**
|
|
355
|
-
- **Public**
|
|
356
|
-
- **Private**
|
|
357
|
-
- **Protected**
|
|
358
|
-
- **Instruments**
|
|
359
|
-
- **Actions**
|
|
360
|
-
|
|
361
|
-
#### Book language
|
|
362
|
-
|
|
363
|
-
- **Book file**
|
|
364
|
-
- **Section**
|
|
365
|
-
- **Heading**
|
|
366
|
-
- **Description**
|
|
367
|
-
- **Command**
|
|
368
|
-
- **Block**
|
|
369
|
-
- **Return statement**
|
|
370
|
-
- **Comment**
|
|
371
|
-
- **Import**
|
|
372
|
-
- **Scope**
|
|
365
|
+
|
|
373
366
|
|
|
374
367
|
#### 💯 Core concepts
|
|
375
368
|
|