\n ⚠ Warning: This is a pre-release version of the library. It is not yet ready for production use. Please look at latest stable release.\n\n\n## 📦 Package `@promptbook/azure-openai`\n\n- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).\n- This package `@promptbook/azure-openai` is one part of the promptbook ecosystem.\n\nTo install this package, run:\n\n```bash\n# Install entire promptbook ecosystem\nnpm i ptbk\n\n# Install just this package to save space\nnpm install @promptbook/azure-openai\n```\n\n`@promptbook/azure-openai` integrates [Azure OpenAI API](https://oai.azure.com/portal/) with [Promptbook](https://github.com/webgptorg/promptbook). It allows to execute Promptbooks with Azure OpenAI GPT models.\n\n> Note: This is similar to [@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai) but more useful for Enterprise customers who use Azure OpenAI to ensure strict data privacy and compliance.\n\n## 🧡 Usage\n\n```typescript\nimport { createPipelineExecutor } from '@promptbook/core';\nimport {\n createPipelineCollectionFromDirectory,\n $provideExecutionToolsForNode,\n $provideFilesystemForNode,\n $provideScrapersForNode,\n $provideScriptingForNode,\n} from '@promptbook/node';\nimport { JavascriptExecutionTools } from '@promptbook/javascript';\nimport { AzureOpenAiExecutionTools } from '@promptbook/azure-openai';\n\n// 🛠 Prepare the tools that will be used to compile and run your books\n// Note: Here you can allow or deny some LLM providers, such as not providing DeepSeek for privacy reasons\nconst fs = $provideFilesystemForNode();\nconst llm = new AzureOpenAiExecutionTools(\n // <- TODO: [🧱] Implement in a functional (not new Class) way\n {\n isVerbose: true,\n resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,\n deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,\n apiKey: process.env.AZUREOPENAI_API_KEY,\n },\n);\nconst executables = await $provideExecutablesForNode();\nconst tools = {\n llm,\n fs,\n scrapers: await $provideScrapersForNode({ fs, llm, executables }),\n script: await $provideScriptingForNode({}),\n};\n\n// ▶ Create whole pipeline collection\nconst collection = await createPipelineCollectionFromDirectory('./books', tools);\n\n// ▶ Get single Pipeline\nconst pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);\n\n// ▶ Create executor - the function that will execute the Pipeline\nconst pipelineExecutor = createPipelineExecutor({ pipeline, tools });\n\n// ▶ Prepare input parameters\nconst inputParameters = { word: 'crocodile' };\n\n// 🚀▶ Execute the Pipeline\nconst result = await pipelineExecutor(inputParameters).asPromise({ isCrashedOnError: true });\n\n// ▶ Handle the result\nconst { isSuccessful, errors, outputParameters, executionReport } = result;\nconsole.info(outputParameters);\n```\n\n\n\n\n## 🧙♂️ Wizard\n\nRun books without any settings, boilerplate or struggle in Node.js:\n\n```typescript\nimport { wizard } from '@promptbook/wizard';\n\nconst {\n outputParameters: { joke },\n} = await wizard.execute(`https://github.com/webgptorg/book/blob/main/books/templates/generic.book`, {\n topic: 'Prague',\n});\n\nconsole.info(joke);\n```\n\n\n\n\n\n\n## 🧙♂️ Connect to LLM providers automatically\n\nYou can just use `$provideExecutionToolsForNode` function to create all required tools from environment variables like `ANTHROPIC_CLAUDE_API_KEY` and `OPENAI_API_KEY` automatically.\n\n```typescript\nimport { createPipelineExecutor, createPipelineCollectionFromDirectory } from '@promptbook/core';\nimport { JavascriptExecutionTools } from '@promptbook/javascript';\nimport { $provideExecutionToolsForNode } from '@promptbook/node';\nimport { $provideFilesystemForNode } from '@promptbook/node';\n\n// 🛠 Prepare the tools that will be used to compile and run your books\n// Note: Here you can allow or deny some LLM providers, such as not providing DeepSeek for privacy reasons\nconst tools = await $provideExecutionToolsForNode();\n\n// ▶ Create whole pipeline collection\nconst collection = await createPipelineCollectionFromDirectory('./books', tools);\n\n// ▶ Get single Pipeline\nconst pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);\n\n// ▶ Create executor - the function that will execute the Pipeline\nconst pipelineExecutor = createPipelineExecutor({ pipeline, tools });\n\n// ▶ Prepare input parameters\nconst inputParameters = { word: 'dog' };\n\n// 🚀▶ Execute the Pipeline\nconst result = await pipelineExecutor(inputParameters).asPromise({ isCrashedOnError: true });\n\n// ▶ Handle the result\nconst { isSuccessful, errors, outputParameters, executionReport } = result;\nconsole.info(outputParameters);\n```\n\n\n\n## 💕 Usage of multiple LLM providers\n\nYou can use multiple LLM providers in one Promptbook execution. The best model will be chosen automatically according to the prompt and the model's capabilities.\n\n```typescript\nimport { createPipelineExecutor } from '@promptbook/core';\nimport {\n createPipelineCollectionFromDirectory,\n $provideExecutionToolsForNode,\n $provideFilesystemForNode,\n} from '@promptbook/node';\nimport { JavascriptExecutionTools } from '@promptbook/javascript';\nimport { AzureOpenAiExecutionTools } from '@promptbook/azure-openai';\nimport { OpenAiExecutionTools } from '@promptbook/openai';\nimport { AnthropicClaudeExecutionTools } from '@promptbook/anthropic-claude';\n\n// ▶ Prepare multiple tools\nconst fs = $provideFilesystemForNode();\nconst llm = [\n // Note: You can use multiple LLM providers in one Promptbook execution.\n // The best model will be chosen automatically according to the prompt and the model's capabilities.\n new AzureOpenAiExecutionTools(\n // <- TODO: [🧱] Implement in a functional (not new Class) way\n {\n resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,\n deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,\n apiKey: process.env.AZUREOPENAI_API_KEY,\n },\n ),\n new OpenAiExecutionTools(\n // <- TODO: [🧱] Implement in a functional (not new Class) way\n {\n apiKey: process.env.OPENAI_API_KEY,\n },\n ),\n new AnthropicClaudeExecutionTools(\n // <- TODO: [🧱] Implement in a functional (not new Class) way\n {\n apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,\n },\n ),\n];\nconst executables = await $provideExecutablesForNode();\nconst tools = {\n llm,\n fs,\n scrapers: await $provideScrapersForNode({ fs, llm, executables }),\n script: await $provideScriptingForNode({}),\n};\n\n// ▶ Create whole pipeline collection\nconst collection = await createPipelineCollectionFromDirectory('./books', tools);\n\n// ▶ Get single Pipeline\nconst pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);\n\n// ▶ Create executor - the function that will execute the Pipeline\nconst pipelineExecutor = createPipelineExecutor({ pipeline, tools });\n\n// ▶ Prepare input parameters\nconst inputParameters = { word: 'snake' };\n\n// 🚀▶ Execute the Pipeline\nconst result = await pipelineExecutor(inputParameters).asPromise({ isCrashedOnError: true });\n\n// ▶ Handle the result\nconst { isSuccessful, errors, outputParameters, executionReport } = result;\nconsole.info(outputParameters);\n```\n\n\n\n\n### 💙 Integration with other models\n\nSee the other model integrations:\n\n- [OpenAI](https://www.npmjs.com/package/@promptbook/openai)\n- [Anthropic Claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)\n- [Google Gemini](https://www.npmjs.com/package/@promptbook/google)\n- [Vercel](https://www.npmjs.com/package/@promptbook/vercel)\n- [Azure OpenAI](https://www.npmjs.com/package/@promptbook/azure-openai)\n\n\n\n\n---\n\nRest of the documentation is common for **entire promptbook ecosystem**:\n\n\n\n\n## 📖 The Book Whitepaper\n\nPromptbook lets you create **persistent AI agents** that work on real goals for your company. The [**Agents Server**](https://gallery.ptbk.io/) is the heart of the project - a place where your AI agents live, remember context, collaborate in teams, and get things done.\n\nNowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as Claude Mythos, GPT-5.6 or Kimi K2.7 are incredibly capable.\n\nThe main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.\n\nIn Promptbook, you define your agents **using simple Books** - a human-readable language that is explicit, easy to understand and write, reliable, and highly portable. You then deploy them to the **Agents Server**, where they run persistently and work toward their goals.\n\n
| \n\n**Lawyer** \n \nGOAL You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nRespond to incoming legal inquiries via email and keep the company website updated with the latest legal policies. \n \n**RULE** You are knowledgeable, professional, and detail-oriented. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \n \n \nTEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law. \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \n\n |
| \n\n**Company Lawyer** \n \nGOAL \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n**RULE** Always ensure compliance with local laws and regulations. \n**RULE** Never provide legal advice outside your area of expertise. \n**RULE** Never provide legal advice about criminal law. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n**RULE** Always ensure compliance with local laws and regulations. \n**RULE** Never provide legal advice outside your area of expertise. \n**RULE** Never provide legal advice about criminal law. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n**RULE** Always ensure compliance with local laws and regulations. \n**RULE** Never provide legal advice outside your area of expertise. \n**RULE** Never provide legal advice about criminal law. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \nTEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law. \n\n |
| Project | \nAbout | \n
|---|---|
| ⭐ Agents Server | \n\n The primary way to use Promptbook. A production-ready platform where your AI agents live - create, manage, deploy, and interact with persistent agents that work on goals. Available as a hosted service or self-hosted via Docker.\n | \n
| Book language | \n\n Human-friendly, high-level language that abstracts away low-level details of AI. It allows to focus on personality, behavior, knowledge, and rules of AI agents rather than on models, parameters, and prompt engineering.\n \n There is also a plugin for VSCode to support .book file extension\n | \n
| Promptbook Engine | \n\n The open-source core that powers the Agents Server. Can also be used as a standalone TypeScript/JavaScript library to embed agent capabilities into your own applications.\n Released as multiple NPM packages.\n | \n
| Platform | \nDescription | \n
|---|---|
| 💬 Discord | \nJoin our active developer community for discussions and support | \n
| 🗣️ GitHub Discussions | \nTechnical discussions, feature requests, and community Q&A | \n
| Professional updates and industry insights | \n|
| General announcements and community engagement | \n|
| 🔗 ptbk.io | \nOfficial landing page with project information | \n
| 📸 Instagram @promptbook.studio | \nVisual updates, UI showcases, and design inspiration | \n
| Data & Knowledge Management | \nPipeline Control | \n
|---|---|
\n
| \n \n
| \n
| Language & Output Control | \nAdvanced Generation | \n
\n
| \n \n
| \n