Promptbook
✨ New Features
📦 Package @promptbook/website-crawler
To install this package, run:
npm i ptbk
npm install @promptbook/website-crawler
Crawl knowledge from the web
Rest of the documentation is common for entire promptbook ecosystem:
🤍 The Book Abstract
It's time for a paradigm shift! The future of software is in plain English, French or Latin.
During the computer revolution, we have seen multiple generations of computer languages, from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the next revolution!
It's a revolution of writing software in plain human language that is understandable and executable by both humans and machines – and it's going to change everything!
The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
This shift is going to happen, whether we are ready for it or not. Our mission is to make it excellently, not just good.
Join us in this journey!
🚀 Get started
Take a look at the simple starter kit with books integrated into the Hello World sample applications:
💜 The Promptbook Project
Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
Project | Description | Link |
---|
Core | Promptbook Core is a description and documentation of the basic concepts, ideas and inner workings of how Promptbook should be implemented, and defines what features must be describable by book language. | https://ptbk.io https://github.com/webgptorg/book |
Book language |
Book is a markdown-like language to define core entities like projects, pipelines, knowledge,.... It is designed to be understandable by non-programmers and non-technical people
|
Promptbook typescript project | Promptbook implementation in TypeScript released as multiple NPM packages | https://github.com/webgptorg/promptbook + Multiple packages on NPM |
Promptbook studio | Studio to write Books and instantly publish them as miniapps |
https://promptbook.studio
https://github.com/hejny/promptbook-studio |
Hello World | Simple starter kit with Books integrated into the sample applications |
https://github.com/webgptorg/hello-world
https://github.com/webgptorg/hello-world-node-js
https://github.com/webgptorg/hello-world-next-js
|
💙 Book language (for prompt-engineer)
💙 The blueprint of book language
Following is the documentation and blueprint of the Book language.
Example
# 🌟 My first Book
- PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
- KNOWLEDGE https://ptbk.io
- KNOWLEDGE ./promptbook.pdf
- EXPECT MIN 1 Sentence
- EXPECT MAX 1 Paragraph
> 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.
> Look specifically at the impact of Promptbook on the AI industry.
-> {article}
Goals and principles of book language
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.
It has file with .book.md
or .book
extension with UTF-8
non BOM encoding.
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.
But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
Structure
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.
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.
Parameter
Foo bar
Parameter names
Reserved words:
- each command like
PERSONA
, EXPECT
, KNOWLEDGE
, etc. content
context
knowledge
examples
modelName
currentDate
Parameter notation
Task
Task type
Todo todo
Command
Todo todo
Block
Todo todo
Return parameter
Examples
📦 Packages (for developers)
This library is divided into several packages, all are published from single monorepo.
You can install all of them at once:
npm i ptbk
Or you can install them separately:
⭐ Marked packages are worth to try first
📚 Dictionary
📚 Dictionary
The following glossary is used to clarify certain concepts:
General LLM / AI terms
- Prompt drift is a phenomenon where the AI model starts to generate outputs that are not aligned with the original prompt. This can happen due to the model's training data, the prompt's wording, or the model's architecture.
- Pipeline, workflow or chain is a sequence of tasks that are executed in a specific order. In the context of AI, a pipeline can refer to a sequence of AI models that are used to process data.
- Fine-tuning is a process where a pre-trained AI model is further trained on a specific dataset to improve its performance on a specific task.
- Zero-shot learning is a machine learning paradigm where a model is trained to perform a task without any labeled examples. Instead, the model is provided with a description of the task and is expected to generate the correct output.
- Few-shot learning is a machine learning paradigm where a model is trained to perform a task with only a few labeled examples. This is in contrast to traditional machine learning, where models are trained on large datasets.
- Meta-learning is a machine learning paradigm where a model is trained on a variety of tasks and is able to learn new tasks with minimal additional training. This is achieved by learning a set of meta-parameters that can be quickly adapted to new tasks.
- Retrieval-augmented generation is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
- Longtail refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.
Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook
Promptbook core
- 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).
- Jobs
- Workforce
- Knowledge
- Instruments
- Actions
Book language
- Book file
- Section
- Heading
- Description
- Command
- Block
- Return statement
- Comment
- Import
- Scope
💯 Core concepts
Advanced concepts
Terms specific to Promptbook TypeScript implementation
- Anonymous mode
- Application mode
🔌 Usage in Typescript / Javascript
➕➖ When to use Promptbook?
➕ When to use
- When you are writing app that generates complex things via LLM - like websites, articles, presentations, code, stories, songs,...
- When you want to separate code from text prompts
- When you want to describe complex prompt pipelines and don't want to do it in the code
- When you want to orchestrate multiple prompts together
- When you want to reuse parts of prompts in multiple places
- When you want to version your prompts and test multiple versions
- When you want to log the execution of prompts and backtrace the issues
See more
➖ When not to use
- When you have already implemented single simple prompt and it works fine for your job
- When OpenAI Assistant (GPTs) is enough for you
- When you need streaming (this may be implemented in the future, see discussion).
- When you need to use something other than JavaScript or TypeScript (other languages are on the way, see the discussion)
- When your main focus is on something other than text - like images, audio, video, spreadsheets (other media types may be added in the future, see discussion)
- When you need to use recursion (see the discussion)
See more
🐜 Known issues
🧼 Intentionally not implemented features
❔ FAQ
If you have a question start a discussion, open an issue or write me an email.
⌚ Changelog
See CHANGELOG.md
📜 License
Promptbook by Pavol Hejný is licensed under CC BY 4.0
🎯 Todos
See TODO.md
🖋️ Contributing
I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can ☕ buy me a coffee or donate via cryptocurrencies.
You can also ⭐ star the promptbook package, follow me on GitHub or various other social networks.