@promptbook/cli 0.62.1 → 0.62.2

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

@@ -1,32 +1,32 @@
-import type { number_integer } from '../typeAliases';
-import type { number_positive } from '../typeAliases';
-/**
- * Expect this amount of each unit in the answer
- *
- * For example 5 words, 3 sentences, 2 paragraphs, ...
- *
- * Note: Expectations are performed after all postprocessing steps
- * @see https://github.com/webgptorg/promptbook/discussions/30
- */
-export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
-    readonly min?: ExpectationAmount;
-    readonly max?: ExpectationAmount;
-}>>;
-/**
- * Units of text measurement
- * @see https://github.com/webgptorg/promptbook/discussions/30
- */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
-/**
- * Unit of text measurement
- * @see https://github.com/webgptorg/promptbook/discussions/30
- */
-export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
-/**
- * Amount of text measurement
- * @see https://github.com/webgptorg/promptbook/discussions/30
- */
-export type ExpectationAmount = number_integer & (number_positive | 0);
-/**
- * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
- */
+import type { number_integer } from '../typeAliases';
+import type { number_positive } from '../typeAliases';
+/**
+ * Expect this amount of each unit in the answer
+ *
+ * For example 5 words, 3 sentences, 2 paragraphs, ...
+ *
+ * Note: Expectations are performed after all postprocessing steps
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
+    readonly min?: ExpectationAmount;
+    readonly max?: ExpectationAmount;
+}>>;
+/**
+ * Units of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
+/**
+ * Unit of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
+/**
+ * Amount of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type ExpectationAmount = number_integer & (number_positive | 0);
+/**
+ * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
+ */

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

@@ -1,70 +1,70 @@
-import type { EmbeddingVector } from '../../execution/EmbeddingVector';
-import type { string_keyword } from '../../utils/normalization/IKeywords';
-import type { number_id } from '../typeAliases';
-import type { number_linecol_number } from '../typeAliases';
-import type { string_markdown } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { string_model_name } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-/**
- * Defines one piece of knowledge in the pipeline
- *
- * Note: Knowledge piece is by definition prepared
- *
- * @see https://github.com/webgptorg/promptbook/discussions/41
- */
-export type KnowledgePiecePreparedJson = {
-    /**
-     * Unique name of the knowledge piece based on the title
-     */
-    readonly name?: string_name;
-    /**
-     * Short title for the information
-     */
-    readonly title?: string_markdown_text;
-    /**
-     * The information in markdown format
-     */
-    readonly content?: string_markdown;
-    /**
-     * List of sources where the information comes from
-     */
-    readonly sources: Array<{
-        /**
-         * Identifier of the source
-         */
-        readonly name: string_name;
-        /**
-         * Line number
-         */
-        readonly line?: number_linecol_number;
-        /**
-         * Column number
-         */
-        readonly column?: number_linecol_number;
-    }>;
-    /**
-     * List of keywords that are associated with the knowledge piece
-     */
-    readonly keywords: Array<string_keyword>;
-    /**
-     * List of models embeddings that are associated with the knowledge piece
-     */
-    readonly index: Array<{
-        /**
-         * Model name which generated the embedding
-         */
-        readonly modelName: string_model_name;
-        /**
-         * Embedding vector of the knowledge piece
-         */
-        readonly position: EmbeddingVector;
-    }>;
-    /**
-     * List of preparation ids that were used to prepare this knowledge piece
-     */
-    readonly preparationIds: Array<number_id>;
-};
-/**
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { EmbeddingVector } from '../../execution/EmbeddingVector';
+import type { string_keyword } from '../../utils/normalization/IKeywords';
+import type { number_id } from '../typeAliases';
+import type { number_linecol_number } from '../typeAliases';
+import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
+import type { string_model_name } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+/**
+ * Defines one piece of knowledge in the pipeline
+ *
+ * Note: Knowledge piece is by definition prepared
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgePiecePreparedJson = {
+    /**
+     * Unique name of the knowledge piece based on the title
+     */
+    readonly name?: string_name;
+    /**
+     * Short title for the information
+     */
+    readonly title?: string_markdown_text;
+    /**
+     * The information in markdown format
+     */
+    readonly content?: string_markdown;
+    /**
+     * List of sources where the information comes from
+     */
+    readonly sources: Array<{
+        /**
+         * Identifier of the source
+         */
+        readonly name: string_name;
+        /**
+         * Line number
+         */
+        readonly line?: number_linecol_number;
+        /**
+         * Column number
+         */
+        readonly column?: number_linecol_number;
+    }>;
+    /**
+     * List of keywords that are associated with the knowledge piece
+     */
+    readonly keywords: Array<string_keyword>;
+    /**
+     * List of models embeddings that are associated with the knowledge piece
+     */
+    readonly index: Array<{
+        /**
+         * Model name which generated the embedding
+         */
+        readonly modelName: string_model_name;
+        /**
+         * Embedding vector of the knowledge piece
+         */
+        readonly position: EmbeddingVector;
+    }>;
+    /**
+     * List of preparation ids that were used to prepare this knowledge piece
+     */
+    readonly preparationIds: Array<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -1,27 +1,27 @@
-import type { number_id } from '../typeAliases';
-import type { string_knowledge_source } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-/**
- * Defines one source of knowledge in the pipeline
- * For example, a source of information, a fact, a quote, a definition, website, etc.
- *
- * @see https://github.com/webgptorg/promptbook/discussions/41
- */
-export type KnowledgeSourceJson = {
-    readonly name: string_name;
-    readonly source: string_knowledge_source;
-};
-/**
- * Defines one source of knowledge in the pipeline after it has been prepared
- *
- * @see https://github.com/webgptorg/promptbook/discussions/41
- */
-export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
-    /**
-     * List of preparation ids that were used to prepare this knowledge source to knowledge pieces
-     */
-    readonly preparationIds: Array<number_id>;
-};
-/**
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { number_id } from '../typeAliases';
+import type { string_knowledge_source } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+/**
+ * Defines one source of knowledge in the pipeline
+ * For example, a source of information, a fact, a quote, a definition, website, etc.
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgeSourceJson = {
+    readonly name: string_name;
+    readonly source: string_knowledge_source;
+};
+/**
+ * Defines one source of knowledge in the pipeline after it has been prepared
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
+    /**
+     * List of preparation ids that were used to prepare this knowledge source to knowledge pieces
+     */
+    readonly preparationIds: Array<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -1,25 +1,25 @@
-import type { ModelRequirements } from '../ModelRequirements';
-import type { string_name } from '../typeAliases';
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
-/**
- * Template for prompt to LLM
- */
-export type LlmTemplateJson = PromptTemplateJsonCommon & {
-    readonly blockType: 'PROMPT_TEMPLATE';
-    /**
-     * Name of the persona who will be responding to this prompt
-     */
-    readonly personaName?: string_name;
-    /**
-     * Requirements for the model
-     * - This is required only for blockType PROMPT_TEMPLATE
-     */
-    readonly modelRequirements: ModelRequirements;
-};
-/**
- * TODO: [🧠][🥜]
- * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each template
- *       @see https://github.com/webgptorg/promptbook/discussions/79
- * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { ModelRequirements } from '../ModelRequirements';
+import type { string_name } from '../typeAliases';
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for prompt to LLM
+ */
+export type LlmTemplateJson = PromptTemplateJsonCommon & {
+    readonly blockType: 'PROMPT_TEMPLATE';
+    /**
+     * Name of the persona who will be responding to this prompt
+     */
+    readonly personaName?: string_name;
+    /**
+     * Requirements for the model
+     * - This is required only for blockType PROMPT_TEMPLATE
+     */
+    readonly modelRequirements: ModelRequirements;
+};
+/**
+ * TODO: [🧠][🥜]
+ * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each template
+ *       @see https://github.com/webgptorg/promptbook/discussions/79
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -1,41 +1,41 @@
-import type { ChatModelRequirements } from '../ModelRequirements';
-import type { number_id } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-import type { string_persona_description } from '../typeAliases';
-/**
- * Defines a persona in the pipeline
- *
- * @see https://github.com/webgptorg/promptbook/discussions/22
- */
-export type PersonaJson = {
-    /**
-     * Name of the template
-     * - It must be unique across the pipeline
-     * - It should start uppercase and can contain letters and numbers
-     */
-    readonly name: string_name;
-    /**
-     * Description of persona
-     */
-    readonly description: string_persona_description;
-};
-/**
- * Defines a persona in the pipeline after it has been prepared
- *
- * @see https://github.com/webgptorg/promptbook/discussions/22
- */
-export type PersonaPreparedJson = PersonaJson & {
-    /**
-     * Model requirements for the persona
-     *
-     * Note: The model must be CHAT variant to be usable through persona
-     */
-    readonly modelRequirements: ChatModelRequirements;
-    /**
-     * List of preparation ids that were used to prepare this persona
-     */
-    readonly preparationIds: Array<number_id>;
-};
-/**
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { ChatModelRequirements } from '../ModelRequirements';
+import type { number_id } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+import type { string_persona_description } from '../typeAliases';
+/**
+ * Defines a persona in the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ */
+export type PersonaJson = {
+    /**
+     * Name of the template
+     * - It must be unique across the pipeline
+     * - It should start uppercase and can contain letters and numbers
+     */
+    readonly name: string_name;
+    /**
+     * Description of persona
+     */
+    readonly description: string_persona_description;
+};
+/**
+ * Defines a persona in the pipeline after it has been prepared
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ */
+export type PersonaPreparedJson = PersonaJson & {
+    /**
+     * Model requirements for the persona
+     *
+     * Note: The model must be CHAT variant to be usable through persona
+     */
+    readonly modelRequirements: ChatModelRequirements;
+    /**
+     * List of preparation ids that were used to prepare this persona
+     */
+    readonly preparationIds: Array<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -1,87 +1,87 @@
-import type { string_file_path } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { string_pipeline_url } from '../typeAliases';
-import type { string_semantic_version } from '../typeAliases';
-import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
-import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
-import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
-import type { PersonaJson } from './PersonaJson';
-import type { PersonaPreparedJson } from './PersonaJson';
-import type { PreparationJson } from './PreparationJson';
-import type { PromptTemplateJson } from './PromptTemplateJson';
-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
- */
-export type PipelineJson = {
-    /**
-     * Unique identifier of the pipeline
-     *
-     * Note: It must be unique across all pipeline collections
-     * Note: It must use HTTPs URL
-     * Tip: You can do versioning in the URL
-     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md@1.0.0
-     * Warning: Do not hash part of the URL, hash part is used for identification of the prompt template in the pipeline
-     */
-    readonly pipelineUrl?: string_pipeline_url;
-    /**
-     * Internal helper for tracking the source `.ptbk.md` file of the pipeline
-     */
-    readonly sourceFile?: string_file_path;
-    /**
-     * Title of the promptbook
-     * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly title: string_markdown_text;
-    /**
-     * Version of the .ptbk.json file
-     */
-    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
-     */
-    readonly description?: string_markdown_text;
-    /**
-     * Set of variables that are used across the pipeline
-     */
-    readonly parameters: Array<PromptTemplateParameterJson>;
-    /**
-     * Sequence of prompt templates that are chained together to form a pipeline
-     */
-    readonly promptTemplates: Array<PromptTemplateJson>;
-    /**
-     * Set of information that are used as external knowledge in the pipeline
-     *
-     * @see https://github.com/webgptorg/promptbook/discussions/41
-     */
-    readonly knowledgeSources: Array<KnowledgeSourceJson | KnowledgeSourcePreparedJson>;
-    /**
-     * Set of information that are used as external knowledge in the pipeline
-     *
-     * @see https://github.com/webgptorg/promptbook/discussions/41
-     */
-    readonly knowledgePieces: Array<KnowledgePiecePreparedJson>;
-    /**
-     * List of prepared virtual personas that are used in the pipeline
-     *
-     * @see https://github.com/webgptorg/promptbook/discussions/22
-     */
-    readonly personas: Array<PersonaJson | PersonaPreparedJson>;
-    /**
-     * List of prepared virtual personas that are used in the pipeline
-     *
-     * @see https://github.com/webgptorg/promptbook/discussions/78
-     */
-    readonly preparations: Array<PreparationJson>;
-};
-/**
- * TODO: [🍙] Make some standart order of json properties
- * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
- * 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
- */
+import type { string_file_path } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
+import type { string_pipeline_url } from '../typeAliases';
+import type { string_semantic_version } from '../typeAliases';
+import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
+import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
+import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
+import type { PersonaJson } from './PersonaJson';
+import type { PersonaPreparedJson } from './PersonaJson';
+import type { PreparationJson } from './PreparationJson';
+import type { PromptTemplateJson } from './PromptTemplateJson';
+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
+ */
+export type PipelineJson = {
+    /**
+     * Unique identifier of the pipeline
+     *
+     * Note: It must be unique across all pipeline collections
+     * Note: It must use HTTPs URL
+     * Tip: You can do versioning in the URL
+     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md@1.0.0
+     * Warning: Do not hash part of the URL, hash part is used for identification of the prompt template in the pipeline
+     */
+    readonly pipelineUrl?: string_pipeline_url;
+    /**
+     * Internal helper for tracking the source `.ptbk.md` file of the pipeline
+     */
+    readonly sourceFile?: string_file_path;
+    /**
+     * Title of the promptbook
+     * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly title: string_markdown_text;
+    /**
+     * Version of the .ptbk.json file
+     */
+    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
+     */
+    readonly description?: string_markdown_text;
+    /**
+     * Set of variables that are used across the pipeline
+     */
+    readonly parameters: Array<PromptTemplateParameterJson>;
+    /**
+     * Sequence of prompt templates that are chained together to form a pipeline
+     */
+    readonly promptTemplates: Array<PromptTemplateJson>;
+    /**
+     * Set of information that are used as external knowledge in the pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/41
+     */
+    readonly knowledgeSources: Array<KnowledgeSourceJson | KnowledgeSourcePreparedJson>;
+    /**
+     * Set of information that are used as external knowledge in the pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/41
+     */
+    readonly knowledgePieces: Array<KnowledgePiecePreparedJson>;
+    /**
+     * List of prepared virtual personas that are used in the pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/22
+     */
+    readonly personas: Array<PersonaJson | PersonaPreparedJson>;
+    /**
+     * List of prepared virtual personas that are used in the pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/78
+     */
+    readonly preparations: Array<PreparationJson>;
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
+ * 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,22 +1,22 @@
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
-import type { string_promptbook_version } from '../../version';
-import type { number_id } from '../typeAliases';
-export type PreparationJson = {
-    /**
-     * Incremental ID of the preparation
-     */
-    readonly id: number_id;
-    /**
-     * Version of the promptbook used for the preparation
-     */
-    readonly promptbookVersion: string_promptbook_version;
-    /**
-     * Usage of the prompt execution
-     */
-    readonly usage: PromptResultUsage;
-};
-/**
- * TODO: [🍙] Make some standart order of json properties
- * 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
- */
+import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { string_promptbook_version } from '../../version';
+import type { number_id } from '../typeAliases';
+export type PreparationJson = {
+    /**
+     * Incremental ID of the preparation
+     */
+    readonly id: number_id;
+    /**
+     * Version of the promptbook used for the preparation
+     */
+    readonly promptbookVersion: string_promptbook_version;
+    /**
+     * Usage of the prompt execution
+     */
+    readonly usage: PromptResultUsage;
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ * 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/PromptDialogJson.d.ts

@@ -1,13 +1,13 @@
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
-/**
- * Template for prompt to user
- *
- * @see https://github.com/webgptorg/promptbook/discussions/76
- */
-export type PromptDialogJson = PromptTemplateJsonCommon & {
-    readonly blockType: 'PROMPT_DIALOG';
-};
-/**
- * TODO: [🧠][🥜]
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for prompt to user
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/76
+ */
+export type PromptDialogJson = PromptTemplateJsonCommon & {
+    readonly blockType: 'PROMPT_DIALOG';
+};
+/**
+ * TODO: [🧠][🥜]
+ * TODO: [🍙] Make some standart order of json properties
+ */