@promptbook/openai 0.110.0-8 → 0.110.0

package/README.md

@@ -27,10 +27,6 @@ Turn your company's scattered knowledge into AI ready Books
 
 
 
-<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).

package/esm/index.es.js

@@ -23,7 +23,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.110.0-8';
+const PROMPTBOOK_ENGINE_VERSION = '0.110.0';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2725,6 +2725,66 @@ const OPENAI_MODELS = exportJson({
         },
         /**/
         /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'gpt-5.2-codex',
+            modelName: 'gpt-5.2-codex',
+            modelDescription: 'High-capability Codex variant tuned for agentic code generation with large contexts and reasoning effort controls. Ideal for long-horizon coding workflows and multi-step reasoning.',
+            pricing: {
+                prompt: pricing(`$1.75 / 1M tokens`),
+                output: pricing(`$14.00 / 1M tokens`),
+            },
+        },
+        /**/
+        /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'gpt-5.1-codex-max',
+            modelName: 'gpt-5.1-codex-max',
+            modelDescription: 'Premium GPT-5.1 Codex flavor that mirrors gpt-5.1 in capability and pricing while adding Codex tooling optimizations.',
+            pricing: {
+                prompt: pricing(`$1.25 / 1M tokens`),
+                output: pricing(`$10.00 / 1M tokens`),
+            },
+        },
+        /**/
+        /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'gpt-5.1-codex',
+            modelName: 'gpt-5.1-codex',
+            modelDescription: 'Core GPT-5.1 Codex model focused on agentic coding tasks with a balanced trade-off between reasoning and cost.',
+            pricing: {
+                prompt: pricing(`$1.25 / 1M tokens`),
+                output: pricing(`$10.00 / 1M tokens`),
+            },
+        },
+        /**/
+        /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'gpt-5.1-codex-mini',
+            modelName: 'gpt-5.1-codex-mini',
+            modelDescription: 'Compact, cost-effective GPT-5.1 Codex variant with a smaller context window ideal for cheap assistant iterations that still require coding awareness.',
+            pricing: {
+                prompt: pricing(`$0.25 / 1M tokens`),
+                output: pricing(`$2.00 / 1M tokens`),
+            },
+        },
+        /**/
+        /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'gpt-5-codex',
+            modelName: 'gpt-5-codex',
+            modelDescription: 'Legacy GPT-5 Codex model built for agentic coding workloads with the same pricing as GPT-5 and a focus on stability.',
+            pricing: {
+                prompt: pricing(`$1.25 / 1M tokens`),
+                output: pricing(`$10.00 / 1M tokens`),
+            },
+        },
+        /**/
+        /**/
         {
             modelVariant: 'CHAT',
             modelTitle: 'gpt-5-mini',
@@ -3476,6 +3536,32 @@ function isUnsupportedParameterError(error) {
         errorMessage.includes('does not support'));
 }
 
+/**
+ * Provides access to the structured clone implementation when available.
+ */
+function getStructuredCloneFunction() {
+    return globalThis.structuredClone;
+}
+/**
+ * Checks whether the prompt is a chat prompt that carries file attachments.
+ */
+function hasChatPromptFiles(prompt) {
+    return 'files' in prompt && Array.isArray(prompt.files);
+}
+/**
+ * Creates a deep copy of the prompt while keeping attached files intact when structured clone is not available.
+ */
+function clonePromptPreservingFiles(prompt) {
+    const structuredCloneFn = getStructuredCloneFunction();
+    if (typeof structuredCloneFn === 'function') {
+        return structuredCloneFn(prompt);
+    }
+    const clonedPrompt = JSON.parse(JSON.stringify(prompt));
+    if (hasChatPromptFiles(prompt)) {
+        clonedPrompt.files = prompt.files;
+    }
+    return clonedPrompt;
+}
 /**
  * Execution Tools for calling OpenAI API or other OpenAI compatible provider
  *
@@ -3560,7 +3646,7 @@ class OpenAiCompatibleExecutionTools {
      */
     async callChatModelStream(prompt, onProgress) {
         // Deep clone prompt and modelRequirements to avoid mutation across calls
-        const clonedPrompt = JSON.parse(JSON.stringify(prompt));
+        const clonedPrompt = clonePromptPreservingFiles(prompt);
         // Use local Set for retried parameters to ensure independence and thread safety
         const retriedUnsupportedParameters = new Set();
         return this.callChatModelWithRetry(clonedPrompt, clonedPrompt.modelRequirements, [], retriedUnsupportedParameters, onProgress);
@@ -3587,7 +3673,10 @@ class OpenAiCompatibleExecutionTools {
             // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
             // <- Note: [🧆]
         }; // <- TODO: [💩] Guard here types better
-        if (format === 'JSON') {
+        if (currentModelRequirements.responseFormat !== undefined) {
+            modelSettings.response_format = currentModelRequirements.responseFormat;
+        }
+        else if (format === 'JSON') {
             modelSettings.response_format = {
                 type: 'json_object',
             };
@@ -4432,6 +4521,89 @@ class OpenAiExecutionTools extends OpenAiCompatibleExecutionTools {
     }
 }
 
+/**
+ * @@@
+ *
+ * @private thing of inline knowledge
+ */
+const INLINE_KNOWLEDGE_BASE_NAME = 'inline-knowledge';
+/**
+ * @@@
+ *
+ * @private thing of inline knowledge
+ */
+const INLINE_KNOWLEDGE_EXTENSION = '.txt';
+/**
+ * @@@
+ *
+ * @private thing of inline knowledge
+ */
+const DATA_URL_PREFIX = 'data:';
+/**
+ * Checks whether the provided source string is a data URL that can be decoded.
+ *
+ * @private thing of inline knowledge
+ */
+function isDataUrlKnowledgeSource(source) {
+    return typeof source === 'string' && source.startsWith(DATA_URL_PREFIX);
+}
+/**
+ * Parses a data URL-based knowledge source into its raw buffer, filename, and MIME type.
+ *
+ * @private thing of inline knowledge
+ */
+function parseDataUrlKnowledgeSource(source) {
+    if (!isDataUrlKnowledgeSource(source)) {
+        return null;
+    }
+    const commaIndex = source.indexOf(',');
+    if (commaIndex === -1) {
+        return null;
+    }
+    const header = source.slice(DATA_URL_PREFIX.length, commaIndex);
+    const payload = source.slice(commaIndex + 1);
+    const tokens = header.split(';');
+    const mediaType = tokens[0] || 'text/plain';
+    let filename = `${INLINE_KNOWLEDGE_BASE_NAME}${INLINE_KNOWLEDGE_EXTENSION}`;
+    let isBase64 = false;
+    for (let i = 1; i < tokens.length; i++) {
+        const token = tokens[i];
+        if (!token) {
+            continue;
+        }
+        if (token.toLowerCase() === 'base64') {
+            isBase64 = true;
+            continue;
+        }
+        const [key, value] = token.split('=');
+        if (key === 'name' && value !== undefined) {
+            try {
+                filename = decodeURIComponent(value);
+            }
+            catch (_a) {
+                filename = value;
+            }
+        }
+    }
+    if (!isBase64) {
+        return null;
+    }
+    try {
+        const buffer = Buffer.from(payload, 'base64');
+        return {
+            buffer,
+            filename,
+            mimeType: mediaType,
+        };
+    }
+    catch (_b) {
+        return null;
+    }
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
 const DEFAULT_KNOWLEDGE_SOURCE_DOWNLOAD_TIMEOUT_MS = 30000;
 const DEFAULT_KNOWLEDGE_SOURCE_UPLOAD_TIMEOUT_MS = 900000;
 const VECTOR_STORE_PROGRESS_LOG_INTERVAL_MIN_MS = 15000;
@@ -5068,7 +5240,9 @@ class OpenAiVectorStoreHandler extends OpenAiExecutionTools {
         const processingStartedAtMs = Date.now();
         for (const [index, source] of knowledgeSources.entries()) {
             try {
-                const sourceType = source.startsWith('http') || source.startsWith('https') ? 'url' : 'file';
+                const isDataUrl = isDataUrlKnowledgeSource(source);
+                const isHttp = source.startsWith('http://') || source.startsWith('https://');
+                const sourceType = isDataUrl ? 'data_url' : isHttp ? 'url' : 'file';
                 if (this.options.isVerbose) {
                     console.info('[🤰]', 'Processing knowledge source', {
                         index: index + 1,
@@ -5078,8 +5252,27 @@ class OpenAiVectorStoreHandler extends OpenAiExecutionTools {
                         logLabel,
                     });
                 }
-                // Check if it's a URL
-                if (source.startsWith('http://') || source.startsWith('https://')) {
+                if (isDataUrl) {
+                    const parsed = parseDataUrlKnowledgeSource(source);
+                    if (!parsed) {
+                        skippedSources.push({ source, reason: 'invalid_data_url' });
+                        if (this.options.isVerbose) {
+                            console.info('[🤰]', 'Skipping knowledge source (invalid data URL)', {
+                                source,
+                                sourceType,
+                                logLabel,
+                            });
+                        }
+                        continue;
+                    }
+                    const dataUrlFile = new File([parsed.buffer], parsed.filename, {
+                        type: parsed.mimeType,
+                    });
+                    fileStreams.push(dataUrlFile);
+                    totalBytes += parsed.buffer.length;
+                    continue;
+                }
+                if (isHttp) {
                     const downloadResult = await this.downloadKnowledgeSourceFile({
                         source,
                         timeoutMs: downloadTimeoutMs,
@@ -6146,6 +6339,64 @@ const createOpenAiExecutionTools = Object.assign((options) => {
  */
 
 const DEFAULT_AGENT_KIT_MODEL_NAME = 'gpt-5.2';
+const DEFAULT_JSON_SCHEMA_NAME = 'StructuredOutput';
+/*
+TODO: Use or remove
+const EMPTY_JSON_SCHEMA: JsonSchemaDefinition['schema'] = {
+    type: 'object',
+    properties: {},
+    required: [],
+    additionalProperties: true,
+};
+*/
+function buildJsonSchemaDefinition(jsonSchema) {
+    var _a, _b, _c;
+    const schema = (_a = jsonSchema === null || jsonSchema === void 0 ? void 0 : jsonSchema.schema) !== null && _a !== void 0 ? _a : {};
+    return {
+        type: 'json_schema',
+        name: (_b = jsonSchema === null || jsonSchema === void 0 ? void 0 : jsonSchema.name) !== null && _b !== void 0 ? _b : DEFAULT_JSON_SCHEMA_NAME,
+        strict: Boolean(jsonSchema === null || jsonSchema === void 0 ? void 0 : jsonSchema.strict),
+        schema: {
+            type: 'object',
+            properties: ((_c = schema.properties) !== null && _c !== void 0 ? _c : {}),
+            required: Array.isArray(schema.required) ? schema.required : [],
+            additionalProperties: schema.additionalProperties === undefined ? true : Boolean(schema.additionalProperties),
+            description: schema.description,
+        },
+    };
+}
+/**
+ * Maps OpenAI `response_format` payloads to AgentKit output types so the runner can forward
+ * structured-output preferences to OpenAI while still reusing the same AgentKit agent instance.
+ *
+ * @param responseFormat - The OpenAI `response_format` payload from the user request.
+ * @returns An Agent output type compatible with the requested schema or `undefined` when no impact is required.
+ * @private utility of Open AI
+ */
+function mapResponseFormatToAgentOutputType(responseFormat) {
+    if (!responseFormat) {
+        return undefined;
+    }
+    if (typeof responseFormat === 'string') {
+        if (responseFormat === 'text') {
+            return 'text';
+        }
+        if (responseFormat === 'json_schema' || responseFormat === 'json_object') {
+            return buildJsonSchemaDefinition();
+        }
+        return 'text';
+    }
+    switch (responseFormat.type) {
+        case 'text':
+            return 'text';
+        case 'json_schema':
+            return buildJsonSchemaDefinition(responseFormat.json_schema);
+        case 'json_object':
+            return buildJsonSchemaDefinition();
+        default:
+            return undefined;
+    }
+}
 /**
  * Execution tools for OpenAI AgentKit (Agents SDK).
  *
@@ -6193,6 +6444,7 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
             ...parameters,
             modelName: this.agentKitModelName,
         });
+        const responseFormatOutputType = mapResponseFormatToAgentOutputType(modelRequirements.responseFormat);
         const preparedAgentKitAgent = await this.prepareAgentKitAgent({
             name: (prompt.title || 'Agent'),
             instructions: modelRequirements.systemMessage || '',
@@ -6204,6 +6456,7 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
             prompt,
             rawPromptContent,
             onProgress,
+            responseFormatOutputType,
         });
     }
     /**
@@ -6385,16 +6638,21 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
             ...prompt.parameters,
             modelName: this.agentKitModelName,
         });
+        const agentForRun = options.responseFormatOutputType !== undefined
+            ? openAiAgentKitAgent.clone({
+                outputType: options.responseFormatOutputType,
+            })
+            : openAiAgentKitAgent;
         const start = $getCurrentDate();
         let latestContent = '';
         const toolCalls = [];
         const toolCallIndexById = new Map();
         const inputItems = await this.buildAgentKitInputItems(prompt, rawPromptContent);
         const rawRequest = {
-            agentName: openAiAgentKitAgent.name,
+            agentName: agentForRun.name,
             input: inputItems,
         };
-        const streamResult = await run(openAiAgentKitAgent, inputItems, {
+        const streamResult = await run(agentForRun, inputItems, {
             stream: true,
             context: { parameters: prompt.parameters },
         });