@promptbook/openai 0.61.0-11 → 0.61.0-13

package/umd/typings/src/llm-providers/_common/utils/count-total-cost/limitTotalCost.d.ts

@@ -0,0 +1,32 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../../execution/PromptResult';
+import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
+import type { TODO } from '../../../../utils/organization/TODO';
+import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+/**
+ * Options for `limitTotalCost`
+ */
+type LimitTotalCostOptions = {
+    /**
+     * @@@
+     *
+     * @default ZERO_USAGE
+     */
+    maxTotalCost: PromptResultUsage;
+    /**
+     * @@@
+     *
+     * @default MemoryStorage
+     */
+    storage: PromptbookStorage<TODO>;
+};
+/**
+ * @@@
+ */
+export declare function limitTotalCost(llmTools: LlmExecutionTools, options?: Partial<LimitTotalCostOptions>): LlmExecutionToolsWithTotalCost;
+export {};
+/**
+ * TODO: [🔼] !!! Export via `@promptbookcore/`
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ */

package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -45,4 +45,5 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

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

@@ -15,7 +15,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: [🧠] !!! 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: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing

package/umd/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -44,4 +44,5 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
 /**
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom AzureOpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

package/umd/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts

@@ -10,3 +10,6 @@ export declare class LangtailExecutionTools extends OpenAiExecutionTools impleme
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
 }
+/**
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ */ 

package/umd/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts

@@ -7,5 +7,5 @@ import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionTools
  */
 export type LangtailExecutionToolsOptions = OpenAiExecutionToolsOptions;
 /**
- * TODO: !!! Use or remove
+ * TODO: !! Use or remove
  */

package/umd/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -29,6 +29,6 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: !!! Use here `seed`
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

package/umd/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -34,5 +34,5 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: !!! Use here `seed`
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

package/umd/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -62,4 +62,5 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
  * 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
  */

package/umd/typings/src/llm-providers/openai/computeUsage.d.ts

@@ -4,13 +4,13 @@
  * @see https://openai.com/api/pricing/
  * @see https://docs.anthropic.com/en/docs/models-overview
  *
- * @private within the package, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
  */
 type string_model_price = `$${number}.${number} / ${number}M tokens`;
 /**
  * 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`
  */
 export declare function computeUsage(value: string_model_price): number;
 export {};

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

@@ -5,6 +5,11 @@ import type { string_persona_description } from '../types/typeAliases';
  * Prepares the persona for the pipeline
  *
  * @see https://github.com/webgptorg/promptbook/discussions/22
- * @private within the package
  */
 export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: [🏢] !! Check validity of `modelName` in pipeline
+ * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] !! Check validity of `temperature` in pipeline
+ */

package/umd/typings/src/prepare/preparePipeline.d.ts

@@ -8,9 +8,10 @@ import type { PrepareOptions } from './PrepareOptions';
  */
 export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
  * 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
- * TODO: !!!!! Use here countTotalUsage
+ * TODO: [🎐] !!!! Use here countTotalUsage
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/umd/typings/src/prepare/unpreparePipeline.d.ts

@@ -4,5 +4,6 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  */
 export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: Write tests for `preparePipeline`
  */

package/umd/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -20,5 +20,6 @@ export type PromptbookStorage<TItem> = {
     removeItem(key: string): Promisable<void>;
 };
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/types`
  * TODO: [🧠][🛫] Constrain `TItem` to JSON-serializable objects only
  */

package/umd/typings/src/storage/_common/PromptbookStorage.test-type.d.ts

@@ -1,5 +1,5 @@
 export {};
 /**
- * TODO: !!!!! Check that this files is not exported into build
+ * Note: [⚪] This should never be in any released package
  * TODO: Is this a good pattern to do type testing?
  */

package/umd/typings/src/storage/files-storage/FilesStorage.d.ts

@@ -24,5 +24,7 @@ export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
     removeItem(key: string): Promise<void>;
 }
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/node`
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
  */

package/umd/typings/src/storage/files-storage/FilesStorageOptions.d.ts

@@ -8,3 +8,6 @@ export type FilesStorageOptions = {
      */
     cacheFolderPath: string_folder_path;
 };
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/types`
+ */

package/umd/typings/src/storage/local-storage/getLocalStorage.d.ts

@@ -4,5 +4,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
 /**
- * Export through `@promptbook/browser`
+ * TODO: [🔼] !!! Export via `@promptbook/browser`
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
  */

package/umd/typings/src/storage/local-storage/getSessionStorage.d.ts

@@ -4,5 +4,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
 /**
- * Export through `@promptbook/browser`
+ * TODO: [🔼] !!! Export via `@promptbook/browser`
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
  */

package/umd/typings/src/storage/memory/MemoryStorage.d.ts

@@ -29,3 +29,6 @@ export declare class MemoryStorage<TItem> implements PromptbookStorage<TItem> {
      */
     removeItem(key: string): void;
 }
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ */

package/umd/typings/src/storage/utils/PrefixStorage.d.ts

@@ -21,3 +21,6 @@ export declare class PrefixStorage<TItem> implements PromptbookStorage<TItem> {
      */
     removeItem(key: string): void;
 }
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ */

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

@@ -6,7 +6,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function makePromptbookStorageFromWebStorage<TValue>(webStorage: Storage): PromptbookStorage<TValue>;
 /**
- * TODO: !!!! Export through `@promptbook/browser`
  * TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
  */

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

@@ -54,7 +54,7 @@ export type ModelRequirements = {
     readonly maxTokens?: number;
 };
 /**
- * TODO: [🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
+ * 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

package/umd/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 = {
     /**

package/umd/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/umd/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/umd/typings/src/utils/deepClone.d.ts

@@ -0,0 +1,9 @@
+import type { WritableDeep } from 'type-fest';
+/**
+ * @@@
+ */
+export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;
+/**
+ * TODO: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

package/umd/typings/src/utils/deepFreeze.d.ts

@@ -0,0 +1,13 @@
+import type { ReadonlyDeep } from 'type-fest';
+/**
+ * @@@
+ *
+ * @returns The same object as the input, but deeply frozen
+ *
+ * Note: This function mutates the object
+ */
+export declare function deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+/**
+ * TODO: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

package/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/typings/src/utils/organization/just.d.ts

@@ -2,9 +2,13 @@
  * Returns the same value that is passed as argument.
  * No side effects.
  *
- * Note: It can be usefull for leveling indentation
+ * Note: It can be usefull for:
+ *
+ * 1) Leveling indentation
+ * 2) Putting always-true or always-false conditions without getting eslint errors
  *
  * @param value any values
  * @returns the same values
+ * @private within the repository
  */
 export declare function just<T>(value?: T): T;

package/umd/typings/src/utils/organization/keepUnused.d.ts

@@ -0,0 +1,16 @@
+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 for:
+ *
+ * 1) Suppressing eager optimization of unused imports
+ * 2) Suppressing eslint errors of unused variables in the tests
+ * 3) Keeping the type of the variable for type testing
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;

package/umd/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/execution/addPromptResultUsage.test.d.ts

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

package/esm/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -1,10 +0,0 @@
-import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-/**
- * Returns LLM tools for testing purposes
- *
- * @private within the package - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
- */
-export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
-/**
- * Note: [⚪]
- */ 

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

@@ -1,11 +0,0 @@
-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
- */
-export declare function notUsing(...value: Array<really_any>): void;

package/umd/typings/src/execution/addPromptResultUsage.test.d.ts

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

package/umd/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -1,10 +0,0 @@
-import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-/**
- * Returns LLM tools for testing purposes
- *
- * @private within the package - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
- */
-export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
-/**
- * Note: [⚪]
- */ 

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

@@ -1,11 +0,0 @@
-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
- */
-export declare function notUsing(...value: Array<really_any>): void;