@promptbook/openai 0.72.0-0 → 0.72.0-2

package/README.md

@@ -16,6 +16,10 @@ Supercharge your use of large language models
 
 
 
+## ✨ New Features
+
+-   ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
+
 ## 📦 Package `@promptbook/openai`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -28,7 +32,7 @@ To install this package, run:
 npm i ptbk
 
 # Install just this package to save space
-npm i @promptbook/openai
+npm install @promptbook/openai
 ```
 
 `@promptbook/openai` integrates [OpenAI's API](https://openai.com/) with [Promptbook](https://github.com/webgptorg/promptbook). It allows to execute Promptbooks with OpenAI GPT models.
@@ -79,6 +83,11 @@ const { isSuccessful, errors, outputParameters, executionReport } = result;
 console.info(outputParameters);
 ```
 
+## 🤺 Usage with OpenAI`s Assistants (GPTs)
+
+!!!!!!
+OpenAiExecutionTools.createAssistantSubtools
+
 ## 🧙‍♂️ Connect to LLM providers automatically
 
 You can just use `createLlmToolsFromEnv` function to create LLM tools from environment variables like `OPENAI_API_KEY` and `ANTHROPIC_CLAUDE_API_KEY` automatically.
@@ -202,10 +211,6 @@ See the other models available in the Promptbook package:
 
 Rest of the documentation is common for **entire promptbook ecosystem**:
 
-# ✨ New Features
-
--   ✨ **Support [OpenAI o1 model](https://openai.com/o1/)**
-
 ## 🤍 The Promptbook Whitepaper
 
 
@@ -252,7 +257,6 @@ File `write-website-content.ptbk.md`:
 > Instructions for creating web page content.
 >
 > -   PIPELINE URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
-> -   PROMPTBOOK VERSION 0.0.1
 > -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
 > -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
 > -   OUTPUT PARAM `{websiteContent}` Web content

package/esm/index.es.js

@@ -1,12 +1,12 @@
 import colors from 'colors';
-import OpenAI from 'openai';
 import spaceTrim$1, { spaceTrim } from 'spacetrim';
+import OpenAI from 'openai';
 
 // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.68.5';
+var PROMPTBOOK_VERSION = '0.72.0-1';
 // TODO:[main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -147,46 +147,37 @@ var $isRunningInBrowser = new Function("\n    try {\n        return this === win
 var $isRunningInWebWorker = new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
 
 /**
- * This error indicates errors during the execution of the pipeline
+ * This error type indicates that some part of the code is not implemented yet
  *
  * @public exported from `@promptbook/core`
  */
-var PipelineExecutionError = /** @class */ (function (_super) {
-    __extends(PipelineExecutionError, _super);
-    function PipelineExecutionError(message) {
-        var _this = _super.call(this, message) || this;
-        _this.name = 'PipelineExecutionError';
-        Object.setPrototypeOf(_this, PipelineExecutionError.prototype);
+var NotYetImplementedError = /** @class */ (function (_super) {
+    __extends(NotYetImplementedError, _super);
+    function NotYetImplementedError(message) {
+        var _this = _super.call(this, spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+        _this.name = 'NotYetImplementedError';
+        Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
         return _this;
     }
-    return PipelineExecutionError;
+    return NotYetImplementedError;
 }(Error));
 
 /**
- * This error type indicates that the error should not happen and its last check before crashing with some other error
+ * This error indicates errors during the execution of the pipeline
  *
  * @public exported from `@promptbook/core`
  */
-var UnexpectedError = /** @class */ (function (_super) {
-    __extends(UnexpectedError, _super);
-    function UnexpectedError(message) {
-        var _this = _super.call(this, spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
-        _this.name = 'UnexpectedError';
-        Object.setPrototypeOf(_this, UnexpectedError.prototype);
+var PipelineExecutionError = /** @class */ (function (_super) {
+    __extends(PipelineExecutionError, _super);
+    function PipelineExecutionError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.name = 'PipelineExecutionError';
+        Object.setPrototypeOf(_this, PipelineExecutionError.prototype);
         return _this;
     }
-    return UnexpectedError;
+    return PipelineExecutionError;
 }(Error));
 
-/**
- * Get current date in ISO 8601 format
- *
- * @private internal utility
- */
-function getCurrentIsoDate() {
-    return new Date().toISOString();
-}
-
 /**
  * @@@
  *
@@ -221,6 +212,84 @@ function $deepFreeze(objectValue) {
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */
 
+/**
+ * Represents the usage with no resources consumed
+ *
+ * @public exported from `@promptbook/core`
+ */
+$deepFreeze({
+    price: { value: 0 },
+    input: {
+        tokensCount: { value: 0 },
+        charactersCount: { value: 0 },
+        wordsCount: { value: 0 },
+        sentencesCount: { value: 0 },
+        linesCount: { value: 0 },
+        paragraphsCount: { value: 0 },
+        pagesCount: { value: 0 },
+    },
+    output: {
+        tokensCount: { value: 0 },
+        charactersCount: { value: 0 },
+        wordsCount: { value: 0 },
+        sentencesCount: { value: 0 },
+        linesCount: { value: 0 },
+        paragraphsCount: { value: 0 },
+        pagesCount: { value: 0 },
+    },
+});
+/**
+ * Represents the usage with unknown resources consumed
+ *
+ * @public exported from `@promptbook/core`
+ */
+var UNCERTAIN_USAGE = $deepFreeze({
+    price: { value: 0, isUncertain: true },
+    input: {
+        tokensCount: { value: 0, isUncertain: true },
+        charactersCount: { value: 0, isUncertain: true },
+        wordsCount: { value: 0, isUncertain: true },
+        sentencesCount: { value: 0, isUncertain: true },
+        linesCount: { value: 0, isUncertain: true },
+        paragraphsCount: { value: 0, isUncertain: true },
+        pagesCount: { value: 0, isUncertain: true },
+    },
+    output: {
+        tokensCount: { value: 0, isUncertain: true },
+        charactersCount: { value: 0, isUncertain: true },
+        wordsCount: { value: 0, isUncertain: true },
+        sentencesCount: { value: 0, isUncertain: true },
+        linesCount: { value: 0, isUncertain: true },
+        paragraphsCount: { value: 0, isUncertain: true },
+        pagesCount: { value: 0, isUncertain: true },
+    },
+});
+
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private internal utility
+ */
+function getCurrentIsoDate() {
+    return new Date().toISOString();
+}
+
+/**
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
+ *
+ * @public exported from `@promptbook/core`
+ */
+var UnexpectedError = /** @class */ (function (_super) {
+    __extends(UnexpectedError, _super);
+    function UnexpectedError(message) {
+        var _this = _super.call(this, spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+        _this.name = 'UnexpectedError';
+        Object.setPrototypeOf(_this, UnexpectedError.prototype);
+        return _this;
+    }
+    return UnexpectedError;
+}(Error));
+
 /**
  * Checks if the value is [🚉] serializable as JSON
  * If not, throws an UnexpectedError with a rich error message and tracking
@@ -389,6 +458,7 @@ $asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', [
     'samples',
     'modelName',
     'currentDate',
+    // <- TODO: !!!!! list here all command names
     // <- TODO: Add more like 'date', 'modelName',...
     // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
 ]);
@@ -404,6 +474,18 @@ var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
  * @private within the repository
  */
 var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+// <- TODO: [🧜‍♂️]
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+Object.freeze({
+    delimiter: ',',
+    quoteChar: '"',
+    newline: '\n',
+    skipEmptyLines: true,
+});
 /**
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */
@@ -1366,6 +1448,15 @@ var OpenAiExecutionTools = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Create (sub)tools for calling OpenAI API Assistants
+     *
+     * @param assistantId Which assistant to use
+     * @returns Tools for calling OpenAI API Assistants with same token
+     */
+    OpenAiExecutionTools.prototype.createAssistantSubtools = function (assistantId) {
+        return new OpenAiAssistantExecutionTools(__assign(__assign({}, this.options), { assistantId: assistantId }));
+    };
     /**
      * Check the `options` passed to `constructor`
      */
@@ -1462,7 +1553,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                         resultContent = rawResponse.choices[0].message.content;
                         // eslint-disable-next-line prefer-const
                         complete = getCurrentIsoDate();
-                        usage = computeOpenAiUsage(content, resultContent || '', rawResponse);
+                        usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
                         if (resultContent === null) {
                             throw new PipelineExecutionError('No response message from OpenAI');
                         }
@@ -1534,7 +1625,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                         resultContent = rawResponse.choices[0].text;
                         // eslint-disable-next-line prefer-const
                         complete = getCurrentIsoDate();
-                        usage = computeOpenAiUsage(content, resultContent || '', rawResponse);
+                        usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
                         return [2 /*return*/, $asDeeplyFrozenSerializableJson('OpenAiExecutionTools CompletionPromptResult', {
                                 content: resultContent,
                                 modelName: rawResponse.model || modelName,
@@ -1594,7 +1685,9 @@ var OpenAiExecutionTools = /** @class */ (function () {
                         resultContent = rawResponse.data[0].embedding;
                         // eslint-disable-next-line prefer-const
                         complete = getCurrentIsoDate();
-                        usage = computeOpenAiUsage(content, '', rawResponse);
+                        usage = computeOpenAiUsage(content || '', '', 
+                        // <- Note: Embedding does not have result content
+                        rawResponse);
                         return [2 /*return*/, $asDeeplyFrozenSerializableJson('OpenAiExecutionTools EmbeddingPromptResult', {
                                 content: resultContent,
                                 modelName: rawResponse.model || modelName,
@@ -1659,95 +1752,6 @@ var OpenAiExecutionTools = /** @class */ (function () {
  * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
  */
 
-/**
- * Execution Tools for calling OpenAI API
- *
- * @public exported from `@promptbook/openai`
- */
-var createOpenAiExecutionTools = Object.assign(function (options) {
-    // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
-    if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
-        options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
-    }
-    return new OpenAiExecutionTools(options);
-}, {
-    packageName: '@promptbook/openai',
-    className: 'OpenAiExecutionTools',
-});
-/**
- * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */
-
-/**
- * This error type indicates that some part of the code is not implemented yet
- *
- * @public exported from `@promptbook/core`
- */
-var NotYetImplementedError = /** @class */ (function (_super) {
-    __extends(NotYetImplementedError, _super);
-    function NotYetImplementedError(message) {
-        var _this = _super.call(this, spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
-        _this.name = 'NotYetImplementedError';
-        Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
-        return _this;
-    }
-    return NotYetImplementedError;
-}(Error));
-
-/**
- * Represents the usage with no resources consumed
- *
- * @public exported from `@promptbook/core`
- */
-$deepFreeze({
-    price: { value: 0 },
-    input: {
-        tokensCount: { value: 0 },
-        charactersCount: { value: 0 },
-        wordsCount: { value: 0 },
-        sentencesCount: { value: 0 },
-        linesCount: { value: 0 },
-        paragraphsCount: { value: 0 },
-        pagesCount: { value: 0 },
-    },
-    output: {
-        tokensCount: { value: 0 },
-        charactersCount: { value: 0 },
-        wordsCount: { value: 0 },
-        sentencesCount: { value: 0 },
-        linesCount: { value: 0 },
-        paragraphsCount: { value: 0 },
-        pagesCount: { value: 0 },
-    },
-});
-/**
- * Represents the usage with unknown resources consumed
- *
- * @public exported from `@promptbook/core`
- */
-var UNCERTAIN_USAGE = $deepFreeze({
-    price: { value: 0, isUncertain: true },
-    input: {
-        tokensCount: { value: 0, isUncertain: true },
-        charactersCount: { value: 0, isUncertain: true },
-        wordsCount: { value: 0, isUncertain: true },
-        sentencesCount: { value: 0, isUncertain: true },
-        linesCount: { value: 0, isUncertain: true },
-        paragraphsCount: { value: 0, isUncertain: true },
-        pagesCount: { value: 0, isUncertain: true },
-    },
-    output: {
-        tokensCount: { value: 0, isUncertain: true },
-        charactersCount: { value: 0, isUncertain: true },
-        wordsCount: { value: 0, isUncertain: true },
-        sentencesCount: { value: 0, isUncertain: true },
-        linesCount: { value: 0, isUncertain: true },
-        paragraphsCount: { value: 0, isUncertain: true },
-        pagesCount: { value: 0, isUncertain: true },
-    },
-});
-
 /**
  * Execution Tools for calling OpenAI API Assistants
  *
@@ -1763,8 +1767,9 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
      * @param options which are relevant are directly passed to the OpenAI client
      */
     function OpenAiAssistantExecutionTools(options) {
-        if (options === void 0) { options = {}; }
-        return _super.call(this, options) || this;
+        var _this = _super.call(this, options) || this;
+        _this.assistantId = options.assistantId;
+        return _this;
     }
     Object.defineProperty(OpenAiAssistantExecutionTools.prototype, "title", {
         get: function () {
@@ -1918,6 +1923,46 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
  * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
  */
 
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+var createOpenAiAssistantExecutionTools = Object.assign(function (options) {
+    // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
+    if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
+        options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
+    }
+    return new OpenAiAssistantExecutionTools(options);
+}, {
+    packageName: '@promptbook/openai',
+    className: 'OpenAiAssistantExecutionTools',
+});
+/**
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */
+
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+var createOpenAiExecutionTools = Object.assign(function (options) {
+    // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
+    if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
+        options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
+    }
+    return new OpenAiExecutionTools(options);
+}, {
+    packageName: '@promptbook/openai',
+    className: 'OpenAiExecutionTools',
+});
+/**
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */
+
 /**
  * @@@
  *
@@ -1986,9 +2031,18 @@ var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
  * @public exported from `@promptbook/cli`
  */
 var _OpenAiRegistration = $llmToolsRegister.register(createOpenAiExecutionTools);
+/**
+ * @@@ registration2
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/cli`
+ */
+var _OpenAiAssistantRegistration = $llmToolsRegister.register(createOpenAiAssistantExecutionTools);
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */
 
-export { OPENAI_MODELS, OpenAiAssistantExecutionTools, OpenAiExecutionTools, PROMPTBOOK_VERSION, _OpenAiRegistration, createOpenAiExecutionTools };
+export { OPENAI_MODELS, OpenAiAssistantExecutionTools, OpenAiExecutionTools, PROMPTBOOK_VERSION, _OpenAiAssistantRegistration, _OpenAiRegistration, createOpenAiAssistantExecutionTools, createOpenAiExecutionTools };
 //# sourceMappingURL=index.es.js.map