@promptbook/openai 0.95.0 → 0.98.0-10

package/README.md

@@ -25,6 +25,10 @@ Write AI applications using plain human language across multiple models and plat
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/openai`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -94,7 +98,7 @@ const { isSuccessful, errors, outputParameters, executionReport } = result;
 console.info(outputParameters);
 ```
 
-## 🤺 Usage with OpenAI`s Assistants (GPTs)
+## 🤺 Usage with OpenAI's Assistants (GPTs)
 
 > TODO: Write a guide how to use OpenAI's Assistants with Promptbook
 
@@ -197,7 +201,7 @@ const llm = [
         //            <- TODO: [🧱] Implement in a functional (not new Class) way
         {
             resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,
-            deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,
+            deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME
             apiKey: process.env.AZUREOPENAI_API_KEY,
         },
     ),
@@ -245,6 +249,55 @@ See the other model integrations:
 
 
 
+## 🤖 Using Promptbook as an OpenAI-compatible model
+
+You can use Promptbook books as if they were OpenAI models by using the OpenAI-compatible endpoint. This allows you to use the standard OpenAI SDK with Promptbook books.
+
+First, start the Promptbook server:
+
+```typescript
+import { startRemoteServer } from '@promptbook/remote-server';
+
+// Start the server
+await startRemoteServer({
+    port: 3000,
+    collection: await createCollectionFromDirectory('./books'),
+    isAnonymousModeAllowed: true,
+    isApplicationModeAllowed: true,
+});
+```
+
+Then use the standard OpenAI SDK with the server URL:
+
+```typescript
+import OpenAI from 'openai';
+
+// Create OpenAI client pointing to your Promptbook server
+const openai = new OpenAI({
+    baseURL: 'http://localhost:3000', // Your Promptbook server URL
+    apiKey: 'not-needed', // API key is not needed for Promptbook
+});
+
+// Use any Promptbook book as a model
+const response = await openai.chat.completions.create({
+    model: 'https://promptbook.studio/my-collection/write-article.book', // Book URL as model name
+    messages: [
+        {
+            role: 'user',
+            content: 'Write a short story about a cat',
+        },
+    ],
+});
+
+console.log(response.choices[0].message.content);
+```
+
+This allows you to:
+
+-   Use Promptbook books with any OpenAI-compatible client
+-   Integrate Promptbook into existing OpenAI-based applications
+-   Use Promptbook books as models in other AI frameworks
+
 
 ---
 
@@ -259,6 +312,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), 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.
@@ -384,6 +439,8 @@ Join our growing community of developers and users:
 
 _A concise, Markdown-based DSL for crafting AI workflows and automations._
 
+
+
 ### Introduction
 
 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.
@@ -433,6 +490,8 @@ Personas can have access to different knowledge, tools and actions. They can als
 
 -   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
+
+
 ### **3. How:** Knowledge, Instruments and Actions
 
 The resources used by the personas are used to do the work.
@@ -532,6 +591,8 @@ The following glossary is used to clarify certain concepts:
 
 _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
+
+
 ### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)