@promptbook/wizard 0.95.0

package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts

@@ -0,0 +1,103 @@
+import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
+import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
+import type { SectionType } from '../../types/SectionType';
+import type { string_javascript } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
+import type { string_prompt } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
+import type { Expectations } from './Expectations';
+/**
+ * Common properties of all tasks
+ */
+export type CommonTaskJson = {
+    /**
+     * Name of the task
+     * - 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 task in the pipeline
+     */
+    readonly name: string_name;
+    /**
+     * Title of the task
+     * 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 task
+     * 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 task and must be defined before the task is executed
+     *
+     * Note: Joker is one of the dependent parameters
+     */
+    readonly dependentParameterNames: Array<string_parameter_name>;
+    /**
+     * List of parameter names that act as jokers.
+     * If a joker parameter meets the expectations, its value is used instead of executing the task.
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/66
+     */
+    readonly jokerParameterNames?: Array<string_parameter_name>;
+    /**
+     * Configuration for the FOREACH command, if used.
+     * Allows iterating over a list parameter.
+     */
+    readonly foreach?: ForeachJson;
+    /**
+     * Type of the execution
+     * This determines if the task is send to LLM, user or some scripting evaluation
+     */
+    readonly taskType: SectionType;
+    /**
+     * Raw content of the task with {placeholders} for parameters before any preparation.
+     *
+     * @see preparedContent
+     */
+    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * Content of the task after preparation, with {placeholders} for parameters.
+     * This is the content used during execution.
+     *
+     * @see content
+     *
+     * @default "{content}"
+     */
+    readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the task
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/31
+     */
+    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
+    /**
+     * 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
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @see https://github.com/webgptorg/promptbook/discussions/30
+     * @deprecated [💝]
+     */
+    readonly format?: FormatCommand['format'];
+    /**
+     * Name of the parameter that is the result of the task
+     */
+    readonly resultingParameterName: string_name;
+};
+/**
+ * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ * TODO: [♈] Probably move expectations from tasks to parameters
+ */

package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts

@@ -0,0 +1,13 @@
+import type { CommonTaskJson } from './CommonTaskJson';
+/**
+ * Task for prompt to user
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/76
+ */
+export type DialogTaskJson = CommonTaskJson & {
+    readonly taskType: 'DIALOG_TASK';
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

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

@@ -0,0 +1,40 @@
+import type { TupleToUnion } from 'type-fest';
+import type { number_integer } from '../../types/typeAliases';
+import type { number_positive } from '../../types/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
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
+    readonly min?: ExpectationAmount;
+    readonly max?: ExpectationAmount;
+}>>;
+/**
+ * Unit of text measurement
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type ExpectationUnit = TupleToUnion<typeof EXPECTATION_UNITS>;
+/**
+ * Units of text measurement
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ * @public exported from `@promptbook/core`
+ */
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
+/**
+ * Amount of text measurement
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @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 format
+ */

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

@@ -0,0 +1,73 @@
+import type { EmbeddingVector } from '../../execution/EmbeddingVector';
+import type { number_id } from '../../types/typeAliases';
+import type { number_linecol_number } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_model_name } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_keyword } from '../../utils/normalization/IKeywords';
+/**
+ * Defines one piece of knowledge in the pipeline
+ *
+ * Note: Knowledge piece is by definition prepared
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @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: ReadonlyArray<{
+        /**
+         * 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: ReadonlyArray<string_keyword>;
+    /**
+     * List of models embeddings that are associated with the knowledge piece
+     */
+    readonly index: ReadonlyArray<{
+        /**
+         * 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: ReadonlyArray<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,44 @@
+import type { number_id } from '../../types/typeAliases';
+import type { string_knowledge_source_content } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Defines one source of knowledge in the pipeline
+ * For example, a source of information, a fact, a quote, a definition, website, etc.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgeSourceJson = {
+    /**
+     * Unique identifier of the knowledge source
+     */
+    readonly name: string_name;
+    /**
+     * Source of one knowledge
+     *
+     * It can be a link, a relative path to file or direct text or combination of those
+     *
+     * For example `"https://pavolhejny.com/"`
+     * For example `"./pavol-hejny-cv.pdf"`
+     * For example `"Pavol Hejný has web https://pavolhejny.com/"`
+     * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
+     */
+    readonly knowledgeSourceContent: string_knowledge_source_content;
+};
+/**
+ * Defines one source of knowledge in the pipeline after it has been prepared
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @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: ReadonlyArray<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts

@@ -0,0 +1,98 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * Describes one parameter of the pipeline
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ParameterJson = InputParameterJson | IntermediateParameterJson | OutputParameterJson;
+/**
+ * Describes input parameter of the pipeline
+ *
+ * 🔴 -> ⚪ -> ⚪
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type InputParameterJson = CommonParameterJson & {
+    /**
+     * The parameter is input of the pipeline
+     */
+    readonly isInput: true;
+    /**
+     * The parameter is NOT output of the pipeline
+     */
+    readonly isOutput: false;
+};
+/**
+ * Describes intermediate parameter of the pipeline
+ *
+ * ⚪ -> 🔴 -> ⚪
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type IntermediateParameterJson = CommonParameterJson & {
+    /**
+     * The parameter is NOT input of the pipeline
+     */
+    readonly isInput: false;
+    /**
+     * The parameter is NOT output of the pipeline
+     */
+    readonly isOutput: false;
+};
+/**
+ * Describes output parameter of the pipeline
+ *
+ * ⚪ -> ⚪ -> 🔴
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type OutputParameterJson = CommonParameterJson & {
+    /**
+     * The parameter is NOT input of the pipeline
+     */
+    readonly isInput: false;
+    /**
+     * The parameter is output of the pipeline
+     */
+    readonly isOutput: true;
+};
+/**
+ * Describes commons of one parameter of the pipeline
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type CommonParameterJson = {
+    /**
+     * Name of the parameter
+     * - It must be unique across the pipeline
+     * - It should start lowercase and contain letters and numbers
+     */
+    readonly name: string_parameter_name;
+    /**
+     * The parameter is input of the pipeline
+     */
+    readonly isInput: boolean;
+    /**
+     * The parameter is output of the pipeline
+     */
+    readonly isOutput: boolean;
+    /**
+     * Description of the parameter
+     * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly description?: string_markdown_text;
+    /**
+     * Example values of the parameter
+     * Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
+     */
+    readonly exampleValues?: Array<string_parameter_value>;
+};
+/**
+ * TODO: [🧠][🛴][♈] Maybe add type + expectations into the intefrace, like "a person name"
+ *       [🛴] @see https://github.com/webgptorg/promptbook/discussions/53
+ * TODO: [🧠] Should be here registered subparameters from foreach or not?
+ * TODO: [♈] Probably move expectations from tasks to parameters
+ * TODO: [🍙] Make some standard order of json properties
+ */

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

@@ -0,0 +1,47 @@
+import type { ChatModelRequirements } from '../../types/ModelRequirements';
+import type { number_id } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_persona_description } from '../../types/typeAliases';
+/**
+ * Defines a persona in the pipeline
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ */
+export type PersonaJson = {
+    /**
+     * Name of the persona
+     * - 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
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ */
+export type PersonaPreparedJson = PersonaJson & {
+    /**
+     * Models requirements for the persona
+     *
+     * Sorted by relevance, best-fitting models is first
+     *
+     * Note: The model must be CHAT variant to be usable through persona
+     */
+    readonly modelsRequirements: Array<ChatModelRequirements>;
+    /**
+     * List of preparation ids that were used to prepare this persona
+     */
+    readonly preparationIds: ReadonlyArray<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

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

@@ -0,0 +1,113 @@
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { string_filename } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_relative_filename } from '../../types/typeAliases';
+import type { string_semantic_version } from '../../types/typeAliases';
+import type { PipelineString } from '../PipelineString';
+import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
+import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
+import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
+import type { ParameterJson } from './ParameterJson';
+import type { PersonaJson } from './PersonaJson';
+import type { PersonaPreparedJson } from './PersonaJson';
+import type { PreparationJson } from './PreparationJson';
+import type { TaskJson } from './TaskJson';
+/**
+ * Represents a Promptbook pipeline defined in JSON format.
+ * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @see The main Promptbook documentation for more details: 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.book@1.0.0
+     * Warning: Do not hash part of the URL, hash part is used for identification of the task in the pipeline
+     */
+    readonly pipelineUrl?: string_pipeline_url;
+    /**
+     * Internal helper for tracking the source `.book` file of the pipeline
+     */
+    readonly sourceFile?: string_filename;
+    /**
+     * 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 Book language
+     *
+     * @see https://github.com/webgptorg/book
+     */
+    readonly bookVersion?: 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;
+    /**
+     * Name of the formfactor that the pipeline is shaped for
+     */
+    readonly formfactorName: string_formfactor_name;
+    /**
+     * Set of variables that are used across the pipeline
+     */
+    readonly parameters: Array<ParameterJson>;
+    /**
+     * Default model requirements for the model for all `tasks`
+     */
+    readonly defaultModelRequirements?: Partial<ModelRequirements>;
+    /**
+     * Sequence of tasks that are chained together to form a pipeline
+     */
+    readonly tasks: Array<TaskJson>;
+    /**
+     * 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>;
+    /**
+     * Backup of the original book source
+     */
+    readonly sources: ReadonlyArray<{
+        type: 'BOOK';
+        path: string_relative_filename | null;
+        content: PipelineString;
+    }>;
+};
+/**
+ * TODO: [🌪] Make type for deprecated pipelines
+ * TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)
+ * TODO: [🍙] Make some standard 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/pipeline/PipelineJson/PreparationJson.d.ts

@@ -0,0 +1,22 @@
+import type { Usage } from '../../execution/Usage';
+import type { number_id } from '../../types/typeAliases';
+import type { string_promptbook_version } from '../../version';
+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: Usage;
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ * TODO: Maybe put here used `modelName`
+ * TODO: [🍥] When using `date` it changes all examples .bookc files each time so until some more elegant solution omit the time from prepared pipeline
+ */

package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts

@@ -0,0 +1,26 @@
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { string_name } from '../../types/typeAliases';
+import type { CommonTaskJson } from './CommonTaskJson';
+/**
+ * Task for prompt to LLM
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type PromptTaskJson = CommonTaskJson & {
+    readonly taskType: 'PROMPT_TASK';
+    /**
+     * Name of the persona who will be responding to this prompt
+     */
+    readonly personaName?: string_name;
+    /**
+     * Requirements for the model
+     * - This is required only for taskType PROMPT_TASK
+     */
+    readonly modelRequirements?: Partial<ModelRequirements>;
+};
+/**
+ * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each task
+ *       @see https://github.com/webgptorg/promptbook/discussions/79
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts

@@ -0,0 +1,20 @@
+import type { ScriptLanguage } from '../../types/ScriptLanguage';
+import type { CommonTaskJson } from './CommonTaskJson';
+/**
+ * Task for script execution
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/77
+ */
+export type ScriptTaskJson = CommonTaskJson & {
+    readonly taskType: 'SCRIPT_TASK';
+    /**
+     * Language of the script
+     * - This is required only for taskType SCRIPT
+     *
+     */
+    readonly contentLanguage?: ScriptLanguage;
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts

@@ -0,0 +1,13 @@
+import type { CommonTaskJson } from './CommonTaskJson';
+/**
+ * Task for simple concatenation of strings
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/17
+ */
+export type SimpleTaskJson = CommonTaskJson & {
+    readonly taskType: 'SIMPLE_TASK';
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts

@@ -0,0 +1,11 @@
+import type { ___or___ } from '../../utils/organization/___or___';
+import type { DialogTaskJson } from './DialogTaskJson';
+import type { PromptTaskJson } from './PromptTaskJson';
+import type { ScriptTaskJson } from './ScriptTaskJson';
+import type { SimpleTaskJson } from './SimpleTaskJson';
+/**
+ * Describes one (prompt) task in the pipeline
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type TaskJson = PromptTaskJson | SimpleTaskJson | ScriptTaskJson | DialogTaskJson | ___or___ | ___or___;

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

@@ -0,0 +1,11 @@
+/**
+ * Promptbook is the **core concept of this package**.
+ * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
+ *
+ * Represents a Promptbook pipeline defined as a string.
+ *
+ * @see The main Promptbook documentation for more details: https://github.com/webgptorg/promptbook#promptbook
+ */
+export type PipelineString = string & {
+    readonly _type: 'Promptbook';
+};

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -0,0 +1,19 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Tag function for notating a pipeline with a book\`...\ notation as template literal
+ *
+ * Note: There are 3 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @param strings The static string parts of the template literal
+ * @param values The dynamic values embedded within the template literal used as data
+ * @returns the pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */