@promptbook/azure-openai 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
@@ -338,9 +338,7 @@ And **Promptbook.city** branded socials:
338
338
  _/Sub-brand for images and graphics generated via Promptbook prompting/_
339
339
 
340
340
  - [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
341
- - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
342
-
343
- ##
341
+ - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
344
342
 
345
343
 
346
344
 
@@ -351,7 +349,9 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
351
349
 
352
350
 
353
351
 
354
- Following is the documentation and blueprint of the Book language.
352
+ Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
353
+
354
+ 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.
355
355
 
356
356
  ### Example
357
357
 
@@ -359,35 +359,56 @@ Following is the documentation and blueprint of the Book language.
359
359
  # 🌟 My first Book
360
360
 
361
361
  - BOOK VERSION 1.0.0
362
- - URL https://promptbook.studio/my-first-book/
362
+ - URL https://promptbook.studio/hello.book
363
+ - INPUT PARAMETER {topic}
364
+ - OUTPUT PARAMETER {article}
363
365
 
364
366
  # Write an article
365
367
 
366
368
  - PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
367
- - KNOWLEDGE https://ptbk.io
368
- - KNOWLEDGE ./promptbook.pdf
369
+ - KNOWLEDGE https://wikipedia.org/
370
+ - KNOWLEDGE ./journalist-ethics.pdf
369
371
  - EXPECT MIN 1 Sentence
370
- - EXPECT MAX 1 Paragraph
372
+ - EXPECT MAX 5 Pages
371
373
 
372
- > 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.
373
- > Look specifically at the impact of Promptbook on the AI industry.
374
+ > Write an article about {topic}
374
375
 
375
376
  -> {article}
376
377
  ```
377
378
 
379
+ Each part of the book defines one of 3 circles:
380
+
378
381
  ### **What:** Workflows, Tasks and Parameters
379
382
 
383
+ 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.
384
+
385
+ **Related commands:**
386
+
380
387
  - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
381
388
 
382
389
  ### **Who:** Personas
383
390
 
391
+ 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.
392
+
393
+ 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",...`.
394
+
395
+ Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
396
+
397
+ **Related commands:**
398
+
384
399
  - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
385
400
 
401
+
402
+
386
403
  ### **How:** Knowledge, Instruments and Actions
387
404
 
388
- - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md)
389
- - [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md)
390
- - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md)
405
+ The resources used by the personas are used to do the work.
406
+
407
+ **Related commands:**
408
+
409
+ - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
410
+ - [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.
411
+ - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
391
412
 
392
413
  ### General principles of book language
393
414
 
@@ -478,35 +499,7 @@ The following glossary is used to clarify certain concepts:
478
499
 
479
500
  _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
480
501
 
481
- #### Promptbook core
482
-
483
- - **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).
484
- - **Jobs**
485
- - **Task**
486
- - **Subtask**
487
- - **Workforce**
488
- - **Persona**
489
- - **Team**
490
- - **Role**
491
- - **Knowledge**
492
- - **Public**
493
- - **Private**
494
- - **Protected**
495
- - **Instruments**
496
- - **Actions**
497
-
498
- #### Book language
499
-
500
- - **Book file**
501
- - **Section**
502
- - **Heading**
503
- - **Description**
504
- - **Command**
505
- - **Block**
506
- - **Return statement**
507
- - **Comment**
508
- - **Import**
509
- - **Scope**
502
+
510
503
 
511
504
  #### 💯 Core concepts
512
505