@promptbook/vercel 0.92.0 → 0.93.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.
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
2
2
 
3
- # ✨ Promptbook
3
+ # ✨ Promptbook: AI apps in plain Language
4
+
5
+ Write AI applications using plain human language across multiple models and platforms.
4
6
 
5
7
 
6
8
 
@@ -8,18 +10,18 @@
8
10
  [![NPM Version of ![Promptbook logo - cube with letters P and B](./design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
9
11
  [![Quality of package ![Promptbook logo - cube with letters P and B](./design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
10
12
  [![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
13
+ [![Build Status](https://github.com/webgptorg/promptbook/actions/workflows/ci.yml/badge.svg)](https://github.com/webgptorg/promptbook/actions)
14
+ [![Coverage Status](https://coveralls.io/repos/github/webgptorg/promptbook/badge.svg?branch=main)](https://coveralls.io/github/webgptorg/promptbook?branch=main)
11
15
  [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
12
16
 
13
17
 
14
18
 
15
-
16
-
17
19
  ## 🌟 New Features
18
20
 
19
- - 📂 We have plugin for [VSCode](https://github.com/webgptorg/book-extension) to support `.book` file extension
20
- - 🐳 Available [Docker image](https://hub.docker.com/r/hejny/promptbook/)
21
- - 💫 Support of [`o3-mini` model by OpenAI](https://openai.com/index/openai-o3-mini/)
22
- - 🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
21
+ - 💡 VS Code support for `.book` files with syntax highlighting and IntelliSense
22
+ - 🐳 Official Docker image (`hejny/promptbook`) for seamless containerized usage
23
+ - 🔥 Native support for OpenAI `o3-mini`, GPT-4 and other leading LLMs
24
+ - 🔍 DeepSeek integration for advanced knowledge search
23
25
 
24
26
 
25
27
 
@@ -183,65 +185,92 @@ Hello world examples:
183
185
  - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
184
186
  - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
185
187
 
188
+ ### 🌐 Community & Social Media
186
189
 
190
+ Join our growing community of developers and users:
187
191
 
188
- We also have a community of developers and users of **Promptbook**:
189
-
190
- - [Discord community](https://discord.gg/x3QWNaa89N)
191
- - [Landing page `ptbk.io`](https://ptbk.io)
192
- - [Github discussions](https://github.com/webgptorg/promptbook/discussions)
193
- - [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
194
- - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
195
-
196
- And **Promptbook.studio** branded socials:
197
-
198
-
199
-
200
- - [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
201
-
202
- And **Promptujeme** sub-brand:
203
-
204
- _/Subbrand for Czech clients/_
205
-
206
-
192
+ <table>
193
+ <thead>
194
+ <tr>
195
+ <th>Platform</th>
196
+ <th>Description</th>
197
+ </tr>
198
+ </thead>
199
+ <tbody>
200
+ <tr>
201
+ <td><a href="https://discord.gg/x3QWNaa89N">💬 Discord</a></td>
202
+ <td>Join our active developer community for discussions and support</td>
203
+ </tr>
204
+ <tr>
205
+ <td><a href="https://github.com/webgptorg/promptbook/discussions">🗣️ GitHub Discussions</a></td>
206
+ <td>Technical discussions, feature requests, and community Q&A</td>
207
+ </tr>
208
+ <tr>
209
+ <td><a href="https://linkedin.com/company/promptbook">👔 LinkedIn</a></td>
210
+ <td>Professional updates and industry insights</td>
211
+ </tr>
212
+ <tr>
213
+ <td><a href="https://www.facebook.com/61560776453536">📱 Facebook</a></td>
214
+ <td>General announcements and community engagement</td>
215
+ </tr>
216
+ <tr>
217
+ <td><a href="https://ptbk.io">🔗 ptbk.io</a></td>
218
+ <td>Official landing page with project information</td>
219
+ </tr>
220
+ </tbody>
221
+ </table>
207
222
 
223
+ ### 🖼️ Product & Brand Channels
208
224
 
209
- - [Promptujeme.cz](https://www.promptujeme.cz/)
210
- - [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
225
+ #### Promptbook.studio
211
226
 
212
- And **Promptbook.city** branded socials:
227
+ <table>
228
+ <tbody>
229
+ <tr>
230
+ <td><a href="https://www.instagram.com/promptbook.studio/">📸 Instagram @promptbook.studio</a></td>
231
+ <td>Visual updates, UI showcases, and design inspiration</td>
232
+ </tr>
233
+
234
+ </tbody>
235
+ </table>
213
236
 
214
- _/Sub-brand for images and graphics generated via Promptbook prompting/_
215
237
 
216
- - [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
217
- - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
218
238
 
219
239
 
220
240
 
221
241
 
242
+ ## 📘 Book Language Blueprint
222
243
 
244
+ _A concise, Markdown-based DSL for crafting AI workflows and automations._
223
245
 
224
- ## 💙 The Book language
246
+ ---
225
247
 
248
+ ### 📑 Table of Contents
226
249
 
250
+ - [Introduction](#introduction)
251
+ - [Example](#example)
252
+ - [1. What: Workflows, Tasks & Parameters](#1-what-workflows-tasks--parameters)
253
+ - [2. Who: Personas](#2-who-personas)
254
+ - [3. How: Knowledge, Instruments & Actions](#3-how-knowledge-instruments-and-actions)
255
+ - [General Principles](#general-principles)
227
256
 
228
- Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
257
+ ### Introduction
229
258
 
230
- 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.
259
+ Book is a Markdown-based language that simplifies the creation of AI applications, workflows, and automations. With human-readable commands, you can define inputs, outputs, personas, knowledge sources, and actions—without needing model-specific details.
231
260
 
232
261
  ### Example
233
262
 
234
- ```markdown
235
- # 🌟 My first Book
263
+ ```book
264
+ # 🌟 My First Book
236
265
 
237
266
  - BOOK VERSION 1.0.0
238
267
  - URL https://promptbook.studio/hello.book
239
268
  - INPUT PARAMETER {topic}
240
269
  - OUTPUT PARAMETER {article}
241
270
 
242
- # Write an article
271
+ # Write an Article
243
272
 
244
- - PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
273
+ - PERSONA Jane, marketing specialist with prior experience in tech and AI writing
245
274
  - KNOWLEDGE https://wikipedia.org/
246
275
  - KNOWLEDGE ./journalist-ethics.pdf
247
276
  - EXPECT MIN 1 Sentence
@@ -249,20 +278,20 @@ Book is a language that can be used to write AI applications, agents, workflows,
249
278
 
250
279
  > Write an article about {topic}
251
280
 
252
- -> {article}
281
+ {article}
253
282
  ```
254
283
 
255
284
  Each part of the book defines one of 3 circles:
256
285
 
257
- ### **What:** Workflows, Tasks and Parameters
286
+ ### **1. What:** Workflows, Tasks and Parameters
258
287
 
259
- What work needs to be done. Each book defines a [workflow *(scenario or pipeline)*](https://github.com/webgptorg/promptbook/discussions/88), 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.
288
+ What work needs to be done. Each book defines a [workflow _(scenario or pipeline)_](https://github.com/webgptorg/promptbook/discussions/88), 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.
260
289
 
261
290
  **Related commands:**
262
291
 
263
292
  - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
264
293
 
265
- ### **Who:** Personas
294
+ ### **2. Who:** Personas
266
295
 
267
296
  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.
268
297
 
@@ -276,7 +305,7 @@ Personas can have access to different knowledge, tools and actions. They can als
276
305
 
277
306
 
278
307
 
279
- ### **How:** Knowledge, Instruments and Actions
308
+ ### **3. How:** Knowledge, Instruments and Actions
280
309
 
281
310
  The resources used by the personas are used to do the work.
282
311
 
@@ -286,7 +315,7 @@ The resources used by the personas are used to do the work.
286
315
  - [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.
287
316
  - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
288
317
 
289
- ### General principles of book language
318
+ ### General Principles
290
319
 
291
320
  Book language is based on markdown. It is subset of markdown. It is designed to be easy to read and write. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
292
321
 
@@ -300,6 +329,10 @@ But unlike programming languages, it is designed to be understandable by non-pro
300
329
 
301
330
 
302
331
 
332
+ ## 📚 Documentation
333
+
334
+ See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
335
+
303
336
  ## 🔒 Security
304
337
 
305
338
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
@@ -380,25 +413,56 @@ _Note: This section is not complete dictionary, more list of general AI / LLM te
380
413
  - [🤼 Personas](https://github.com/webgptorg/promptbook/discussions/22)
381
414
  - [⭕ Parameters](https://github.com/webgptorg/promptbook/discussions/83)
382
415
  - [🚀 Pipeline execution](https://github.com/webgptorg/promptbook/discussions/84)
383
- - [🧪 Expectations](https://github.com/webgptorg/promptbook/discussions/30)
384
- - [✂️ Postprocessing](https://github.com/webgptorg/promptbook/discussions/31)
385
- - [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
386
- - [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
416
+ - [🧪 Expectations](https://github.com/webgptorg/promptbook/discussions/30) - Define what outputs should look like and how they're validated
417
+ - [✂️ Postprocessing](https://github.com/webgptorg/promptbook/discussions/31) - How outputs are refined after generation
418
+ - [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29) - The human-friendly way to think about text generation
419
+ - [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32) - How Book language organizes different aspects of AI workflows
387
420
 
388
- #### Advanced concepts
421
+ ### Advanced concepts
422
+
423
+ <table>
424
+ <tr>
425
+ <th>Data & Knowledge Management</th>
426
+ <th>Pipeline Control</th>
427
+ </tr>
428
+ <tr>
429
+ <td>
430
+ <ul>
431
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/41">📚 Knowledge (RAG)</a> - Retrieve and use external information</li>
432
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/54">📽 Media handling</a> - Working with images, audio, video, spreadsheets</li>
433
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/40">🔴 Anomaly detection</a> - Identifying unusual patterns or outputs</li>
434
+ </ul>
435
+ </td>
436
+ <td>
437
+ <ul>
438
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/89">🌏 Remote server</a> - Executing workflows on remote infrastructure</li>
439
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/66">🃏 Jokers (conditions)</a> - Adding conditional logic to workflows</li>
440
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/35">🔳 Metaprompting</a> - Creating prompts that generate other prompts</li>
441
+ </ul>
442
+ </td>
443
+ </tr>
444
+ <tr>
445
+ <th>Language & Output Control</th>
446
+ <th>Advanced Generation</th>
447
+ </tr>
448
+ <tr>
449
+ <td>
450
+ <ul>
451
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/53">🌏 Linguistically typed languages</a> - Type systems for natural language</li>
452
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/42">🌍 Auto-Translations</a> - Automatic multilingual support</li>
453
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/39">👮 Agent adversary expectations</a> - Safety and control mechanisms</li>
454
+ </ul>
455
+ </td>
456
+ <td>
457
+ <ul>
458
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/37">🔙 Expectation-aware generation</a> - Outputs that meet defined criteria</li>
459
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/33">⏳ Just-in-time fine-tuning</a> - Dynamic model adaptation</li>
460
+ </ul>
461
+ </td>
462
+ </tr>
463
+ </table>
389
464
 
390
- - [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
391
- - [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
392
- - [🃏 Jokers (conditions)](https://github.com/webgptorg/promptbook/discussions/66)
393
- - [🔳 Metaprompting](https://github.com/webgptorg/promptbook/discussions/35)
394
- - [🌏 Linguistically typed languages](https://github.com/webgptorg/promptbook/discussions/53)
395
- - [🌍 Auto-Translations](https://github.com/webgptorg/promptbook/discussions/42)
396
- - [📽 Images, audio, video, spreadsheets](https://github.com/webgptorg/promptbook/discussions/54)
397
- - [🔙 Expectation-aware generation](https://github.com/webgptorg/promptbook/discussions/37)
398
- - [⏳ Just-in-time fine-tuning](https://github.com/webgptorg/promptbook/discussions/33)
399
- - [🔴 Anomaly detection](https://github.com/webgptorg/promptbook/discussions/40)
400
- - [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
401
- - [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
465
+ <p align="center"><a href="https://github.com/webgptorg/promptbook/discussions/categories/concepts">🔍 View more concepts</a></p>
402
466
 
403
467
 
404
468
 
@@ -453,36 +517,28 @@ If you have a question [start a discussion](https://github.com/webgptorg/promptb
453
517
  - [❔ Is Promptbook using RAG _(Retrieval-Augmented Generation)_?](https://github.com/webgptorg/promptbook/discussions/123)
454
518
  - [❔ Is Promptbook using function calling?](https://github.com/webgptorg/promptbook/discussions/124)
455
519
 
456
- ## Changelog
520
+ ## 📅 Changelog
457
521
 
458
522
  See [CHANGELOG.md](./CHANGELOG.md)
459
523
 
460
524
  ## 📜 License
461
525
 
462
- Promptbook project is under [BUSL 1.1 is an SPDX license](https://spdx.org/licenses/BUSL-1.1.html)
526
+ This project is licensed under [BUSL 1.1](./LICENSE.md).
463
527
 
464
- ## 🎯 Todos
528
+ ## 🤝 Contributing
465
529
 
466
- See [TODO.md](./TODO.md)
530
+ We welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
467
531
 
468
- ## 🤝 Partners
469
-
470
- <div style="display: flex; align-items: center; gap: 20px;">
471
-
472
- <a href="https://promptbook.studio/">
473
- <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
474
- </a>
475
-
476
- <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
477
- <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
478
- </a>
479
-
480
- </div>
532
+ You can also ⭐ star the project, [follow us on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).We are open to [pull requests, feedback, and suggestions](./CONTRIBUTING.md).
481
533
 
482
- ## 🖋️ Contributing
534
+ ## 🆘 Support & Community
483
535
 
484
- You can also star the project, [follow us on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).We are open to [pull requests, feedback, and suggestions](./CONTRIBUTING.md).
536
+ Need help with Book language? We're here for you!
485
537
 
486
- ## 📞 Support
538
+ - 💬 [Join our Discord community](https://discord.gg/x3QWNaa89N) for real-time support
539
+ - 📝 [Browse our GitHub discussions](https://github.com/webgptorg/promptbook/discussions) for FAQs and community knowledge
540
+ - 🐛 [Report issues](https://github.com/webgptorg/book/issues) for bugs or feature requests
541
+ - 📚 Visit [ptbk.io](https://ptbk.io) for more resources and documentation
542
+ - 📧 Contact us directly through the channels listed in our [signpost](./SIGNPOST.md)
487
543
 
488
- If you need help or have questions, please check our [Support Resources](./SUPPORT.md).
544
+ We welcome contributions and feedback to make Book language better for everyone!
package/esm/index.es.js CHANGED
@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
16
16
  * @generated
17
17
  * @see https://github.com/webgptorg/promptbook
18
18
  */
19
- const PROMPTBOOK_ENGINE_VERSION = '0.92.0';
19
+ const PROMPTBOOK_ENGINE_VERSION = '0.93.0';
20
20
  /**
21
21
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
22
22
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.92.0-35`).
18
+ * It follows semantic versioning (e.g., `0.92.0`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@promptbook/vercel",
3
- "version": "0.92.0",
4
- "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
3
+ "version": "0.93.0",
4
+ "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
5
5
  "private": false,
6
6
  "sideEffects": false,
7
7
  "repository": {
@@ -63,7 +63,7 @@
63
63
  "module": "./esm/index.es.js",
64
64
  "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
65
65
  "peerDependencies": {
66
- "@promptbook/core": "0.92.0"
66
+ "@promptbook/core": "0.93.0"
67
67
  },
68
68
  "dependencies": {
69
69
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -23,7 +23,7 @@
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.92.0';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.93.0';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * Note: [💞] Ignore a discrepancy between file name and entity name