@promptbook/openai 0.61.0-12 → 0.61.0-14

package/umd/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -1,9 +1,11 @@
 import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { PromptChatResult } from '../../execution/PromptResult';
-import type { PromptCompletionResult } from '../../execution/PromptResult';
-import type { PromptEmbeddingResult } from '../../execution/PromptResult';
-import type { Prompt } from '../../types/Prompt';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt } from '../../types/Prompt';
+import type { CompletionPrompt } from '../../types/Prompt';
+import type { EmbeddingPrompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
@@ -28,15 +30,15 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     /**
      * Calls remote proxy server to use a chat model
      */
-    callChatModel(prompt: Prompt): Promise<PromptChatResult>;
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
     /**
      * Calls remote proxy server to use a completion model
      */
-    callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
     /**
      * Calls remote proxy server to use a embedding model
      */
-    callEmbeddingModel(prompt: Prompt): Promise<PromptEmbeddingResult>;
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
     /**
      * Calls remote proxy server to use both completion or chat model
      */

package/umd/typings/src/scripting/javascript/utils/unknownToString.d.ts

@@ -1,7 +1,8 @@
+import type { really_unknown } from '../../../utils/organization/really_unknown';
 /**
  * Converts anything to string that can be used for debugging and logging
  *
  * @param value String value for logging
  * @private Internal util
  */
-export declare function unknownToString(value: unknown): string;
+export declare function unknownToString(value: really_unknown): string;

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

@@ -1,28 +1,67 @@
+import type { ModelVariant } from './ModelVariant';
 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
+ * Abstract way to specify the LLM.
+ * It does not specify the LLM with concrete version itself, only the requirements for the LLM.
  *
- * There are two variants:
- * - **COMPLETION** - model that takes prompt and writes the rest of the text
- * - **CHAT** - model that takes prompt and previous messages and returns response
+ * Note: This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook#model-requirements
  */
-export type ModelVariant = typeof MODEL_VARIANTS[number];
+export type ModelRequirements = CompletionModelRequirements | ChatModelRequirements | EmbeddingModelRequirements;
 /**
- * Abstract way to specify the LLM. It does not specify the LLM with concrete version itself, only the requirements for the LLM.
+ * Model requirements for the completion variant
  *
- * @see https://github.com/webgptorg/promptbook#model-requirements
+ * Note: This is fully serializable as JSON
+ */
+export type CompletionModelRequirements = CommonModelRequirements & {
+    /**
+     * Completion model variant
+     */
+    modelVariant: 'COMPLETION';
+};
+/**
+ * Model requirements for the chat variant
+ *
+ * Note: This is fully serializable as JSON
  */
-export type ModelRequirements = {
+export type ChatModelRequirements = CommonModelRequirements & {
+    /**
+     * Chat model variant
+     */
+    modelVariant: 'CHAT';
+    /**
+     * System message to be used in the model
+     */
+    readonly systemMessage?: string_system_message;
+};
+/**
+ * Model requirements for the embedding variant
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type EmbeddingModelRequirements = CommonModelRequirements & {
+    /**
+     * Embedding model variant
+     */
+    modelVariant: 'EMBEDDING';
+};
+/**
+ * Common properties for all model requirements variants
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type CommonModelRequirements = {
     /**
      * Model variant describes the very general type of the model
      *
-     * There are two variants:
+     * There are 3 variants:
      * - **COMPLETION** - model that takes prompt and writes the rest of the text
      * - **CHAT** - model that takes prompt and previous messages and returns response
+     * - **EMBEDDING** - model that takes prompt and returns embedding
+     * <- [🤖]
      */
     readonly modelVariant: ModelVariant;
     /**
@@ -34,10 +73,6 @@ 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
      *
@@ -50,10 +85,13 @@ export type ModelRequirements = {
     readonly seed?: number_seed;
     /**
      * Maximum number of tokens that can be generated by the model
+     *
+     * Note: [🌾]
      */
     readonly maxTokens?: number;
 };
 /**
+ * TODO: [🔼] !!!! Export all from `@promptbook/types`
  * 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`)
@@ -61,4 +99,5 @@ export type ModelRequirements = {
  * 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
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
  */

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

@@ -0,0 +1,14 @@
+/**
+ * @@@
+ *
+ * @private for `ModelVariant` and `modelCommandParser`
+ */
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
+/**
+ * Model variant describes the very general type of the model
+ *
+ * There are two variants:
+ * - **COMPLETION** - model that takes prompt and writes the rest of the text
+ * - **CHAT** - model that takes prompt and previous messages and returns response
+ */
+export type ModelVariant = typeof MODEL_VARIANTS[number];

package/umd/typings/src/types/PipelineJson/PersonaJson.d.ts

@@ -1,4 +1,4 @@
-import type { ModelRequirements } from '../ModelRequirements';
+import type { ChatModelRequirements } from '../ModelRequirements';
 import type { number_id } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 import type { string_persona_description } from '../typeAliases';
@@ -30,9 +30,7 @@ export type PersonaPreparedJson = PersonaJson & {
      *
      * Note: The model must be CHAT variant to be usable through persona
      */
-    readonly modelRequirements: ModelRequirements & {
-        readonly modelVariant: 'CHAT';
-    };
+    readonly modelRequirements: ChatModelRequirements;
     /**
      * List of preparation ids that were used to prepare this persona
      */

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

@@ -1,4 +1,4 @@
-import type { PromptResultUsage } from '../../execution/PromptResult';
+import type { PromptResultUsage } from '../../execution/PromptResultUsage';
 import type { string_promptbook_version } from '../../version';
 import type { number_id } from '../typeAliases';
 export type PreparationJson = {

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

@@ -1,5 +1,8 @@
 import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { ChatModelRequirements } from './ModelRequirements';
+import type { CompletionModelRequirements } from './ModelRequirements';
+import type { EmbeddingModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
 import type { string_parameter_name } from './typeAliases';
@@ -13,7 +16,46 @@ import type { string_title } from './typeAliases';
  * 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 = {
+export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
+/**
+ * Completion prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type CompletionPrompt = CommonPrompt & {
+    /**
+     * Requirements for completion model
+     */
+    modelRequirements: CompletionModelRequirements;
+};
+/**
+ * Chat prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type ChatPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: ChatModelRequirements;
+};
+/**
+ * Embedding prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type EmbeddingPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: EmbeddingModelRequirements;
+};
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type CommonPrompt = {
     /**
      * The title of the prompt
      *
@@ -63,6 +105,8 @@ export type Prompt = {
     readonly parameters: Record<string_parameter_name, string_parameter_value>;
 };
 /**
+ * TODO: [🔼] !!!! Export all from `@promptbook/types`
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
  * TODO: [✔] Check ModelRequirements in runtime
  * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
  */

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

@@ -196,6 +196,17 @@ export type string_script = string;
  * For example `console.info("Hello World!")`
  */
 export type string_javascript = string;
+/**
+ * Semantic helper for JSON strings
+ *
+ * Note: TType is a type of the JSON object inside the string
+ *
+ * For example `{"foo": "bar"}`
+ */
+export type string_json<TType> = string & {
+    _type: 'string_json';
+    scheme: TType;
+};
 /**
  * Semantic helper
  *

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/normalization/parseKeywords.d.ts

@@ -1,3 +1,4 @@
+import type { really_unknown } from '../organization/really_unknown';
 import type { IKeywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
@@ -7,7 +8,7 @@ import type { IKeywords } from './IKeywords';
  * @param input of any kind
  * @returns {Set} of keywords without diacritics in lowercase
  */
-export declare function parseKeywords(input: unknown): IKeywords;
+export declare function parseKeywords(input: really_unknown): IKeywords;
 /**
  * Note: Not using spread in input param because of keeping second parameter for options
  * TODO: [🌺] Use some intermediate util splitWords

package/{esm/typings/src/utils/organization/TODO.d.ts → umd/typings/src/utils/organization/TODO_any.d.ts}

@@ -3,4 +3,4 @@
  *
  * @private within the repository
  */
-export type TODO = any;
+export type TODO_any = any;

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

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

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

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

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

@@ -2,7 +2,10 @@
  * 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

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,5 +1,5 @@
 /**
- * Organizational helper to mark a place where to really use any
+ * Organizational helper to mark a place where to really use `any`
  *
  * @private within the repository
  */

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

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to mark a place where to really use `unknown`
+ *
+ * @private within the repository
+ */
+export type really_unknown = unknown;

package/umd/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -1,5 +1,6 @@
 import type { string_email } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid email
  */
-export declare function isValidEmail(email: unknown): email is string_email;
+export declare function isValidEmail(email: really_unknown): email is string_email;

package/umd/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -1,7 +1,8 @@
 import type { string_file_path } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
  * Note: This does not check if the file exists only if the path is valid
  */
-export declare function isValidFilePath(filePath: unknown): filePath is string_file_path;
+export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;

package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -1,2 +1,3 @@
 import type { string_javascript_name } from '../../../types/typeAliases';
-export declare function isValidJavascriptName(javascriptName: unknown): javascriptName is string_javascript_name;
+import type { really_unknown } from '../../organization/really_unknown';
+export declare function isValidJavascriptName(javascriptName: really_unknown): javascriptName is string_javascript_name;

package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -1,4 +1,5 @@
 import type { string_promptbook_version } from '../../../version';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid promptbook version
  * It looks into list of known promptbook versions.
@@ -9,4 +10,4 @@ import type { string_promptbook_version } from '../../../version';
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  */
-export declare function isValidPromptbookVersion(version: unknown): version is string_promptbook_version;
+export declare function isValidPromptbookVersion(version: really_unknown): version is string_promptbook_version;

package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts

@@ -1,4 +1,5 @@
 import type { string_semantic_version } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid semantic version
  *
@@ -6,4 +7,4 @@ import type { string_semantic_version } from '../../../types/typeAliases';
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  */
-export declare function isValidSemanticVersion(version: unknown): version is string_semantic_version;
+export declare function isValidSemanticVersion(version: really_unknown): version is string_semantic_version;

package/umd/typings/src/utils/validators/url/isValidPipelineUrl.d.ts

@@ -1,4 +1,5 @@
 import type { string_pipeline_url } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid pipeline URL URL.
  *
@@ -6,7 +7,7 @@ import type { string_pipeline_url } from '../../../types/typeAliases';
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
  */
-export declare function isValidPipelineUrl(url: unknown): url is string_pipeline_url;
+export declare function isValidPipelineUrl(url: really_unknown): url is string_pipeline_url;
 /**
  * TODO: [🐠] Maybe more info why the URL is invalid
  */

package/umd/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -1,4 +1,5 @@
 import type { string_url } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
@@ -7,4 +8,4 @@ import type { string_url } from '../../../types/typeAliases';
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
  */
-export declare function isValidUrl(url: unknown): url is string_url;
+export declare function isValidUrl(url: really_unknown): url is string_url;

package/umd/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -1,5 +1,6 @@
 import type { string_uuid } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid uuid
  */
-export declare function isValidUuid(value: unknown): value is string_uuid;
+export declare function isValidUuid(value: really_unknown): value is string_uuid;

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

@@ -4,6 +4,3 @@ 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/esm/typings/src/utils/organization/keepImported.d.ts

@@ -1,12 +0,0 @@
-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

@@ -1,12 +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
- * @private within the repository
- */
-export declare function notUsing(...value: Array<really_any>): void;

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

@@ -1,12 +0,0 @@
-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/umd/typings/src/utils/organization/notUsing.d.ts

@@ -1,12 +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
- * @private within the repository
- */
-export declare function notUsing(...value: Array<really_any>): void;