@promptbook/cli 0.86.10 → 0.86.30

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 CHANGED
@@ -195,9 +195,7 @@ And **Promptbook.city** branded socials:
195
195
  _/Sub-brand for images and graphics generated via Promptbook prompting/_
196
196
 
197
197
  - [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
198
- - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
199
-
200
- ##
198
+ - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
201
199
 
202
200
 
203
201
 
@@ -208,7 +206,9 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
208
206
 
209
207
 
210
208
 
211
- Following is the documentation and blueprint of the Book language.
209
+ Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
210
+
211
+ 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.
212
212
 
213
213
  ### Example
214
214
 
@@ -216,35 +216,56 @@ Following is the documentation and blueprint of the Book language.
216
216
  # 🌟 My first Book
217
217
 
218
218
  - BOOK VERSION 1.0.0
219
- - URL https://promptbook.studio/my-first-book/
219
+ - URL https://promptbook.studio/hello.book
220
+ - INPUT PARAMETER {topic}
221
+ - OUTPUT PARAMETER {article}
220
222
 
221
223
  # Write an article
222
224
 
223
225
  - PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
224
- - KNOWLEDGE https://ptbk.io
225
- - KNOWLEDGE ./promptbook.pdf
226
+ - KNOWLEDGE https://wikipedia.org/
227
+ - KNOWLEDGE ./journalist-ethics.pdf
226
228
  - EXPECT MIN 1 Sentence
227
- - EXPECT MAX 1 Paragraph
229
+ - EXPECT MAX 5 Pages
228
230
 
229
- > 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.
230
- > Look specifically at the impact of Promptbook on the AI industry.
231
+ > Write an article about {topic}
231
232
 
232
233
  -> {article}
233
234
  ```
234
235
 
236
+ Each part of the book defines one of 3 circles:
237
+
235
238
  ### **What:** Workflows, Tasks and Parameters
236
239
 
240
+ 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.
241
+
242
+ **Related commands:**
243
+
237
244
  - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
238
245
 
239
246
  ### **Who:** Personas
240
247
 
248
+ 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.
249
+
250
+ 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",...`.
251
+
252
+ Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
253
+
254
+ **Related commands:**
255
+
241
256
  - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
242
257
 
258
+
259
+
243
260
  ### **How:** Knowledge, Instruments and Actions
244
261
 
245
- - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md)
246
- - [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md)
247
- - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md)
262
+ The resources used by the personas are used to do the work.
263
+
264
+ **Related commands:**
265
+
266
+ - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
267
+ - [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.
268
+ - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
248
269
 
249
270
  ### General principles of book language
250
271
 
@@ -335,35 +356,7 @@ The following glossary is used to clarify certain concepts:
335
356
 
336
357
  _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
337
358
 
338
- #### Promptbook core
339
-
340
- - **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).
341
- - **Jobs**
342
- - **Task**
343
- - **Subtask**
344
- - **Workforce**
345
- - **Persona**
346
- - **Team**
347
- - **Role**
348
- - **Knowledge**
349
- - **Public**
350
- - **Private**
351
- - **Protected**
352
- - **Instruments**
353
- - **Actions**
354
-
355
- #### Book language
356
-
357
- - **Book file**
358
- - **Section**
359
- - **Heading**
360
- - **Description**
361
- - **Command**
362
- - **Block**
363
- - **Return statement**
364
- - **Comment**
365
- - **Import**
366
- - **Scope**
359
+
367
360
 
368
361
  #### 💯 Core concepts
369
362