@promptbook/types 0.73.0 → 0.74.0-0

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 +60 -1
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -24,6 +24,10 @@ Build responsible, controlled and transparent applications on top of LLM models!
24
24
 
25
25
 
26
26
 
27
+ <blockquote style="color: #ff8811">
28
+ <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
29
+ </blockquote>
30
+
27
31
  ## 📦 Package `@promptbook/types`
28
32
 
29
33
  - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -73,6 +77,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
73
77
 
74
78
  ## 🤍 The Promptbook Whitepaper
75
79
 
80
+
81
+
76
82
  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.
77
83
 
78
84
  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:
@@ -93,6 +99,44 @@ In all of these situations, but especially in 3., the **✨ Promptbook can make
93
99
 
94
100
 
95
101
 
102
+ ## 💜 The Promptbook Project
103
+
104
+
105
+
106
+ <table>
107
+ <tbody>
108
+ <tr>
109
+ <td>Promptbook whitepaper</td>
110
+ <td>Basic motivations and problems which we are trying to solve</td>
111
+ <td rowspan=3>https://github.com/webgptorg/book</td>
112
+ </tr>
113
+ <tr>
114
+ <td>Promptbook <i>(system)</i></td>
115
+ <td>Promptbook ...</td>
116
+ </tr>
117
+ <tr>
118
+ <td>Book language</td>
119
+ <td>
120
+ Book is a markdown-like language to define projects, pipelines, knowledge,... in the Promptbook system. It is designed to be understandable by non-programmers and non-technical people
121
+ </td>
122
+ </tr>
123
+ <tr>
124
+ <td>Promptbook typescript project</td>
125
+ <td>Implementation of Promptbook in TypeScript published into multiple packages to NPM</td>
126
+ <td>https://github.com/webgptorg/promptbook</td>
127
+ </tr>
128
+ <tr>
129
+ <td>Promptbook studio</td>
130
+ <td>Promptbook studio</td>
131
+ <td rowspan=2>https://github.com/hejny/promptbook-studio</td>
132
+ </tr>
133
+ <tr>
134
+ <td>Promptbook miniapps</td>
135
+ <td>Promptbook miniapps</td>
136
+ </tr>
137
+ </tbody>
138
+ </table>
139
+
96
140
  ## 💙 Book language _(for prompt-engineer)_
97
141
 
98
142
  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.
@@ -102,6 +146,17 @@ Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) a
102
146
  ```markdown
103
147
  # 🌟 My first Book
104
148
 
149
+ - INPUT PARAMETER {subject}
150
+ - OUTPUT PARAMETER {article}
151
+
152
+ ## Sample subject
153
+
154
+ > Promptbook
155
+
156
+ -> {subject}
157
+
158
+ ## Write an article
159
+
105
160
  - PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
106
161
  - KNOWLEDGE https://ptbk.io
107
162
  - KNOWLEDGE ./promptbook.pdf
@@ -109,7 +164,7 @@ Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) a
109
164
  - EXPECT MAX 1 Paragraph
110
165
 
111
166
  > 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.
112
- > Look specifically at the impact of Promptbook on the AI industry.
167
+ > Look specifically at the impact of {subject} on the AI industry.
113
168
 
114
169
  -> {article}
115
170
  ```
@@ -156,6 +211,10 @@ Or you can install them separately:
156
211
 
157
212
  The following glossary is used to clarify certain concepts:
158
213
 
214
+ ### Basic terms
215
+
216
+
217
+
159
218
  ### Core concepts
160
219
 
161
220
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/types",
3
- "version": "0.73.0",
3
+ "version": "0.74.0-0",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -51,6 +51,6 @@
51
51
  ],
52
52
  "typings": "./esm/typings/src/_packages/types.index.d.ts",
53
53
  "peerDependencies": {
54
- "@promptbook/core": "0.73.0"
54
+ "@promptbook/core": "0.74.0-0"
55
55
  }
56
56
  }