@promptbook/utils
Advanced tools
PromptbookBuild responsible, controlled and transparent applications on top of LLM models!
.docx, .doc and .pdf documents@promptbook/utils@promptbook/utils is one part of the promptbook ecosystem.To install this package, run:
# Install entire promptbook ecosystem
npm i ptbk
# Install just this package to save space
npm install @promptbook/utils
Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
Here is a overview of the functions which are exported from the @promptbook/utils package and can be used in your own projects:
Sometimes you need to postprocess the output of the LLM model, every postprocessing function that is available through POSTPROCESS command in promptbook is exported from @promptbook/utils. You can use:
spaceTrimextractAllBlocksFromMarkdown, <- Note: Exported from @promptbook/markdown-utilsextractAllListItemsFromMarkdown <- Note: Exported from @promptbook/markdown-utilsextractBlockextractOneBlockFromMarkdown <- Note: Exported from @promptbook/markdown-utilsprettifyPipelineStringremoveContentCommentsremoveEmojisremoveMarkdownFormatting <- Note: Exported from @promptbook/markdown-utilsremoveQuotestrimCodeBlocktrimEndOfCodeBlockunwrapResultVery often you will use unwrapResult, which is used to extract the result you need from output with some additional information:
import { unwrapResult } from '@promptbook/utils';
unwrapResult('Best greeting for the user is "Hi Pavol!"'); // 'Hi Pavol!'
There is a function replaceParameters which is used to replace the parameters in given template optimized to LLM prompt templates.
import { replaceParameters } from '@promptbook/utils';
replaceParameters('Hello, {name}!', { name: 'world' }); // 'Hello, world!'
And also multiline templates with blockquotes
import { replaceParameters, spaceTrim } from '@promptbook/utils';
replaceParameters(
spaceTrim(`
Hello, {name}!
> {answer}
`),
{
name: 'world',
answer: spaceTrim(`
I'm fine,
thank you!
And you?
`),
},
);
// Hello, world!
//
// > I'm fine,
// > thank you!
// >
// > And you?
Theese functions are usefull to count stats about the input/output in human-like terms not tokens and bytes, you can use
countCharacters, countLines, countPages, countParagraphs, countSentences, countWords
import { countWords } from '@promptbook/utils';
console.log(countWords('Hello, world!')); // 2
Splitting functions are similar to counting but they return the splitted parts of the input/output, you can use
splitIntoCharacters, splitIntoLines, splitIntoPages, splitIntoParagraphs, splitIntoSentences, splitIntoWords
import { splitIntoWords } from '@promptbook/utils';
console.log(splitIntoWords('Hello, world!')); // ['Hello', 'world']
Normalization functions are used to put the string into a normalized form, you can use
kebab-case
PascalCase
SCREAMING_CASE
snake_case
kebab-case
import { normalizeTo } from '@promptbook/utils';
console.log(normalizeTo['kebab-case']('Hello, world!')); // 'hello-world'
capitalize, decapitalize, removeDiacritics,...POSTPROCESS command in promptbookSee also the documentation for all the functions in the @promptbook/utils package, every function is documented by jsdoc, typed by typescript and tested by jest.
assertsExecutionSuccessful,
checkExpectations,
executionReportJsonToString,
isPassingExpectations,
isValidJsonString,
parseNumber
Rest of the documentation is common for entire promptbook ecosystem:
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.
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:
In all of these situations, but especially in 3., the โจ Promptbook can make your life waaaaaaaaaay easier.
temperature, top-k, top-p, or kernel sampling. Just write your intent and persona who should be responsible for the task and let the library do the rest.:) can't avoid the problems. In this case, the library has built-in anomaly detection and logging to help you find and fix the problems.Promptbook pipelines are written in markdown-like language called Book. It is designed to be understandable by non-programmers and non-technical people.
# ๐ 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}
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
ptbk.pdf documents.docx, .odt,โฆ.doc, .rtf,โฆThe following glossary is used to clarify certain concepts:
If you have a question start a discussion, open an issue or write me an email.
See CHANGELOG.md
Promptbook by Pavol Hejnรฝ is licensed under CC BY 4.0
See TODO.md
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.
0.73.0 (2024-11-08)
FAQs
Supercharge your use of large language models
The npm package @promptbook/utils receives a total of 299,116 weekly downloads. As such, @promptbook/utils popularity was classified as popular.
We found that @promptbook/utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.ย It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.