@promptbook/google 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
 
@@ -316,65 +318,92 @@ Hello world examples:
316
318
  - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
317
319
  - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
318
320
 
321
+ ### 🌐 Community & Social Media
319
322
 
323
+ Join our growing community of developers and users:
320
324
 
321
- We also have a community of developers and users of **Promptbook**:
322
-
323
- - [Discord community](https://discord.gg/x3QWNaa89N)
324
- - [Landing page `ptbk.io`](https://ptbk.io)
325
- - [Github discussions](https://github.com/webgptorg/promptbook/discussions)
326
- - [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
327
- - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
328
-
329
- And **Promptbook.studio** branded socials:
330
-
331
-
332
-
333
- - [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
334
-
335
- And **Promptujeme** sub-brand:
336
-
337
- _/Subbrand for Czech clients/_
338
-
339
-
325
+ <table>
326
+ <thead>
327
+ <tr>
328
+ <th>Platform</th>
329
+ <th>Description</th>
330
+ </tr>
331
+ </thead>
332
+ <tbody>
333
+ <tr>
334
+ <td><a href="https://discord.gg/x3QWNaa89N">💬 Discord</a></td>
335
+ <td>Join our active developer community for discussions and support</td>
336
+ </tr>
337
+ <tr>
338
+ <td><a href="https://github.com/webgptorg/promptbook/discussions">🗣️ GitHub Discussions</a></td>
339
+ <td>Technical discussions, feature requests, and community Q&A</td>
340
+ </tr>
341
+ <tr>
342
+ <td><a href="https://linkedin.com/company/promptbook">👔 LinkedIn</a></td>
343
+ <td>Professional updates and industry insights</td>
344
+ </tr>
345
+ <tr>
346
+ <td><a href="https://www.facebook.com/61560776453536">📱 Facebook</a></td>
347
+ <td>General announcements and community engagement</td>
348
+ </tr>
349
+ <tr>
350
+ <td><a href="https://ptbk.io">🔗 ptbk.io</a></td>
351
+ <td>Official landing page with project information</td>
352
+ </tr>
353
+ </tbody>
354
+ </table>
340
355
 
356
+ ### 🖼️ Product & Brand Channels
341
357
 
342
- - [Promptujeme.cz](https://www.promptujeme.cz/)
343
- - [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
358
+ #### Promptbook.studio
344
359
 
345
- And **Promptbook.city** branded socials:
360
+ <table>
361
+ <tbody>
362
+ <tr>
363
+ <td><a href="https://www.instagram.com/promptbook.studio/">📸 Instagram @promptbook.studio</a></td>
364
+ <td>Visual updates, UI showcases, and design inspiration</td>
365
+ </tr>
366
+
367
+ </tbody>
368
+ </table>
346
369
 
347
- _/Sub-brand for images and graphics generated via Promptbook prompting/_
348
370
 
349
- - [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
350
- - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
351
371
 
352
372
 
353
373
 
354
374
 
375
+ ## 📘 Book Language Blueprint
355
376
 
377
+ _A concise, Markdown-based DSL for crafting AI workflows and automations._
356
378
 
357
- ## 💙 The Book language
379
+ ---
358
380
 
381
+ ### 📑 Table of Contents
359
382
 
383
+ - [Introduction](#introduction)
384
+ - [Example](#example)
385
+ - [1. What: Workflows, Tasks & Parameters](#1-what-workflows-tasks--parameters)
386
+ - [2. Who: Personas](#2-who-personas)
387
+ - [3. How: Knowledge, Instruments & Actions](#3-how-knowledge-instruments-and-actions)
388
+ - [General Principles](#general-principles)
360
389
 
361
- Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
390
+ ### Introduction
362
391
 
363
- 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.
392
+ 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.
364
393
 
365
394
  ### Example
366
395
 
367
- ```markdown
368
- # 🌟 My first Book
396
+ ```book
397
+ # 🌟 My First Book
369
398
 
370
399
  - BOOK VERSION 1.0.0
371
400
  - URL https://promptbook.studio/hello.book
372
401
  - INPUT PARAMETER {topic}
373
402
  - OUTPUT PARAMETER {article}
374
403
 
375
- # Write an article
404
+ # Write an Article
376
405
 
377
- - PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
406
+ - PERSONA Jane, marketing specialist with prior experience in tech and AI writing
378
407
  - KNOWLEDGE https://wikipedia.org/
379
408
  - KNOWLEDGE ./journalist-ethics.pdf
380
409
  - EXPECT MIN 1 Sentence
@@ -382,20 +411,20 @@ Book is a language that can be used to write AI applications, agents, workflows,
382
411
 
383
412
  > Write an article about {topic}
384
413
 
385
- -> {article}
414
+ {article}
386
415
  ```
387
416
 
388
417
  Each part of the book defines one of 3 circles:
389
418
 
390
- ### **What:** Workflows, Tasks and Parameters
419
+ ### **1. What:** Workflows, Tasks and Parameters
391
420
 
392
- 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.
421
+ 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.
393
422
 
394
423
  **Related commands:**
395
424
 
396
425
  - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
397
426
 
398
- ### **Who:** Personas
427
+ ### **2. Who:** Personas
399
428
 
400
429
  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.
401
430
 
@@ -409,7 +438,7 @@ Personas can have access to different knowledge, tools and actions. They can als
409
438
 
410
439
 
411
440
 
412
- ### **How:** Knowledge, Instruments and Actions
441
+ ### **3. How:** Knowledge, Instruments and Actions
413
442
 
414
443
  The resources used by the personas are used to do the work.
415
444
 
@@ -419,7 +448,7 @@ The resources used by the personas are used to do the work.
419
448
  - [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.
420
449
  - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
421
450
 
422
- ### General principles of book language
451
+ ### General Principles
423
452
 
424
453
  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.
425
454
 
@@ -433,6 +462,10 @@ But unlike programming languages, it is designed to be understandable by non-pro
433
462
 
434
463
 
435
464
 
465
+ ## 📚 Documentation
466
+
467
+ See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
468
+
436
469
  ## 🔒 Security
437
470
 
438
471
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
@@ -513,25 +546,56 @@ _Note: This section is not complete dictionary, more list of general AI / LLM te
513
546
  - [🤼 Personas](https://github.com/webgptorg/promptbook/discussions/22)
514
547
  - [⭕ Parameters](https://github.com/webgptorg/promptbook/discussions/83)
515
548
  - [🚀 Pipeline execution](https://github.com/webgptorg/promptbook/discussions/84)
516
- - [🧪 Expectations](https://github.com/webgptorg/promptbook/discussions/30)
517
- - [✂️ Postprocessing](https://github.com/webgptorg/promptbook/discussions/31)
518
- - [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
519
- - [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
549
+ - [🧪 Expectations](https://github.com/webgptorg/promptbook/discussions/30) - Define what outputs should look like and how they're validated
550
+ - [✂️ Postprocessing](https://github.com/webgptorg/promptbook/discussions/31) - How outputs are refined after generation
551
+ - [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29) - The human-friendly way to think about text generation
552
+ - [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32) - How Book language organizes different aspects of AI workflows
520
553
 
521
- #### Advanced concepts
554
+ ### Advanced concepts
555
+
556
+ <table>
557
+ <tr>
558
+ <th>Data & Knowledge Management</th>
559
+ <th>Pipeline Control</th>
560
+ </tr>
561
+ <tr>
562
+ <td>
563
+ <ul>
564
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/41">📚 Knowledge (RAG)</a> - Retrieve and use external information</li>
565
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/54">📽 Media handling</a> - Working with images, audio, video, spreadsheets</li>
566
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/40">🔴 Anomaly detection</a> - Identifying unusual patterns or outputs</li>
567
+ </ul>
568
+ </td>
569
+ <td>
570
+ <ul>
571
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/89">🌏 Remote server</a> - Executing workflows on remote infrastructure</li>
572
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/66">🃏 Jokers (conditions)</a> - Adding conditional logic to workflows</li>
573
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/35">🔳 Metaprompting</a> - Creating prompts that generate other prompts</li>
574
+ </ul>
575
+ </td>
576
+ </tr>
577
+ <tr>
578
+ <th>Language & Output Control</th>
579
+ <th>Advanced Generation</th>
580
+ </tr>
581
+ <tr>
582
+ <td>
583
+ <ul>
584
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/53">🌏 Linguistically typed languages</a> - Type systems for natural language</li>
585
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/42">🌍 Auto-Translations</a> - Automatic multilingual support</li>
586
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/39">👮 Agent adversary expectations</a> - Safety and control mechanisms</li>
587
+ </ul>
588
+ </td>
589
+ <td>
590
+ <ul>
591
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/37">🔙 Expectation-aware generation</a> - Outputs that meet defined criteria</li>
592
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/33">⏳ Just-in-time fine-tuning</a> - Dynamic model adaptation</li>
593
+ </ul>
594
+ </td>
595
+ </tr>
596
+ </table>
522
597
 
523
- - [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
524
- - [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
525
- - [🃏 Jokers (conditions)](https://github.com/webgptorg/promptbook/discussions/66)
526
- - [🔳 Metaprompting](https://github.com/webgptorg/promptbook/discussions/35)
527
- - [🌏 Linguistically typed languages](https://github.com/webgptorg/promptbook/discussions/53)
528
- - [🌍 Auto-Translations](https://github.com/webgptorg/promptbook/discussions/42)
529
- - [📽 Images, audio, video, spreadsheets](https://github.com/webgptorg/promptbook/discussions/54)
530
- - [🔙 Expectation-aware generation](https://github.com/webgptorg/promptbook/discussions/37)
531
- - [⏳ Just-in-time fine-tuning](https://github.com/webgptorg/promptbook/discussions/33)
532
- - [🔴 Anomaly detection](https://github.com/webgptorg/promptbook/discussions/40)
533
- - [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
534
- - [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
598
+ <p align="center"><a href="https://github.com/webgptorg/promptbook/discussions/categories/concepts">🔍 View more concepts</a></p>
535
599
 
536
600
 
537
601
 
@@ -586,36 +650,28 @@ If you have a question [start a discussion](https://github.com/webgptorg/promptb
586
650
  - [❔ Is Promptbook using RAG _(Retrieval-Augmented Generation)_?](https://github.com/webgptorg/promptbook/discussions/123)
587
651
  - [❔ Is Promptbook using function calling?](https://github.com/webgptorg/promptbook/discussions/124)
588
652
 
589
- ## Changelog
653
+ ## 📅 Changelog
590
654
 
591
655
  See [CHANGELOG.md](./CHANGELOG.md)
592
656
 
593
657
  ## 📜 License
594
658
 
595
- Promptbook project is under [BUSL 1.1 is an SPDX license](https://spdx.org/licenses/BUSL-1.1.html)
659
+ This project is licensed under [BUSL 1.1](./LICENSE.md).
596
660
 
597
- ## 🎯 Todos
661
+ ## 🤝 Contributing
598
662
 
599
- See [TODO.md](./TODO.md)
663
+ We welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
600
664
 
601
- ## 🤝 Partners
602
-
603
- <div style="display: flex; align-items: center; gap: 20px;">
604
-
605
- <a href="https://promptbook.studio/">
606
- <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
607
- </a>
608
-
609
- <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
610
- <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
611
- </a>
612
-
613
- </div>
665
+ 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).
614
666
 
615
- ## 🖋️ Contributing
667
+ ## 🆘 Support & Community
616
668
 
617
- 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).
669
+ Need help with Book language? We're here for you!
618
670
 
619
- ## 📞 Support
671
+ - 💬 [Join our Discord community](https://discord.gg/x3QWNaa89N) for real-time support
672
+ - 📝 [Browse our GitHub discussions](https://github.com/webgptorg/promptbook/discussions) for FAQs and community knowledge
673
+ - 🐛 [Report issues](https://github.com/webgptorg/book/issues) for bugs or feature requests
674
+ - 📚 Visit [ptbk.io](https://ptbk.io) for more resources and documentation
675
+ - 📧 Contact us directly through the channels listed in our [signpost](./SIGNPOST.md)
620
676
 
621
- If you need help or have questions, please check our [Support Resources](./SUPPORT.md).
677
+ 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/google",
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/google.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
  "@ai-sdk/google": "1.0.5",
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