@promptbook/openai 0.69.0-7 → 0.69.0

package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts

@@ -13,7 +13,7 @@ export type CacheItem = {
     /**
      * @@@
      */
-    promptbookVersion: string_promptbook_version;
+    promptbookVersion?: string_promptbook_version;
     /**
      * @@@
      */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -16,7 +16,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
 }>;
 /**
  * Note: [🤖] Add models of new variant
- * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🎰] Some mechanism to auto-update available models

package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts

@@ -11,8 +11,8 @@ export declare const createAnthropicClaudeExecutionTools: ((options: AnthropicCl
     className: string;
 };
 /**
- * TODO: [🧠] !!!! Make anonymous this with all LLM providers
- * TODO: [🧠][🧱] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
+ * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
  * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
  * 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"

package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: !!! Playground with WebGPT / Promptbook.studio anonymous server
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!! Playground with WebGPT / Promptbook.studio anonymous server
+ * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
  */

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

@@ -1,5 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
  */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -9,7 +9,7 @@ import type { string_persona_description } from '../types/typeAliases';
  */
 export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
 /**
- * TODO: [🔃] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
  * TODO: [🏢] !! Check validity of `modelName` in pipeline
  * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
  * TODO: [🏢] !! Check validity of `temperature` in pipeline

package/esm/typings/src/prepare/isPipelinePrepared.d.ts

@@ -6,7 +6,7 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  */
 export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
 /**
- * TODO: [🔃] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`

package/esm/typings/src/prepare/prepareTemplates.d.ts

@@ -23,7 +23,7 @@ export {};
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: [♨] !!! Prepare index the samples and maybe templates
+ * TODO: [♨][main] !!! Prepare index the samples and maybe templates
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time

package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts

@@ -33,7 +33,7 @@ export type ParameterJson = {
     readonly sampleValues?: Array<string_parameter_value>;
 };
 /**
- * TODO: [🧠] !!!!!! Should be here registered subparameter from foreach or not?
+ * TODO: [🧠] Should be here registered subparameters from foreach or not?
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -42,7 +42,7 @@ export type PipelineJson = {
     /**
      * Version of the .ptbk.json file
      */
-    readonly promptbookVersion: string_semantic_version;
+    readonly promptbookVersion?: string_semantic_version;
     /**
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -39,6 +39,3 @@ export type ExecutionReportJson = {
      */
     readonly promptExecutions: Array<ExecutionPromptReportJson>;
 };
-/**
- * TODO: !!!!!! FOREACH in report
- */ 

package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyDeep } from 'type-fest';
 import type { ExecutionReportJson } from './ExecutionReportJson';
 import type { ExecutionReportString } from './ExecutionReportString';
 import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
@@ -6,7 +7,7 @@ import type { ExecutionReportStringOptions } from './ExecutionReportStringOption
  *
  * @public exported from `@promptbook/core`
  */
-export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
+export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
 /**
  * TODO: Add mermaid chart for every report
  * TODO: [🧠] Allow to filter out some parts of the report by options

package/esm/typings/src/types/typeAliases.d.ts

@@ -592,7 +592,7 @@ export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
 /**.
- * TODO: !!! Change "For example" to @example
+ * TODO: [main] !!! Change "For example" to @example
  * TODO: !! Change to branded types
  * TODO: Delete type aliases that are not exported or used internally
  */

package/esm/typings/src/utils/expectation-counters/index.d.ts

@@ -6,3 +6,6 @@ import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
  * @public exported from `@promptbook/utils`
  */
 export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;
+/**
+ * TODO: [🧠][🤠] This should be probbably as part of `TextFormatDefinition`
+ */

package/esm/typings/src/utils/organization/{f.d.ts → empty_object.d.ts}

@@ -1,6 +1,10 @@
 /**
  * Organizational helper to better mark the place where to really use empty object `{}`
  *
+ * Note: There are 2 similar types>
+ * - `empty_object` @@@
+ * - `just_empty_object` @@@
+ *
  * @private within the repository
  */
-export type really_empty_object = Record<string, never>;
+export type empty_object = {};

package/esm/typings/src/utils/organization/just_empty_object.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Organizational helper to better @@@@
+ *
+ * Note: There are 2 similar types>
+ * - `empty_object` @@@
+ * - `just_empty_object` @@@
+ *
+ * Note: In most cases, you should use `empty_object`
+ *
+ * @private within the repository
+ */
+export type just_empty_object = Record<string, never>;

package/esm/typings/src/utils/{extractParameterNames.d.ts → parameters/extractParameterNames.d.ts}

@@ -1,5 +1,5 @@
-import type { string_parameter_name } from '../types/typeAliases';
-import type { string_template } from '../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
 /**
  * Parses the template and returns the list of all parameter names
  *

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -0,0 +1,27 @@
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+type MakeapAvailableToExpectedParametersOptions = {
+    /**
+     * @@@
+     */
+    readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
+    /**
+     * @@@
+     */
+    readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
+};
+/**
+ * Maps available parameters to expected parameters
+ *
+ * The strategy is:
+ * 1) @@@
+ * 2) @@@
+ *
+ * @throws {PipelineExecutionError} @@@
+ * @private within the repository used in `createPipelineExecutor`
+ */
+export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;
+export {};

package/esm/typings/src/utils/{replaceParameters.d.ts → parameters/replaceParameters.d.ts}

@@ -1,5 +1,5 @@
-import type { Parameters } from '../types/typeAliases';
-import type { string_template } from '../types/typeAliases';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *

package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts

@@ -22,6 +22,6 @@ import type { string_name } from '../../types/typeAliases';
 export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
 /**
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */

package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts

@@ -19,6 +19,6 @@
  */
 export declare function isSerializableAsJson(value: unknown): boolean;
 /**
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */

package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -0,0 +1,10 @@
+import type { string_parameter_name } from '../../../types/typeAliases';
+/**
+ * Function `validateParameterName` will @@@
+ *
+ * @param parameterName @@@
+ * @returns @@@
+ * @throws {ParseError} @@@
+ * @private within the repository
+ */
+export declare function validateParameterName(parameterName: string): string_parameter_name;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.69.0-7",
+    "version": "0.69.0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -12,21 +12,25 @@
         "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
     ],
     "keywords": [
-        "autogpt",
-        "openai",
-        "gpt-3",
-        "gpt-4",
-        "chatgpt",
         "ai",
+        "llm",
+        "prompt",
+        "template",
+        "language-model",
+        "chatgpt",
+        "autogpt",
         "machine-learning",
         "natural-language-processing",
         "nlp",
-        "prompt",
-        "template",
-        "pipeline",
-        "automation",
-        "text-generation",
-        "language-model"
+        "openai",
+        "gpt-3",
+        "gpt-4",
+        "gpt-4o",
+        "gpt-4o-mini",
+        "o1",
+        "o1-mini",
+        "o1-preview",
+        "anthropic"
     ],
     "license": "CC-BY-4.0",
     "bugs": {
@@ -47,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.69.0-7"
+        "@promptbook/core": "0.69.0"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -14,8 +14,8 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.69.0-6';
-    // TODO: !!!! List here all the versions and annotate + put into script
+    var PROMPTBOOK_VERSION = '0.69.0-21';
+    // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -348,7 +348,7 @@
     }
     /**
      * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
-     * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+     * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
      * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
      */
 
@@ -413,6 +413,18 @@
      * @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
      */
@@ -1205,6 +1217,7 @@
                 prompt: computeUsage("$5.00 / 1M tokens"),
                 output: computeUsage("$15.00 / 1M tokens"),
             },
+            //TODO: [main] !!! Add gpt-4o-mini-2024-07-18 and all others to be up to date
         },
         /**/
         /**/
@@ -1219,6 +1232,51 @@
         },
         /**/
         /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'o1-preview',
+            modelName: 'o1-preview',
+            pricing: {
+                prompt: computeUsage("$15.00 / 1M tokens"),
+                output: computeUsage("$60.00 / 1M tokens"),
+            },
+        },
+        /**/
+        /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'o1-preview-2024-09-12',
+            modelName: 'o1-preview-2024-09-12',
+            //             <- TODO: [main] !!! Some better system to organize theese date suffixes and versions
+            pricing: {
+                prompt: computeUsage("$15.00 / 1M tokens"),
+                output: computeUsage("$60.00 / 1M tokens"),
+            },
+        },
+        /**/
+        /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'o1-mini',
+            modelName: 'o1-mini',
+            pricing: {
+                prompt: computeUsage("$3.00 / 1M tokens"),
+                output: computeUsage("$12.00 / 1M tokens"),
+            },
+        },
+        /**/
+        /**/
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'o1-mini-2024-09-12',
+            modelName: 'o1-mini-2024-09-12',
+            pricing: {
+                prompt: computeUsage("$3.00 / 1M tokens"),
+                output: computeUsage("$12.00 / 1M tokens"),
+            },
+        },
+        /**/
+        /**/
         {
             modelVariant: 'CHAT',
             modelTitle: 'gpt-3.5-turbo-16k-0613',
@@ -1425,7 +1483,7 @@
                             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');
                             }
@@ -1497,7 +1555,7 @@
                             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,
@@ -1557,7 +1615,9 @@
                             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,
@@ -1628,7 +1688,7 @@
      * @public exported from `@promptbook/openai`
      */
     var createOpenAiExecutionTools = Object.assign(function (options) {
-        // TODO: [🧠] !!!! If browser, auto add `dangerouslyAllowBrowser`
+        // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
         if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
             options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
         }