@promptbook/utils 0.68.0-1 → 0.68.0-2

package/README.md

@@ -406,7 +406,7 @@ flowchart LR
   end;
 ```
 
--   [More template samples](./samples/templates/)
+-   [More template samples](./samples/pipelines/)
 -   [Read more about `.ptbk.md` file format here](https://github.com/webgptorg/promptbook/discussions/categories/concepts?discussions_q=is%3Aopen+label%3A.ptbk.md+category%3AConcepts)
 
 _Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
@@ -523,7 +523,7 @@ If you have a question [start a discussion](https://github.com/webgptorg/promptb
 
 ### Why not just use the OpenAI SDK / Anthropic Claude SDK / ...?
 
-Different levels of abstraction. OpenAI library is for direct use of OpenAI API. This library is for a higher level of abstraction. It is for creating prompt templates and promptbooks that are independent of the underlying library, LLM model, or even LLM provider.
+Different levels of abstraction. OpenAI library is for direct use of OpenAI API. This library is for a higher level of abstraction. It define pipelines that are independent of the underlying library, LLM model, or even LLM provider.
 
 ### How is it different from the Langchain library?
 

package/esm/index.es.js

@@ -4,7 +4,7 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.68.0-0';
+var PROMPTBOOK_VERSION = '0.68.0-1';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -726,7 +726,7 @@ function extractVariables(script) {
  */
 
 /**
- * Parses the prompt template and returns the set of all used parameters
+ * Parses the template and returns the set of all used parameters
  *
  * @param template the template with used parameters
  * @returns the set of parameter names
@@ -803,8 +803,8 @@ var PipelineLogicError = /** @class */ (function (_super) {
 }(Error));
 
 /**
- * Function renameParameter will find all usable parameters for given prompt template
- * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+ * Function `renameParameter` will find all usable parameters for given template
+ * In other words, it will find all parameters that are not used in the template itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
  * @public exported from `@promptbook/utils`

package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts

@@ -1,7 +1,7 @@
 import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
 /**
- * Expect amount command describes the desired output of the prompt template (after post-processing)
+ * Expect amount command describes the desired output of the 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.

package/esm/typings/src/commands/_common/types/Command.d.ts

@@ -1,6 +1,6 @@
 import { COMMANDS } from '../../index';
 /**
- * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
+ * Command is one piece of the template which adds some logic to the template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
 export type Command = ReturnType<typeof COMMANDS[number]['parse']>;

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -6,7 +6,7 @@ import type { string_href } from '../../types/typeAliases';
  */
 export type renderPipelineMermaidOptions = {
     /**
-     * Callback for creating from prompt template graph node
+     * Callback for creating from template graph node
      */
     linkTemplate?(template: TemplateJson): {
         href: string_href;

package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts

@@ -1,7 +1,7 @@
 import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
 import type { string_parameter_name } from '../../types/typeAliases';
 /**
- * Parses the prompt template and returns the set of all used parameters
+ * Parses the template and returns the set of all used parameters
  *
  * @param template the template with used parameters
  * @returns the set of parameter names

package/esm/typings/src/conversion/utils/renameParameter.d.ts

@@ -16,8 +16,8 @@ type RenameParameterOptions = {
     readonly newParameterName: string_name;
 };
 /**
- * Function renameParameter will find all usable parameters for given prompt template
- * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+ * Function `renameParameter` will find all usable parameters for given template
+ * In other words, it will find all parameters that are not used in the template itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
  * @public exported from `@promptbook/utils`

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -7,7 +7,7 @@ import type { string_json } from '../../types/typeAliases';
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
  *
- * @param path - The path to the file relative to samples/templates directory
+ * @param path - The path to the file relative to samples/pipelines directory
  * @private internal function of tests
  */
 export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;

package/esm/typings/src/prepare/prepareTemplates.d.ts

@@ -9,7 +9,7 @@ type PrepareTemplateInput = Pick<PipelineJson, 'templates' | 'parameters'> & {
 };
 type PreparedTemplates = {
     /**
-     * @@@ Sequence of prompt templates that are chained together to form a pipeline
+     * @@@ Sequence of templates that are chained together to form a pipeline
      */
     readonly templatesPrepared: Array<TemplateJson>;
 };

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

@@ -13,7 +13,7 @@ import type { PreparationJson } from './PreparationJson';
 import type { TemplateJson } from './TemplateJson';
 /**
  * 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.
+ * It represents a series of templates chained together to form a pipeline / one big template with input and result parameters.
  *
  * Note: [🚉] This is fully serializable as JSON
  *
@@ -27,7 +27,7 @@ export type PipelineJson = {
      * 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
+     * Warning: Do not hash part of the URL, hash part is used for identification of the template in the pipeline
      */
     readonly pipelineUrl?: string_pipeline_url;
     /**
@@ -57,7 +57,7 @@ export type PipelineJson = {
      */
     readonly defaultModelRequirements?: Partial<ModelRequirements>;
     /**
-     * Sequence of prompt templates that are chained together to form a pipeline
+     * Sequence of templates that are chained together to form a pipeline
      */
     readonly templates: Array<TemplateJson>;
     /**

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

@@ -10,41 +10,41 @@ import type { string_prompt } from '../typeAliases';
 import type { string_template } from '../typeAliases';
 import type { Expectations } from './Expectations';
 /**
- * Common properties of all prompt templates
+ * Common properties of all templates
  */
 export interface TemplateJsonCommon {
     /**
      * Name of the template
      * - It must be unique across the pipeline
      * - It should start uppercase and can contain letters and numbers
-     * - The pipelineUrl together with hash and name are used to identify the prompt template in the pipeline
+     * - The pipelineUrl together with hash and name are used to identify the template in the pipeline
      */
     readonly name: string_name;
     /**
-     * Title of the prompt template
+     * Title of the template
      * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly title: string;
     /**
-     * Description of the prompt template
+     * Description of the template
      * 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;
     /**
-     * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
+     * List of parameter names that are used in the template and must be defined before the template is executed
      *
      * Note: Joker is one of the dependent parameters
      */
     readonly dependentParameterNames: Array<string_parameter_name>;
     /**
-     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     * If theese parameters meet the expectations requirements, they are used instead of executing this template
      *
      * @see https://github.com/webgptorg/promptbook/discussions/66
      */
     readonly jokerParameterNames?: Array<string_parameter_name>;
     /**
      * Type of the execution
-     * This determines if the prompt template is send to LLM, user or some scripting evaluation
+     * This determines if the template is send to LLM, user or some scripting evaluation
      */
     readonly blockType: BlockType;
     /**
@@ -62,7 +62,7 @@ export interface TemplateJsonCommon {
      */
     readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
     /**
-     * List of postprocessing steps that are executed after the prompt template
+     * List of postprocessing steps that are executed after the template
      *
      * @see https://github.com/webgptorg/promptbook/discussions/31
      */
@@ -85,7 +85,7 @@ export interface TemplateJsonCommon {
      */
     readonly format?: FormatCommand['format'];
     /**
-     * Name of the parameter that is the result of the prompt template
+     * Name of the parameter that is the result of the template
      */
     readonly resultingParameterName: string_name;
 }

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

@@ -1,6 +1,6 @@
 /**
  * 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.
+ * It represents a series of templates chained together to form a pipeline / one big template with input and result parameters.
  *
  * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */

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

@@ -35,7 +35,7 @@ export type ExecutionReportJson = {
      */
     readonly description?: string_markdown_text;
     /**
-     * Sequence of prompt templates in order which were executed
+     * Sequence of templates in order which were executed
      */
     readonly promptExecutions: Array<ExecutionPromptReportJson>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.68.0-1",
+    "version": "0.68.0-2",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -12,7 +12,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.68.0-0';
+    var PROMPTBOOK_VERSION = '0.68.0-1';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -734,7 +734,7 @@
      */
 
     /**
-     * Parses the prompt template and returns the set of all used parameters
+     * Parses the template and returns the set of all used parameters
      *
      * @param template the template with used parameters
      * @returns the set of parameter names
@@ -811,8 +811,8 @@
     }(Error));
 
     /**
-     * Function renameParameter will find all usable parameters for given prompt template
-     * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+     * Function `renameParameter` will find all usable parameters for given template
+     * In other words, it will find all parameters that are not used in the template itseld and all its dependencies
      *
      * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
      * @public exported from `@promptbook/utils`