@promptbook/openai 0.101.0-2 → 0.101.0-3

package/README.md

@@ -48,28 +48,32 @@ npm i ptbk
 npm install @promptbook/openai
 ```
 
-`@promptbook/openai` integrates [OpenAI's API](https://openai.com/) with [Promptbook](https://github.com/webgptorg/promptbook). It provides execution tools for OpenAI GPT models, OpenAI Assistants, and OpenAI-compatible APIs, enabling seamless integration with the Promptbook ecosystem.
+OpenAI integration for Promptbook, providing execution tools for OpenAI GPT models, OpenAI Assistants, and OpenAI-compatible APIs within the Promptbook ecosystem.
 
 ## 🎯 Purpose and Motivation
 
-This package bridges the gap between Promptbook's unified pipeline execution system and OpenAI's powerful language models. It provides a standardized interface for accessing OpenAI's various services while maintaining compatibility with Promptbook's execution framework.
+This package bridges the gap between Promptbook's unified pipeline execution system and OpenAI's powerful language models. It provides a standardized interface for accessing OpenAI's various services while maintaining compatibility with Promptbook's execution framework, enabling seamless integration with different OpenAI offerings.
 
 ## 🔧 High-Level Functionality
 
 The package offers three main integration paths:
-- **Standard OpenAI API**: Direct integration with OpenAI's chat completions and embeddings
-- **OpenAI Assistants**: Integration with OpenAI's Assistant API (GPTs)
-- **OpenAI-Compatible APIs**: Support for third-party APIs that follow OpenAI's interface
+
+-   **Standard OpenAI API**: Direct integration with OpenAI's chat completions and embeddings
+-   **OpenAI Assistants**: Integration with OpenAI's Assistant API (GPTs)
+-   **OpenAI-Compatible APIs**: Support for third-party APIs that follow OpenAI's interface
+-   **Model Management**: Automatic model selection and configuration
+-   **Usage Tracking**: Built-in monitoring for tokens and costs
 
 ## ✨ Key Features
 
-- 🤖 **Multiple OpenAI Integrations** - Support for standard API, Assistants, and compatible services
-- 🔄 **Seamless Provider Switching** - Easy integration with other LLM providers
-- 🎯 **Model Selection** - Access to all available OpenAI models with automatic selection
-- 🔧 **Configuration Flexibility** - Support for custom endpoints, API keys, and parameters
-- 📊 **Usage Tracking** - Built-in token usage and cost monitoring
-- 🛡️ **Error Handling** - Comprehensive error handling and retry logic
-- 🚀 **Performance Optimization** - Caching and request optimization
+-   🤖 **Multiple OpenAI Integrations** - Support for standard API, Assistants, and compatible services
+-   🔄 **Seamless Provider Switching** - Easy integration with other LLM providers
+-   🎯 **Model Selection** - Access to all available OpenAI models with automatic selection
+-   🔧 **Configuration Flexibility** - Support for custom endpoints, API keys, and parameters
+-   📊 **Usage Tracking** - Built-in token usage and cost monitoring
+-   🛡️ **Error Handling** - Comprehensive error handling and retry logic
+-   🚀 **Performance Optimization** - Caching and request optimization
+-   🔌 **OpenAI-Compatible Server** - Use Promptbook books as OpenAI-compatible models
 
 ## 🧡 Usage
 
@@ -323,36 +327,46 @@ This allows you to:
 -   Integrate Promptbook into existing OpenAI-based applications
 -   Use Promptbook books as models in other AI frameworks
 
+
+
 ## 📦 Exported Entities
 
 ### Version Information
-- `BOOK_LANGUAGE_VERSION` - Current book language version
-- `PROMPTBOOK_ENGINE_VERSION` - Current engine version
+
+-   `BOOK_LANGUAGE_VERSION` - Current book language version
+-   `PROMPTBOOK_ENGINE_VERSION` - Current engine version
 
 ### Execution Tools Creation Functions
-- `createOpenAiAssistantExecutionTools` - Create OpenAI Assistant execution tools
-- `createOpenAiCompatibleExecutionTools` - Create OpenAI-compatible execution tools
-- `createOpenAiExecutionTools` - Create standard OpenAI execution tools
+
+-   `createOpenAiAssistantExecutionTools` - Create OpenAI Assistant execution tools
+-   `createOpenAiCompatibleExecutionTools` - Create OpenAI-compatible execution tools
+-   `createOpenAiExecutionTools` - Create standard OpenAI execution tools
 
 ### Model Information
-- `OPENAI_MODELS` - Available OpenAI models configuration
+
+-   `OPENAI_MODELS` - Available OpenAI models configuration
 
 ### Execution Tools Classes
-- `OpenAiAssistantExecutionTools` - OpenAI Assistant execution tools class
-- `OpenAiCompatibleExecutionTools` - OpenAI-compatible execution tools class
-- `OpenAiExecutionTools` - Standard OpenAI execution tools class
+
+-   `OpenAiAssistantExecutionTools` - OpenAI Assistant execution tools class
+-   `OpenAiCompatibleExecutionTools` - OpenAI-compatible execution tools class
+-   `OpenAiExecutionTools` - Standard OpenAI execution tools class
 
 ### Configuration Types
-- `OpenAiAssistantExecutionToolsOptions` - Configuration options for OpenAI Assistant tools (type)
-- `OpenAiCompatibleExecutionToolsOptions` - Configuration options for OpenAI-compatible tools (type)
-- `OpenAiCompatibleExecutionToolsNonProxiedOptions` - Non-proxied configuration options (type)
-- `OpenAiCompatibleExecutionToolsProxiedOptions` - Proxied configuration options (type)
-- `OpenAiExecutionToolsOptions` - Configuration options for standard OpenAI tools (type)
+
+-   `OpenAiAssistantExecutionToolsOptions` - Configuration options for OpenAI Assistant tools (type)
+-   `OpenAiCompatibleExecutionToolsOptions` - Configuration options for OpenAI-compatible tools (type)
+-   `OpenAiCompatibleExecutionToolsNonProxiedOptions` - Non-proxied configuration options (type)
+-   `OpenAiCompatibleExecutionToolsProxiedOptions` - Proxied configuration options (type)
+-   `OpenAiExecutionToolsOptions` - Configuration options for standard OpenAI tools (type)
 
 ### Provider Registrations
-- `_OpenAiRegistration` - Standard OpenAI provider registration
-- `_OpenAiAssistantRegistration` - OpenAI Assistant provider registration
-- `_OpenAiCompatibleRegistration` - OpenAI-compatible provider registration
+
+-   `_OpenAiRegistration` - Standard OpenAI provider registration
+-   `_OpenAiAssistantRegistration` - OpenAI Assistant provider registration
+-   `_OpenAiCompatibleRegistration` - OpenAI-compatible provider registration
+
+> 💡 This package provides OpenAI integration for promptbook applications. For the core functionality, see [@promptbook/core](#-packages) or install all packages with `npm i ptbk`
 
 
 ---

package/esm/index.es.js

@@ -19,7 +19,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.101.0-2';
+const PROMPTBOOK_ENGINE_VERSION = '0.101.0-3';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts

@@ -119,4 +119,24 @@ export type ChatProps = {
      * Keys should match ChatMessage.from values (e.g., 'USER', 'AGENT_{id}', etc.)
      */
     readonly participants?: ReadonlyArray<ChatParticipant>;
+    /**
+     * Optional callback for handling user feedback on messages
+     * When provided, star rating buttons (1-5 stars) will be displayed next to each message
+     *
+     * @param feedback - Object containing the feedback data
+     * @param feedback.message - The message being rated
+     * @param feedback.rating - Star rating from 1 to 5
+     * @param feedback.textRating - Optional text feedback/note from user
+     * @param feedback.chatThread - Complete chat thread as string
+     * @param feedback.expectedAnswer - Optional expected answer provided by user
+     * @param feedback.url - Current page URL where feedback was given
+     */
+    onFeedback?(feedback: {
+        message: ChatMessage;
+        rating: number;
+        textRating: string;
+        chatThread: string;
+        expectedAnswer: string | null;
+        url: string;
+    }): Promisable<void>;
 };

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.101.0-1`).
+ * It follows semantic versioning (e.g., `0.101.0-2`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.101.0-2",
+    "version": "0.101.0-3",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -102,7 +102,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.101.0-2"
+        "@promptbook/core": "0.101.0-3"
     },
     "dependencies": {
         "bottleneck": "^2.19.5",

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-2';
+    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-3';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name