@promptbook/google 0.86.8 β 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 +38 -46
- package/esm/index.es.js +339 -437
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/types.index.d.ts +2 -0
- package/esm/typings/src/conversion/archive/loadArchive.d.ts +16 -0
- package/esm/typings/src/conversion/archive/saveArchive.d.ts +18 -0
- package/esm/typings/src/conversion/utils/extractVariablesFromScript.d.ts +5 -5
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +3 -10
- 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 +339 -437
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.test.d.ts +0 -1
package/README.md
CHANGED
|
@@ -330,9 +330,7 @@ And **Promptbook.city** branded socials:
|
|
|
330
330
|
_/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
331
331
|
|
|
332
332
|
- [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
|
|
333
|
-
- [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
|
|
334
|
-
|
|
335
|
-
##
|
|
333
|
+
- [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
|
|
336
334
|
|
|
337
335
|
|
|
338
336
|
|
|
@@ -343,7 +341,9 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
|
343
341
|
|
|
344
342
|
|
|
345
343
|
|
|
346
|
-
Following is the documentation and blueprint of the Book language.
|
|
344
|
+
Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
|
|
345
|
+
|
|
346
|
+
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.
|
|
347
347
|
|
|
348
348
|
### Example
|
|
349
349
|
|
|
@@ -351,35 +351,56 @@ Following is the documentation and blueprint of the Book language.
|
|
|
351
351
|
# π My first Book
|
|
352
352
|
|
|
353
353
|
- BOOK VERSION 1.0.0
|
|
354
|
-
- URL https://promptbook.studio/
|
|
354
|
+
- URL https://promptbook.studio/hello.book
|
|
355
|
+
- INPUT PARAMETER {topic}
|
|
356
|
+
- OUTPUT PARAMETER {article}
|
|
355
357
|
|
|
356
358
|
# Write an article
|
|
357
359
|
|
|
358
360
|
- PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
|
|
359
|
-
- KNOWLEDGE https://
|
|
360
|
-
- KNOWLEDGE ./
|
|
361
|
+
- KNOWLEDGE https://wikipedia.org/
|
|
362
|
+
- KNOWLEDGE ./journalist-ethics.pdf
|
|
361
363
|
- EXPECT MIN 1 Sentence
|
|
362
|
-
- EXPECT MAX
|
|
364
|
+
- EXPECT MAX 5 Pages
|
|
363
365
|
|
|
364
|
-
> Write an article about
|
|
365
|
-
> Look specifically at the impact of Promptbook on the AI industry.
|
|
366
|
+
> Write an article about {topic}
|
|
366
367
|
|
|
367
368
|
-> {article}
|
|
368
369
|
```
|
|
369
370
|
|
|
371
|
+
Each part of the book defines one of 3 circles:
|
|
372
|
+
|
|
370
373
|
### **What:** Workflows, Tasks and Parameters
|
|
371
374
|
|
|
375
|
+
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.
|
|
376
|
+
|
|
377
|
+
**Related commands:**
|
|
378
|
+
|
|
372
379
|
- [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
|
|
373
380
|
|
|
374
381
|
### **Who:** Personas
|
|
375
382
|
|
|
383
|
+
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.
|
|
384
|
+
|
|
385
|
+
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",...`.
|
|
386
|
+
|
|
387
|
+
Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
|
|
388
|
+
|
|
389
|
+
**Related commands:**
|
|
390
|
+
|
|
376
391
|
- [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
|
|
377
392
|
|
|
393
|
+
|
|
394
|
+
|
|
378
395
|
### **How:** Knowledge, Instruments and Actions
|
|
379
396
|
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
397
|
+
The resources used by the personas are used to do the work.
|
|
398
|
+
|
|
399
|
+
**Related commands:**
|
|
400
|
+
|
|
401
|
+
- [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
|
|
402
|
+
- [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.
|
|
403
|
+
- [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
|
|
383
404
|
|
|
384
405
|
### General principles of book language
|
|
385
406
|
|
|
@@ -470,35 +491,7 @@ The following glossary is used to clarify certain concepts:
|
|
|
470
491
|
|
|
471
492
|
_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
472
493
|
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
- **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).
|
|
476
|
-
- **Jobs**
|
|
477
|
-
- **Task**
|
|
478
|
-
- **Subtask**
|
|
479
|
-
- **Workforce**
|
|
480
|
-
- **Persona**
|
|
481
|
-
- **Team**
|
|
482
|
-
- **Role**
|
|
483
|
-
- **Knowledge**
|
|
484
|
-
- **Public**
|
|
485
|
-
- **Private**
|
|
486
|
-
- **Protected**
|
|
487
|
-
- **Instruments**
|
|
488
|
-
- **Actions**
|
|
489
|
-
|
|
490
|
-
#### Book language
|
|
491
|
-
|
|
492
|
-
- **Book file**
|
|
493
|
-
- **Section**
|
|
494
|
-
- **Heading**
|
|
495
|
-
- **Description**
|
|
496
|
-
- **Command**
|
|
497
|
-
- **Block**
|
|
498
|
-
- **Return statement**
|
|
499
|
-
- **Comment**
|
|
500
|
-
- **Import**
|
|
501
|
-
- **Scope**
|
|
494
|
+
|
|
502
495
|
|
|
503
496
|
#### π― Core concepts
|
|
504
497
|
|
|
@@ -595,7 +588,7 @@ See [CHANGELOG.md](./CHANGELOG.md)
|
|
|
595
588
|
|
|
596
589
|
## π License
|
|
597
590
|
|
|
598
|
-
|
|
591
|
+
Promptbook project is under [BUSL 1.1 is an SPDX license](https://spdx.org/licenses/BUSL-1.1.html)
|
|
599
592
|
|
|
600
593
|
## π― Todos
|
|
601
594
|
|
|
@@ -603,7 +596,6 @@ See [TODO.md](./TODO.md)
|
|
|
603
596
|
|
|
604
597
|
|
|
605
598
|
|
|
606
|
-
|
|
607
599
|
## π€ Partners
|
|
608
600
|
|
|
609
601
|
<div style="display: flex; align-items: center; gap: 20px;">
|
|
@@ -620,6 +612,6 @@ See [TODO.md](./TODO.md)
|
|
|
620
612
|
|
|
621
613
|
## ποΈ Contributing
|
|
622
614
|
|
|
623
|
-
|
|
615
|
+
We are open to pull requests, feedback, and suggestions.
|
|
624
616
|
|
|
625
|
-
You can also β star the
|
|
617
|
+
You can also β star the project, [follow us on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).
|