@promptbook/openai 0.102.0-2 → 0.102.0-4

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

@@ -1,8 +1,9 @@
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import { id } from '../../../types/typeAliases';
 import type { ChatProps } from '../Chat/ChatProps';
+import type { SendMessageToLlmChatFunction } from '../hooks/useSendMessageToLlmChat';
 import type { ChatMessage } from '../types/ChatMessage';
 import type { ChatParticipant } from '../types/ChatParticipant';
-import type { SendMessageToLlmChatFunction } from '../hooks/useSendMessageToLlmChat';
 /**
  * Props for LlmChat component, derived from ChatProps but with LLM-specific modifications
  *
@@ -34,4 +35,16 @@ export type LlmChatProps = Omit<ChatProps, 'messages' | 'onMessage' | 'onChange'
      * When provided, LlmChat will attach its internal handler to it (no React context needed).
      */
     readonly sendMessage?: SendMessageToLlmChatFunction;
+    /**
+     * Name of the USER as participant in the chat
+     *
+     * @default 'USER'
+     */
+    readonly userParticipantName?: id;
+    /**
+     * Name of the LLM as participant in the chat
+     *
+     * @default 'ASSISTANT'
+     */
+    readonly llmParticipantName?: id;
 };

package/esm/typings/src/book-components/Chat/save/_common/ChatSaveFormatDefinition.d.ts

@@ -0,0 +1,13 @@
+import { string_file_extension, string_mime_type } from '../../../../types/typeAliases';
+import type { ChatMessage } from '../../types/ChatMessage';
+/**
+ * Plugin contract for chat export formatNames
+ * @public exported from `@promptbook/components`
+ */
+export type ChatSaveFormatDefinition = {
+    formatName: string_file_extension | string_mime_type | string;
+    label: string;
+    getContent: (messages: ChatMessage[]) => string;
+    mimeType: string;
+    fileExtension: string;
+};

package/esm/typings/src/book-components/Chat/save/_common/getChatSaveFormatDefinitions.d.ts

@@ -0,0 +1,8 @@
+import { ChatSaveFormatDefinition } from './ChatSaveFormatDefinition';
+import { string_chat_format_name } from './string_chat_format_name';
+/**
+ * Returns enabled chat save plugins filtered by formatNames (or all when omitted)
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function getChatSaveFormatDefinitions(formatNames?: ReadonlyArray<string_chat_format_name>): ReadonlyArray<ChatSaveFormatDefinition>;

package/esm/typings/src/book-components/Chat/save/_common/string_chat_format_name.d.ts

@@ -0,0 +1,6 @@
+import { CHAT_SAVE_FORMATS } from '..';
+/**
+ * Supported chat export formatNames
+ * @public exported from `@promptbook/components`
+ */
+export type string_chat_format_name = typeof CHAT_SAVE_FORMATS[number]['formatName'];

package/esm/typings/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * HTML export plugin
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const htmlSaveFormatDefinition: {
+    readonly formatName: "html";
+    readonly label: "HTML";
+    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "text/html";
+    readonly fileExtension: "html";
+};

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

@@ -0,0 +1,39 @@
+/**
+ * Registry of all built-in chat save plugins
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const CHAT_SAVE_FORMATS: readonly [{
+    readonly formatName: "json";
+    readonly label: "JSON (full)";
+    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "application/json";
+    readonly fileExtension: "json";
+}, {
+    readonly formatName: "txt";
+    readonly label: "Plain Text";
+    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "text/plain";
+    readonly fileExtension: "txt";
+}, {
+    readonly formatName: "md";
+    readonly label: "Markdown";
+    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "text/markdown";
+    readonly fileExtension: "md";
+}, {
+    readonly formatName: "html";
+    readonly label: "HTML";
+    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "text/html";
+    readonly fileExtension: "html";
+}, {
+    readonly formatName: "pdf";
+    readonly label: "PDF";
+    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "application/pdf";
+    readonly fileExtension: "pdf";
+}];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/Chat/save/json/jsonSaveFormatDefinition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * JSON export plugin (full metadata)
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const jsonSaveFormatDefinition: {
+    readonly formatName: "json";
+    readonly label: "JSON (full)";
+    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "application/json";
+    readonly fileExtension: "json";
+};

package/esm/typings/src/book-components/Chat/save/markdown/mdSaveFormatDefinition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Markdown export plugin
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const mdSaveFormatDefinition: {
+    readonly formatName: "md";
+    readonly label: "Markdown";
+    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "text/markdown";
+    readonly fileExtension: "md";
+};

package/esm/typings/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * PDF export plugin
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const pdfSaveFormatDefinition: {
+    readonly formatName: "pdf";
+    readonly label: "PDF";
+    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "application/pdf";
+    readonly fileExtension: "pdf";
+};

package/esm/typings/src/book-components/Chat/save/text/txtSaveFormatDefinition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Plain text export plugin (messages only)
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const txtSaveFormatDefinition: {
+    readonly formatName: "txt";
+    readonly label: "Plain Text";
+    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly mimeType: "text/plain";
+    readonly fileExtension: "txt";
+};

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

@@ -1,16 +1,42 @@
-import type { string_markdown } from '../../../types/typeAliases';
-import type { string_name } from '../../../types/typeAliases';
+import type { id, string_markdown } from '../../../types/typeAliases';
 /**
  * A message in the chat
  *
  * @public exported from `@promptbook/components`
  */
 export type ChatMessage = {
-    id: string;
-    date: Date;
-    from: string_name;
+    /**
+     * Unique identifier of the message
+     */
+    id: id;
+    /**
+     * Date when the message was created
+     */
+    date?: Date;
+    /**
+     * The name of the participant who sent the message
+     */
+    from: id;
+    /**
+     * The content of the message with optional markdown formatting
+     */
     content: string_markdown;
+    /**
+     * Whether the message is complete (for example, if it's still being generated by an AI)
+     *
+     * @default true
+     */
     isComplete?: boolean;
+    /**
+     * @@@
+     */
     expectedAnswer?: string;
+    /**
+     * @@@
+     */
     isVoiceCall?: boolean;
 };
+/**
+ * TODO: Delete `expectedAnswer` from ChatMessage
+ * TODO: Rename `date` into `created`+`modified`
+ */

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

@@ -1,4 +1,4 @@
-import type { string_color, string_name, string_person_fullname, string_url_image } from '../../../types/typeAliases';
+import type { id, string_color, string_person_fullname, string_url_image } from '../../../types/typeAliases';
 import { Color } from '../../../utils/color/Color';
 /**
  * A participant in the chat
@@ -9,11 +9,11 @@ export type ChatParticipant = {
     /**
      * Identifies the participant by their name, same as `message.from`
      */
-    name: string_name;
+    name: id;
     /**
      * Full name of the participant
      */
-    fullname: string_person_fullname;
+    fullname?: string_person_fullname;
     /**
      * Am I the participant? (i.e. is this the user)
      */

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

@@ -7,3 +7,6 @@ import type { ExportFormat } from './ExportFormat';
  * @private utility of `<Chat/>` component
  */
 export declare function exportChatHistory(messages: ChatMessage[], format: ExportFormat, headerMarkdown?: string, participants?: ReadonlyArray<ChatParticipant>): Promise<void>;
+/**
+ * TODO: !!!! Delete this parallel chat history export
+ */

package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts

@@ -63,6 +63,10 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      * Calls OpenAI compatible API to use a embedding model
      */
     callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
+    /**
+     * Internal method that handles parameter retry for embedding model calls
+     */
+    private callEmbeddingModelWithRetry;
     /**
      * Get the model that should be used as default
      */

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.102.0-1`).
+ * It follows semantic versioning (e.g., `0.102.0-3`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.102.0-2",
+    "version": "0.102.0-4",
     "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.102.0-2"
+        "@promptbook/core": "0.102.0-4"
     },
     "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.102.0-2';
+    const PROMPTBOOK_ENGINE_VERSION = '0.102.0-4';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2337,16 +2337,22 @@
          * Calls OpenAI compatible API to use a embedding model
          */
         async callEmbeddingModel(prompt) {
+            return this.callEmbeddingModelWithRetry(prompt, prompt.modelRequirements);
+        }
+        /**
+         * Internal method that handles parameter retry for embedding model calls
+         */
+        async callEmbeddingModelWithRetry(prompt, currentModelRequirements) {
             if (this.options.isVerbose) {
-                console.info(`🖋 ${this.title} embedding call`, { prompt });
+                console.info(`🖋 ${this.title} embedding call`, { prompt, currentModelRequirements });
             }
-            const { content, parameters, modelRequirements } = prompt;
+            const { content, parameters } = prompt;
             const client = await this.getClient();
             // TODO: [☂] Use here more modelRequirements
-            if (modelRequirements.modelVariant !== 'EMBEDDING') {
+            if (currentModelRequirements.modelVariant !== 'EMBEDDING') {
                 throw new PipelineExecutionError('Use embed only for EMBEDDING variant');
             }
-            const modelName = modelRequirements.modelName || this.getDefaultEmbeddingModel().modelName;
+            const modelName = currentModelRequirements.modelName || this.getDefaultEmbeddingModel().modelName;
             const rawPromptContent = templateParameters(content, { ...parameters, modelName });
             const rawRequest = {
                 input: rawPromptContent,
@@ -2356,44 +2362,79 @@
             if (this.options.isVerbose) {
                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
             }
-            const rawResponse = await this.limiter
-                .schedule(() => this.makeRequestWithNetworkRetry(() => client.embeddings.create(rawRequest)))
-                .catch((error) => {
-                assertsError(error);
+            try {
+                const rawResponse = await this.limiter
+                    .schedule(() => this.makeRequestWithNetworkRetry(() => client.embeddings.create(rawRequest)))
+                    .catch((error) => {
+                    assertsError(error);
+                    if (this.options.isVerbose) {
+                        console.info(colors__default["default"].bgRed('error'), error);
+                    }
+                    throw error;
+                });
                 if (this.options.isVerbose) {
-                    console.info(colors__default["default"].bgRed('error'), error);
+                    console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                 }
-                throw error;
-            });
-            if (this.options.isVerbose) {
-                console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
+                const complete = $getCurrentDate();
+                if (rawResponse.data.length !== 1) {
+                    throw new PipelineExecutionError(`Expected exactly 1 data item in response, got ${rawResponse.data.length}`);
+                }
+                const resultContent = rawResponse.data[0].embedding;
+                const usage = this.computeUsage(content || '', '', 
+                // <- Note: Embedding does not have result content
+                rawResponse);
+                return exportJson({
+                    name: 'promptResult',
+                    message: `Result of \`OpenAiCompatibleExecutionTools.callEmbeddingModel\``,
+                    order: [],
+                    value: {
+                        content: resultContent,
+                        modelName: rawResponse.model || modelName,
+                        timing: {
+                            start,
+                            complete,
+                        },
+                        usage,
+                        rawPromptContent,
+                        rawRequest,
+                        rawResponse,
+                        // <- [🗯]
+                    },
+                });
             }
-            const complete = $getCurrentDate();
-            if (rawResponse.data.length !== 1) {
-                throw new PipelineExecutionError(`Expected exactly 1 data item in response, got ${rawResponse.data.length}`);
+            catch (error) {
+                assertsError(error);
+                // Check if this is an unsupported parameter error
+                if (!isUnsupportedParameterError(error)) {
+                    throw error;
+                }
+                // Parse which parameter is unsupported
+                const unsupportedParameter = parseUnsupportedParameterError(error.message);
+                if (!unsupportedParameter) {
+                    if (this.options.isVerbose) {
+                        console.warn(colors__default["default"].bgYellow('Warning'), 'Could not parse unsupported parameter from error:', error.message);
+                    }
+                    throw error;
+                }
+                // Create a unique key for this model + parameter combination to prevent infinite loops
+                const retryKey = `${modelName}-${unsupportedParameter}`;
+                if (this.retriedUnsupportedParameters.has(retryKey)) {
+                    // Already retried this parameter, throw the error
+                    if (this.options.isVerbose) {
+                        console.warn(colors__default["default"].bgRed('Error'), `Parameter '${unsupportedParameter}' for model '${modelName}' already retried once, throwing error:`, error.message);
+                    }
+                    throw error;
+                }
+                // Mark this parameter as retried
+                this.retriedUnsupportedParameters.add(retryKey);
+                // Log warning in verbose mode
+                if (this.options.isVerbose) {
+                    console.warn(colors__default["default"].bgYellow('Warning'), `Removing unsupported parameter '${unsupportedParameter}' for model '${modelName}' and retrying request`);
+                }
+                // Remove the unsupported parameter and retry
+                const modifiedModelRequirements = removeUnsupportedModelRequirement(currentModelRequirements, unsupportedParameter);
+                return this.callEmbeddingModelWithRetry(prompt, modifiedModelRequirements);
             }
-            const resultContent = rawResponse.data[0].embedding;
-            const usage = this.computeUsage(content || '', '', 
-            // <- Note: Embedding does not have result content
-            rawResponse);
-            return exportJson({
-                name: 'promptResult',
-                message: `Result of \`OpenAiCompatibleExecutionTools.callEmbeddingModel\``,
-                order: [],
-                value: {
-                    content: resultContent,
-                    modelName: rawResponse.model || modelName,
-                    timing: {
-                        start,
-                        complete,
-                    },
-                    usage,
-                    rawPromptContent,
-                    rawRequest,
-                    rawResponse,
-                    // <- [🗯]
-                },
-            });
         }
         // <- Note: [🤖] callXxxModel
         /**