@promptbook/openai 0.94.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
 
@@ -108,11 +112,11 @@ console.info(outputParameters);
 Run books without any settings, boilerplate or struggle in Node.js:
 
 ```typescript
-import { wizzard } from '@promptbook/wizzard';
+import { wizard } from '@promptbook/wizard';
 
 const {
     outputParameters: { joke },
-} = await wizzard.execute(`https://github.com/webgptorg/book/blob/main/books/templates/generic.book`, {
+} = await wizard.execute(`https://github.com/webgptorg/book/blob/main/books/templates/generic.book`, {
     topic: 'Prague',
 });
 
@@ -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
+
 
 ---
 
@@ -486,13 +539,13 @@ Or you can install them separately:
 
 -   ⭐ **[ptbk](https://www.npmjs.com/package/ptbk)** - Bundle of all packages, when you want to install everything and you don't care about the size
 -   **[promptbook](https://www.npmjs.com/package/promptbook)** - Same as `ptbk`
--   ⭐🧙‍♂️ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizzard to just run the books in node without any struggle
+-   ⭐🧙‍♂️ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard to just run the books in node without any struggle
 -   **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
 -   **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js environment
 -   **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
 -   ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
 -   **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
--   _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
+-   _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
 -   **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
 -   **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
 -   **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK