@promptbook/browser 0.74.0-5 → 0.74.0-6

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
@@ -56,8 +56,6 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
56
56
 
57
57
  ## 🤍 The Promptbook Whitepaper
58
58
 
59
-
60
-
61
59
  If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
62
60
 
63
61
  But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd resp0nses**. When this happens, you generally have three options:
@@ -126,23 +124,17 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
126
124
 
127
125
  ## 💙 Book language _(for prompt-engineer)_
128
126
 
129
- Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) are written in markdown-like language called [Book](https://github.com/webgptorg/book). It is designed to be understandable by non-programmers and non-technical people.
130
-
131
127
 
132
128
 
133
- ```markdown
134
- # 🌟 My first Book
135
129
 
136
- - INPUT PARAMETER {subject}
137
- - OUTPUT PARAMETER {article}
130
+ ## 💙 The blueprint of book language
138
131
 
139
- ## Sample subject
132
+ Following is the documentation and blueprint of the Book language.
140
133
 
141
- > Promptbook
134
+ ### Example
142
135
 
143
- -> {subject}
144
-
145
- ## Write an article
136
+ ```markdown
137
+ # 🌟 My first Book
146
138
 
147
139
  - PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
148
140
  - KNOWLEDGE https://ptbk.io
@@ -151,11 +143,65 @@ Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) a
151
143
  - EXPECT MAX 1 Paragraph
152
144
 
153
145
  > 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.
154
- > Look specifically at the impact of {subject} on the AI industry.
146
+ > Look specifically at the impact of Promptbook on the AI industry.
155
147
 
156
148
  -> {article}
157
149
  ```
158
150
 
151
+ ### Goals and principles of book language
152
+
153
+ File is designed to be easy to read and write. It is strict subset of markdown. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
154
+
155
+ It has file with `.ptbk.md` or `.book` extension with `UTF-8` non BOM encoding.
156
+
157
+ As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
158
+
159
+ But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
160
+
161
+ ### Structure
162
+
163
+ Book is divided into sections. Each section starts with heading. The language itself is not sensitive to the type of heading _(`h1`, `h2`, `h3`, ...)_ but it is recommended to use `h1` for header section and `h2` for other sections.
164
+
165
+ ### Header
166
+
167
+ Header is the first section of the book. It contains metadata about the pipeline. It is recommended to use `h1` heading for header section but it is not required.
168
+
169
+ ### Parameter
170
+
171
+ Foo bar
172
+
173
+ #### Parameter names
174
+
175
+ Reserved words:
176
+
177
+ - _each command_ like `PERSONA`, `EXPECT`, `KNOWLEDGE`, etc.
178
+ - `content`
179
+ - `context`
180
+ - `knowledge`
181
+ - `examples`
182
+ - `modelName`
183
+ - `currentDate`
184
+
185
+ #### Parameter notation
186
+
187
+ ### Template
188
+
189
+ Todo todo
190
+
191
+ ### Command
192
+
193
+ Todo todo
194
+
195
+ ### Block
196
+
197
+ Todo todo
198
+
199
+ ### Return parameter
200
+
201
+ ### Examples
202
+
203
+
204
+
159
205
  ## 📦 Packages _(for developers)_
160
206
 
161
207
  This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
package/esm/index.es.js CHANGED
@@ -13,7 +13,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
13
13
  *
14
14
  * @see https://github.com/webgptorg/promptbook
15
15
  */
16
- var PROMPTBOOK_ENGINE_VERSION = '0.74.0-4';
16
+ var PROMPTBOOK_ENGINE_VERSION = '0.74.0-5';
17
17
  /**
18
18
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
19
19
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/browser",
3
- "version": "0.74.0-5",
3
+ "version": "0.74.0-6",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -53,7 +53,7 @@
53
53
  "module": "./esm/index.es.js",
54
54
  "typings": "./esm/typings/src/_packages/browser.index.d.ts",
55
55
  "peerDependencies": {
56
- "@promptbook/core": "0.74.0-5"
56
+ "@promptbook/core": "0.74.0-6"
57
57
  },
58
58
  "dependencies": {
59
59
  "spacetrim": "0.11.59"
package/umd/index.umd.js CHANGED
@@ -20,7 +20,7 @@
20
20
  *
21
21
  * @see https://github.com/webgptorg/promptbook
22
22
  */
23
- var PROMPTBOOK_ENGINE_VERSION = '0.74.0-4';
23
+ var PROMPTBOOK_ENGINE_VERSION = '0.74.0-5';
24
24
  /**
25
25
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
26
26
  */