ptbk 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.
Files changed (2) hide show
  1. package/README.md +35 -42
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -121,9 +121,7 @@ And **Promptbook.city** branded socials:
121
121
  _/Sub-brand for images and graphics generated via Promptbook prompting/_
122
122
 
123
123
  - [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
124
- - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
125
-
126
- ##
124
+ - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
127
125
 
128
126
 
129
127
 
@@ -134,7 +132,9 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
134
132
 
135
133
 
136
134
 
137
- Following is the documentation and blueprint of the Book language.
135
+ Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
136
+
137
+ 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.
138
138
 
139
139
  ### Example
140
140
 
@@ -142,35 +142,56 @@ Following is the documentation and blueprint of the Book language.
142
142
  # 🌟 My first Book
143
143
 
144
144
  - BOOK VERSION 1.0.0
145
- - URL https://promptbook.studio/my-first-book/
145
+ - URL https://promptbook.studio/hello.book
146
+ - INPUT PARAMETER {topic}
147
+ - OUTPUT PARAMETER {article}
146
148
 
147
149
  # Write an article
148
150
 
149
151
  - PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
150
- - KNOWLEDGE https://ptbk.io
151
- - KNOWLEDGE ./promptbook.pdf
152
+ - KNOWLEDGE https://wikipedia.org/
153
+ - KNOWLEDGE ./journalist-ethics.pdf
152
154
  - EXPECT MIN 1 Sentence
153
- - EXPECT MAX 1 Paragraph
155
+ - EXPECT MAX 5 Pages
154
156
 
155
- > 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.
156
- > Look specifically at the impact of Promptbook on the AI industry.
157
+ > Write an article about {topic}
157
158
 
158
159
  -> {article}
159
160
  ```
160
161
 
162
+ Each part of the book defines one of 3 circles:
163
+
161
164
  ### **What:** Workflows, Tasks and Parameters
162
165
 
166
+ 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.
167
+
168
+ **Related commands:**
169
+
163
170
  - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
164
171
 
165
172
  ### **Who:** Personas
166
173
 
174
+ 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.
175
+
176
+ 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",...`.
177
+
178
+ Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
179
+
180
+ **Related commands:**
181
+
167
182
  - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
168
183
 
184
+
185
+
169
186
  ### **How:** Knowledge, Instruments and Actions
170
187
 
171
- - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md)
172
- - [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md)
173
- - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md)
188
+ The resources used by the personas are used to do the work.
189
+
190
+ **Related commands:**
191
+
192
+ - [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
193
+ - [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.
194
+ - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
174
195
 
175
196
  ### General principles of book language
176
197
 
@@ -261,35 +282,7 @@ The following glossary is used to clarify certain concepts:
261
282
 
262
283
  _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
263
284
 
264
- #### Promptbook core
265
-
266
- - **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).
267
- - **Jobs**
268
- - **Task**
269
- - **Subtask**
270
- - **Workforce**
271
- - **Persona**
272
- - **Team**
273
- - **Role**
274
- - **Knowledge**
275
- - **Public**
276
- - **Private**
277
- - **Protected**
278
- - **Instruments**
279
- - **Actions**
280
-
281
- #### Book language
282
-
283
- - **Book file**
284
- - **Section**
285
- - **Heading**
286
- - **Description**
287
- - **Command**
288
- - **Block**
289
- - **Return statement**
290
- - **Comment**
291
- - **Import**
292
- - **Scope**
285
+
293
286
 
294
287
  #### 💯 Core concepts
295
288
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ptbk",
3
- "version": "0.86.10",
3
+ "version": "0.86.22",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -44,10 +44,10 @@
44
44
  },
45
45
  "homepage": "https://ptbk.io/",
46
46
  "peerDependencies": {
47
- "@promptbook/core": "0.86.10"
47
+ "@promptbook/core": "0.86.22"
48
48
  },
49
49
  "dependencies": {
50
- "promptbook": "0.86.10"
50
+ "promptbook": "0.86.22"
51
51
  },
52
52
  "bin": {
53
53
  "ptbk": "bin/promptbook-cli-proxy.js"