@promptbook/core weekly downloads statistics

🐙 Promptbook: Invisible AI Agents

Create persistent AI agents that turn your company's scattered knowledge into action - powered by the Agents Server

Promptbook](https://www.npmjs.com/package/promptbook) Promptbook](https://packagequality.com/#?package=promptbook)

🚀 Quick deploy

Run the standalone VPS installer (for example on DigitalOcean) only on a fresh server. Interactive mode asks for the installation values:

Non-interactive mode takes defaults from command-line options. Use --env live, --env preview, --env production, or --env lts to pick the installed environment; the default is preview. When --openai-api-key is provided with the default OpenAI Codex runner, the installer installs and configures Codex automatically; other runner authentication can be configured later from the UI or SSH:

⚠ Warning: This is a pre-release version of the library. It is not yet ready for production use. Please look at latest stable release.

📦 Package @promptbook/core

• Promptbooks are divided into several packages, all are published from single monorepo. • This package @promptbook/core is one part of the promptbook ecosystem.

To install this package, run:

The core package contains the fundamental logic and infrastructure for Promptbook. It provides the essential building blocks for creating, parsing, validating, and executing promptbooks, along with comprehensive error handling, LLM provider integrations, and execution utilities.

🎯 Purpose and Motivation

The core package serves as the foundation of the Promptbook ecosystem. It abstracts away the complexity of working with different LLM providers, provides a unified interface for prompt execution, and handles all the intricate details of pipeline management, parameter validation, and result processing.

🔧 High-Level Functionality

This package orchestrates the entire promptbook execution lifecycle:

• Pipeline Management: Parse, validate, and compile promptbook definitions • Execution Engine: Create and manage pipeline executors with comprehensive error handling • LLM Integration: Unified interface for multiple LLM providers (OpenAI, Anthropic, Google, etc.) • Parameter Processing: Template parameter substitution and validation • Knowledge Management: Handle knowledge sources and scraping • Storage Abstraction: Flexible storage backends for caching and persistence • Format Support: Parse and validate various data formats (JSON, CSV, XML)

✨ Key Features

• 🚀 Universal Pipeline Executor - Execute promptbooks with any supported LLM provider • 🔄 Multi-Provider Support - Seamlessly switch between OpenAI, Anthropic, Google, and other providers • 📊 Comprehensive Validation - Validate promptbooks, parameters, and execution results • 🎯 Expectation Checking - Built-in validation for output format, length, and content expectations • 🧠 Knowledge Integration - Scrape and process knowledge from various sources • 💾 Flexible Storage - Memory, filesystem, and custom storage backends • 🔧 Error Handling - Detailed error types for debugging and monitoring • 📈 Usage Tracking - Monitor token usage, costs, and performance metrics • 🎨 Format Parsers - Support for JSON, CSV, XML, and text formats • 🔀 Pipeline Migration - Upgrade and migrate pipeline definitions

📦 Exported Entities

Version Information

• BOOK_LANGUAGE_VERSION - Current book language version • PROMPTBOOK_ENGINE_VERSION - Current engine version

Agent and Book Management

• createAgentModelRequirements - Create model requirements for agents • parseAgentSource - Parse agent source code • isValidBook - Validate book format • validateBook - Comprehensive book validation • DEFAULT_BOOK - Default book template

Commitment System

• createEmptyAgentModelRequirements - Create empty model requirements • createBasicAgentModelRequirements - Create basic model requirements • NotYetImplementedCommitmentDefinition - Placeholder for future commitments • getCommitmentDefinition - Get specific commitment definition • getAllCommitmentDefinitions - Get all available commitment definitions • getAllCommitmentTypes - Get all commitment types • isCommitmentSupported - Check if commitment is supported

Collection Management

• pipelineCollectionToJson - Convert collection to JSON • createPipelineCollectionFromJson - Create collection from JSON data • createPipelineCollectionFromPromise - Create collection from async source • createPipelineCollectionFromUrl - Create collection from URL • createPipelineSubcollection - Create filtered subcollection

Configuration Constants…