@promptbook/openai 0.61.0-10 → 0.61.0-12

package/esm/typings/src/storage/utils/makePromptbookStorageFromWebStorage.d.ts

@@ -0,0 +1,11 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * @@@
+ *
+ * @private for `getLocalStorage` and `getSessionStorage`
+ */
+export declare function makePromptbookStorageFromWebStorage<TValue>(webStorage: Storage): PromptbookStorage<TValue>;
+/**
+ * TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
+ * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
+ */

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

@@ -1,4 +1,7 @@
+import type { number_model_temperature } from './typeAliases';
+import type { number_seed } from './typeAliases';
 import type { string_model_name } from './typeAliases';
+import type { string_system_message } from './typeAliases';
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
 /**
  * Model variant describes the very general type of the model
@@ -31,13 +34,30 @@ export type ModelRequirements = {
      * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
      */
     readonly modelName?: string_model_name;
+    /**
+     * System message to be used in the model
+     */
+    readonly systemMessage?: string_system_message;
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Seed for the model
+     */
+    readonly seed?: number_seed;
     /**
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
 };
 /**
- * TODO: !!!!! Add and use systemMessage, temprerature, top_k, top_p, presencePenalty, frequencyPenalty, bestOf, n, logitBias, logitBiasType, stop, ... to ModelRequirements
+ * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
+ * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
+ *       [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  * TODO: Maybe figure out better word than "variant"
  * TODO: Add here more requirement options like max context size, max tokens, etc.
  * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model

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

@@ -10,6 +10,5 @@
  */
 export type Parameters = object;
 /**
- * TODO: !!!!! Implement samples into parameters
  * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
  */

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

@@ -14,7 +14,7 @@ import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson'
  * Promptbook is the **core concept of this package**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
- * @see !!! https://github.com/webgptorg/promptbook#promptbook
+ * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */
 export type PipelineJson = {
     /**
@@ -79,7 +79,6 @@ export type PipelineJson = {
     readonly preparations: Array<PreparationJson>;
 };
 /**
- * TODO: !!!!! Implement new commands
  * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
  *       But then immediately reverted back to the single type
  *       With knowledge as part of the promptbook and collection just as a collection of promptbooks

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

@@ -1,16 +1,11 @@
 import type { PromptResultUsage } from '../../execution/PromptResult';
 import type { string_promptbook_version } from '../../version';
 import type { number_id } from '../typeAliases';
-import type { string_date_iso8601 } from '../typeAliases';
 export type PreparationJson = {
     /**
      * Incremental ID of the preparation
      */
     readonly id: number_id;
-    /**
-     * Date and time of the preparation
-     */
-    readonly date: string_date_iso8601;
     /**
      * Version of the promptbook used for the preparation
      */
@@ -22,4 +17,5 @@ export type PreparationJson = {
 };
 /**
  * TODO: Maybe put here used `modelName`
+ * TODO: [🍥] When using `date` it changes all samples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
  */

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

@@ -80,4 +80,5 @@ export interface PromptTemplateJsonCommon {
 }
 /**
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ * TODO: [♈] Probbably move expectations from templates to parameters
  */

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

@@ -1,5 +1,6 @@
 import type { string_markdown_text } from '../typeAliases';
-import type { string_name } from '../typeAliases';
+import type { string_parameter_name } from '../typeAliases';
+import type { string_parameter_value } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
  */
@@ -9,7 +10,7 @@ export type PromptTemplateParameterJson = {
      * - It must be unique across the pipeline
      * - It should start lowercase and contain letters and numbers
      */
-    readonly name: string_name;
+    readonly name: string_parameter_name;
     /**
      * The parameter is input of the pipeline
      */
@@ -23,4 +24,12 @@ export type PromptTemplateParameterJson = {
      * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly description?: string_markdown_text;
+    /**
+     * Sample values of the parameter
+     * Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
+     */
+    readonly sampleValues?: Array<string_parameter_value>;
 };
+/**
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ */

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

@@ -2,7 +2,7 @@
  * Promptbook is the **core concept of this package**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
- * @see !!! https://github.com/webgptorg/promptbook#promptbook
+ * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */
 export type PipelineString = string & {
     readonly _type: 'Promptbook';

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

@@ -2,13 +2,15 @@ import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
-import type { string_name } from './typeAliases';
+import type { string_parameter_name } from './typeAliases';
+import type { string_parameter_value } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_prompt } from './typeAliases';
 import type { string_title } from './typeAliases';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
  * @see https://github.com/webgptorg/promptbook#prompt
  */
 export type Prompt = {
@@ -58,8 +60,9 @@ export type Prompt = {
      *
      * Note: This is redundant (same information is in pipelineUrl+content) but useful for logging and debugging
      */
-    readonly parameters: Record<string_name, string>;
+    readonly parameters: Record<string_parameter_name, string_parameter_value>;
 };
 /**
  * TODO: [✔] Check ModelRequirements in runtime
+ * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
  */

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

@@ -2,6 +2,6 @@ import type { FromtoItems } from '../../utils/FromtoItems';
 /**
  * Count the duration of working time
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function countWorkingDuration(items: FromtoItems): number;

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

@@ -32,6 +32,12 @@ export type string_text_prompt = string_prompt;
  * For example `"How many hats does the cat wear?"`
  */
 export type string_chat_prompt = string_text_prompt;
+/**
+ * Semantic helper
+ *
+ * For example `"You are an AI assistant. You are here to help me with my work."`
+ */
+export type string_system_message = string_text_prompt;
 /**
  * Semantic helper
  *
@@ -73,6 +79,20 @@ export type string_char = string;
  * For example `"ainautes"`
  */
 export type string_name = string;
+/**
+ * Semantic helper
+ * Unique identifier of anything
+ *
+ * For example `"eventName"`
+ */
+export type string_parameter_name = string;
+/**
+ * Semantic helper
+ * Unique identifier of anything
+ *
+ * For example `"DevConf 2024"`
+ */
+export type string_parameter_value = string;
 /**
  * Semantic helper
  * Title of anything
@@ -462,9 +482,22 @@ export type number_negative = number;
 export type number_integer = number;
 /**
  * Semantic helper;
- * Percentage from 0 to 1 (100%)
+ * Percentage from 0 to 1 (100%) (and bellow and above)
  */
 export type number_percent = number;
+/**
+ * Semantic helper;
+ * Model temperature
+ */
+export type number_model_temperature = number_percent;
+/**
+ * Semantic helper;
+ * Seed for random generator
+ *
+ * Percentage from 0 to 1 (100%)
+ * TODO: Is seed (in OpenAI) number from 0 to 1?
+ */
+export type number_seed = number_percent;
 /**
  * Likeness of the wallpaper
  *
@@ -491,4 +524,5 @@ export type number_terabytes = number_positive;
  * TODO: !!! Change "For example" to @example
  * TODO: !! Cleanup
  * TODO: !! Change to branded types
+ * TODO: [📂] Export all this file through `@promptbook/types`
  */

package/esm/typings/src/utils/emojis.d.ts

@@ -5,7 +5,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
  *
  * @see https://getemoji.com/
  *
- * @private within the package
+ * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
@@ -13,7 +13,7 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...
  *
- * @private within the package
+ * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS: Set<string_char_emoji>;

package/esm/typings/src/utils/formatNumber.d.ts

@@ -1,6 +1,6 @@
 /**
  * Format either small or big number
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function formatNumber(value: number): string;

package/esm/typings/src/utils/isRunningInWhatever.d.ts

@@ -10,3 +10,6 @@ export declare const isRunningInNode: Function;
  * Detects if the code is running in a web worker
  */
 export declare const isRunningInWebWorker: Function;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/utils`
+ */

package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts

@@ -3,7 +3,7 @@ import type { string_name } from '../../types/typeAliases';
 /**
  * Add or modify an auto-generated section in a markdown file
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function addAutoGeneratedSection(content: string_markdown, options: {
     readonly sectionName: string_name;

package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -28,7 +28,7 @@ type CreateMarkdownChartOptions = {
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};

package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts

@@ -3,6 +3,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Create a markdown table from a 2D array of strings
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -3,6 +3,10 @@ import type { string_markdown } from '../../types/typeAliases';
  * Single code block inside markdown.
  */
 export type CodeBlock = {
+    /**
+     * Which notation was used to open the code block
+     */
+    readonly blockNotation: '```' | '>';
     /**
      * Language of the code block OR null if the language is not specified in opening ```
      */
@@ -25,3 +29,6 @@ export type CodeBlock = {
  *
  */
 export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
+/**
+ * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
+ */

package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -15,5 +15,5 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
- * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
  */

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

@@ -1,4 +1,6 @@
 /**
  * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
  */
 export type TODO = any;

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

@@ -7,5 +7,6 @@ import type { really_any } from './really_any';
  *
  * @param value any values
  * @returns void
+ * @private within the repository
  */
 export declare function TODO_USE(...value: Array<really_any>): void;

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

@@ -1,4 +1,6 @@
 /**
  * Formatting helper to put void to keep longer version of prettier
+ *
+ * @private within the repository
  */
 export type ___ = never;

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

@@ -6,5 +6,6 @@
  *
  * @param value any values
  * @returns the same values
+ * @private within the repository
  */
 export declare function just<T>(value?: T): T;

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

@@ -0,0 +1,12 @@
+import type { really_any } from './really_any';
+/**
+ * Just says that the variable is not used but should be kept
+ * No side effects.
+ *
+ * Note: It can be usefull suppressing eager optimization of unused imports
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function keepImported(...value: Array<really_any>): void;

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

@@ -0,0 +1,12 @@
+import type { really_any } from './really_any';
+/**
+ * Just says that the variable is not used
+ * No side effects.
+ *
+ * Note: It can be usefull suppressing eslint errors of unused variables in the tests
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function notUsing(...value: Array<really_any>): void;

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

@@ -1,4 +1,6 @@
 /**
  * Organizational helper to mark a place where to really use any
+ *
+ * @private within the repository
  */
 export type really_any = any;

package/esm/typings/src/utils/random/randomSeed.d.ts

@@ -0,0 +1,7 @@
+import type { number_seed } from '../../types/typeAliases';
+/**
+ * Generates random seed
+ *
+ * Warning: This function is not cryptographically secure (it uses Math.random internally)
+ */
+export declare function $randomSeed(): number_seed;

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

@@ -4,3 +4,6 @@ import type { string_semantic_version } from './types/typeAliases';
  */
 export declare const PROMPTBOOK_VERSION: string_promptbook_version;
 export type string_promptbook_version = string_semantic_version;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/code`
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.61.0-10",
+    "version": "0.61.0-12",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -49,7 +49,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.61.0-10"
+        "@promptbook/core": "0.61.0-12"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -110,7 +110,7 @@
     /**
      * Function computeUsage will create price per one token based on the string value found on openai page
      *
-     * @private within the package, used only as internal helper for `OPENAI_MODELS`
+     * @private within the repository, used only as internal helper for `OPENAI_MODELS`
      */
     function computeUsage(value) {
         var _a = __read(value.split(' / '), 2), price = _a[0], tokens = _a[1];
@@ -464,6 +464,7 @@
      * @see /other/playground/playground.ts
      * TODO: [🍓] Make better
      * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+     * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
      */
 
     /**
@@ -939,6 +940,7 @@
                                 model: model,
                                 max_tokens: modelRequirements.maxTokens,
                                 //                                   <- TODO: Make some global max cap for maxTokens
+                                // <- TODO: !!!!! Use here `systemMessage`, `temperature` and `seed`
                             };
                             if (expectFormat === 'JSON') {
                                 modelSettings.response_format = {
@@ -1012,6 +1014,7 @@
                                 model: model,
                                 max_tokens: modelRequirements.maxTokens || 2000, // <- Note: 2000 is for lagacy reasons
                                 //                                                  <- TODO: Make some global max cap for maxTokens
+                                // <- TODO: !!!!! Use here `systemMessage`, `temperature` and `seed`
                             };
                             rawRequest = __assign(__assign({}, modelSettings), { prompt: content, user: this.options.user });
                             start = getCurrentIsoDate();
@@ -1162,13 +1165,17 @@
      * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
      * TODO: Maybe Create some common util for callChatModel and callCompletionModel
      * TODO: Maybe make custom OpenaiError
+     * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
      */
 
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.61.0-9';
+    var PROMPTBOOK_VERSION = '0.61.0-11';
     // TODO: !!!! List here all the versions and annotate + put into script
+    /**
+     * TODO: [🔼] !!! Export via `@promptbook/code`
+     */
 
     exports.OPENAI_MODELS = OPENAI_MODELS;
     exports.OpenAiExecutionTools = OpenAiExecutionTools;