@promptbook/utils 0.41.0 → 0.41.2

package/esm/typings/types/Command.d.ts

@@ -1,98 +1,98 @@
-import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
-import type { ExecutionType } from './ExecutionTypes';
-import type { ModelRequirements } from './ModelRequirements';
-import type { ExpectationAmount, ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
-/**
- * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
- * It is parsed from the markdown from ul/ol items - one command per one item.
- */
-export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
-/**
- * PromptbookVersion command tells which version is .promptbook file using
- *
- * - It is used for backward compatibility
- * - It is defined per whole .promptbook file in the header
- */
-export type PromptbookUrlCommand = {
-    readonly type: 'PROMPTBOOK_URL';
-    readonly promptbookUrl: URL;
-};
-/**
- * PromptbookVersion command tells which version is .promptbook file using
- *
- * - It is used for backward compatibility
- * - It is defined per whole .promptbook file in the header
- */
-export type PromptbookVersionCommand = {
-    readonly type: 'PROMPTBOOK_VERSION';
-    readonly promptbookVersion: string_version;
-};
-/**
- * Execute command tells how to execute the section
- * It can be either prompt template, script or SIMPLE TEMPLATE etc.
- */
-export type ExecuteCommand = {
-    readonly type: 'EXECUTE';
-    readonly executionType: ExecutionType;
-};
-/**
- * Model command tells which model and modelRequirements to use for the prompt template. execution
- */
-export type ModelCommand = {
-    readonly type: 'MODEL';
-    readonly key: keyof ModelRequirements;
-    readonly value: any;
-};
-/**
- * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
- */
-export type JokerCommand = {
-    readonly type: 'JOKER';
-    readonly parameterName: string_name;
-};
-/**
- * Parameter command describes one parameter of the prompt template
- *
- * - It can tell if it is input or OUTPUT PARAMETER
- * - It can have description
- * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
- */
-export type ParameterCommand = {
-    readonly type: 'PARAMETER';
-    readonly isInput: boolean;
-    readonly isOutput: boolean;
-    readonly parameterName: string_name;
-    readonly parameterDescription: string_markdown_text | null;
-};
-/**
- * Postprocess command describes which function to use for postprocessing
- * This will be created as separate EXECUTE SCRIPT block bellow
- */
-export type PostprocessCommand = {
-    readonly type: 'POSTPROCESS';
-    readonly functionName: string_name;
-};
-/**
- * Expect command describes the desired output of the prompt template (after post-processing)
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
- */
-export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
-/**
- * Expect amount command describes the desired output of the prompt template (after post-processing)
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
- *
- * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
- */
-export type ExpectAmountCommand = {
-    readonly type: 'EXPECT_AMOUNT';
-    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
-    readonly unit: ExpectationUnit;
-    readonly amount: ExpectationAmount;
-};
-/**
- * Represents a command that expects a specific format.
- */
-export type ExpectFormatCommand = {
-    readonly type: 'EXPECT_FORMAT';
-    readonly format: 'JSON';
-};
+import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
+import type { ExecutionType } from './ExecutionTypes';
+import type { ModelRequirements } from './ModelRequirements';
+import type { ExpectationAmount, ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
+/**
+ * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ */
+export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+/**
+ * PromptbookVersion command tells which version is .promptbook file using
+ *
+ * - It is used for backward compatibility
+ * - It is defined per whole .promptbook file in the header
+ */
+export type PromptbookUrlCommand = {
+    readonly type: 'PROMPTBOOK_URL';
+    readonly promptbookUrl: URL;
+};
+/**
+ * PromptbookVersion command tells which version is .promptbook file using
+ *
+ * - It is used for backward compatibility
+ * - It is defined per whole .promptbook file in the header
+ */
+export type PromptbookVersionCommand = {
+    readonly type: 'PROMPTBOOK_VERSION';
+    readonly promptbookVersion: string_version;
+};
+/**
+ * Execute command tells how to execute the section
+ * It can be either prompt template, script or SIMPLE TEMPLATE etc.
+ */
+export type ExecuteCommand = {
+    readonly type: 'EXECUTE';
+    readonly executionType: ExecutionType;
+};
+/**
+ * Model command tells which model and modelRequirements to use for the prompt template. execution
+ */
+export type ModelCommand = {
+    readonly type: 'MODEL';
+    readonly key: keyof ModelRequirements;
+    readonly value: any;
+};
+/**
+ * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
+ */
+export type JokerCommand = {
+    readonly type: 'JOKER';
+    readonly parameterName: string_name;
+};
+/**
+ * Parameter command describes one parameter of the prompt template
+ *
+ * - It can tell if it is input or OUTPUT PARAMETER
+ * - It can have description
+ * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
+ */
+export type ParameterCommand = {
+    readonly type: 'PARAMETER';
+    readonly isInput: boolean;
+    readonly isOutput: boolean;
+    readonly parameterName: string_name;
+    readonly parameterDescription: string_markdown_text | null;
+};
+/**
+ * Postprocess command describes which function to use for postprocessing
+ * This will be created as separate EXECUTE SCRIPT block bellow
+ */
+export type PostprocessCommand = {
+    readonly type: 'POSTPROCESS';
+    readonly functionName: string_name;
+};
+/**
+ * Expect command describes the desired output of the prompt template (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
+ */
+export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
+/**
+ * Expect amount command describes the desired output of the prompt template (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
+ *
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
+ */
+export type ExpectAmountCommand = {
+    readonly type: 'EXPECT_AMOUNT';
+    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
+    readonly unit: ExpectationUnit;
+    readonly amount: ExpectationAmount;
+};
+/**
+ * Represents a command that expects a specific format.
+ */
+export type ExpectFormatCommand = {
+    readonly type: 'EXPECT_FORMAT';
+    readonly format: 'JSON';
+};

package/esm/typings/types/ExecutionTypes.d.ts

@@ -1,13 +1,13 @@
-import { TupleToUnion } from 'type-fest';
-/**
- * Execution type describes the way how the block is executed
- *
- * @see https://github.com/webgptorg/promptbook#execution-type
- */
-export type ExecutionType = TupleToUnion<typeof ExecutionTypes>;
-/**
- * Execution type describes the way how the block is executed
- *
- * @see https://github.com/webgptorg/promptbook#execution-type
- */
-export declare const ExecutionTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG"];
+import { TupleToUnion } from 'type-fest';
+/**
+ * Execution type describes the way how the block is executed
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-type
+ */
+export type ExecutionType = TupleToUnion<typeof ExecutionTypes>;
+/**
+ * Execution type describes the way how the block is executed
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-type
+ */
+export declare const ExecutionTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG"];

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

@@ -1,41 +1,41 @@
-import { string_model_name } from './typeAliases';
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
-/**
- * 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];
-/**
- * Abstract way to specify the LLM. It does not specify the LLM with concrete version itself, only the requirements for the LLM.
- *
- * @see https://github.com/webgptorg/promptbook#model-requirements
- */
-export type ModelRequirements = {
-    /**
-     * 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
-     */
-    readonly modelVariant: ModelVariant;
-    /**
-     * The model for text prompt
-     *
-     * Note: Model must be compatible with the model variant
-     *
-     * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
-     */
-    readonly modelName: string_model_name;
-    /**
-     * Maximum number of tokens that can be generated by the model
-     */
-    readonly maxTokens?: number;
-};
-/**
- * TODO: Maybe figure out better word than "variant"
- * TODO: Add here more requirement options like max context size, max tokens, etc.
- */
+import { string_model_name } from './typeAliases';
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
+/**
+ * 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];
+/**
+ * Abstract way to specify the LLM. It does not specify the LLM with concrete version itself, only the requirements for the LLM.
+ *
+ * @see https://github.com/webgptorg/promptbook#model-requirements
+ */
+export type ModelRequirements = {
+    /**
+     * 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
+     */
+    readonly modelVariant: ModelVariant;
+    /**
+     * The model for text prompt
+     *
+     * Note: Model must be compatible with the model variant
+     *
+     * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
+     */
+    readonly modelName: string_model_name;
+    /**
+     * Maximum number of tokens that can be generated by the model
+     */
+    readonly maxTokens?: number;
+};
+/**
+ * TODO: Maybe figure out better word than "variant"
+ * TODO: Add here more requirement options like max context size, max tokens, etc.
+ */

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

@@ -1,14 +1,14 @@
-/**
- * Parameters of the prompt template (pipeline)
- *
- * There are three types of parameters:
- * - **INPUT PARAMETERs** are required to execute the pipeline.
- * - **Intermediate parameters** are used internally in the pipeline.
- * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
- *
- * @see https://github.com/webgptorg/promptbook#parameters
- */
-export type Parameters = object;
-/**
- * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
- */
+/**
+ * Parameters of the prompt template (pipeline)
+ *
+ * There are three types of parameters:
+ * - **INPUT PARAMETERs** are required to execute the pipeline.
+ * - **Intermediate parameters** are used internally in the pipeline.
+ * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
+ *
+ * @see https://github.com/webgptorg/promptbook#parameters
+ */
+export type Parameters = object;
+/**
+ * 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/types/Prompt.d.ts

@@ -1,41 +1,41 @@
-import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
-import type { ModelRequirements } from './ModelRequirements';
-/**
- * Prompt in a text along with model requirements, but without any execution or templating logic.
- *
- * @see https://github.com/webgptorg/promptbook#prompt
- */
-export type Prompt = {
-    /**
-     * The title of the prompt
-     *
-     * Note: This has no effect on the model, it is just for the reporting
-     */
-    readonly title: string_title;
-    /**
-     * The text of the prompt
-     *
-     * Note: This is not a template, this is exactly the text that will be sent to the model
-     * @example "What is the capital of France?"
-     */
-    readonly content: string_prompt;
-    /**
-     * Requirements for the model
-     */
-    readonly modelRequirements: ModelRequirements;
-    /**
-     * Unique identifier of the promptbook with specific template name as hash
-     *
-     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
-     */
-    readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
-    /**
-     * Parameters used in the prompt
-     *
-     * Note: This is redundant (same information is in promptbookUrl+content) but useful for logging and debugging
-     */
-    readonly parameters: Record<string_name, string>;
-};
-/**
- * TODO: [✔] Check ModelRequirements in runtime
- */
+import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import type { ModelRequirements } from './ModelRequirements';
+/**
+ * Prompt in a text along with model requirements, but without any execution or templating logic.
+ *
+ * @see https://github.com/webgptorg/promptbook#prompt
+ */
+export type Prompt = {
+    /**
+     * The title of the prompt
+     *
+     * Note: This has no effect on the model, it is just for the reporting
+     */
+    readonly title: string_title;
+    /**
+     * The text of the prompt
+     *
+     * Note: This is not a template, this is exactly the text that will be sent to the model
+     * @example "What is the capital of France?"
+     */
+    readonly content: string_prompt;
+    /**
+     * Requirements for the model
+     */
+    readonly modelRequirements: ModelRequirements;
+    /**
+     * Unique identifier of the promptbook with specific template name as hash
+     *
+     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
+     */
+    readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
+    /**
+     * Parameters used in the prompt
+     *
+     * Note: This is redundant (same information is in promptbookUrl+content) but useful for logging and debugging
+     */
+    readonly parameters: Record<string_name, string>;
+};
+/**
+ * TODO: [✔] Check ModelRequirements in runtime
+ */