@promptbook/documents 0.101.0-18 → 0.101.0-19

package/esm/typings/src/_packages/core.index.d.ts

@@ -120,6 +120,7 @@ import { createLlmToolsFromConfiguration } from '../llm-providers/_common/regist
 import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
 import { countUsage } from '../llm-providers/_common/utils/count-total-usage/countUsage';
 import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
+import { getSingleLlmExecutionTools } from '../llm-providers/_multiple/getSingleLlmExecutionTools';
 import { joinLlmExecutionTools } from '../llm-providers/_multiple/joinLlmExecutionTools';
 import { MultipleLlmExecutionTools } from '../llm-providers/_multiple/MultipleLlmExecutionTools';
 import { AgentLlmExecutionTools } from '../llm-providers/agent/AgentLlmExecutionTools';
@@ -291,6 +292,7 @@ export { createLlmToolsFromConfiguration };
 export { cacheLlmTools };
 export { countUsage };
 export { limitTotalUsage };
+export { getSingleLlmExecutionTools };
 export { joinLlmExecutionTools };
 export { MultipleLlmExecutionTools };
 export { AgentLlmExecutionTools };

package/esm/typings/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts

@@ -8,3 +8,6 @@ import { string_agent_name, string_url_image } from '../../types/typeAliases';
  * @public exported from `@promptbook/core`
  */
 export declare function generatePlaceholderAgentProfileImageUrl(agentName?: string_agent_name): string_url_image;
+/**
+ * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
+ */

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/MockedChat.d.ts

@@ -31,7 +31,13 @@ export type MockedChatDelayConfig = {
  *
  * @public exported from `@promptbook/components`
  */
-export type MockedChatProps = ChatProps & {
+export type MockedChatProps = Omit<ChatProps, 'onReset' | /*'onMessage' | */ 'onUseTemplate' | 'isVoiceRecognitionButtonShown'> & {
+    /**
+     * Whether to show the reset button
+     *
+     * @default false
+     */
+    isResetShown?: boolean;
     /**
      * Optional delays configuration for emulating typing behavior
      */

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,8 +1,7 @@
 import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
-import type { Parameters } from '../../types/typeAliases';
-import type { string_parameter_name } from '../../types/typeAliases';
+import type { Parameters, string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';

package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts

@@ -1,9 +1,7 @@
 import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
-import type { Parameters } from '../../types/typeAliases';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_parameter_value } from '../../types/typeAliases';
+import type { Parameters, string_markdown, string_parameter_value } from '../../types/typeAliases';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
  * Options for retrieving relevant knowledge for a specific task during pipeline execution.

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts

@@ -1,7 +1,6 @@
 import { Promisable } from 'type-fest';
 import type { Identification } from '../../../remote-server/socket-types/_subtypes/Identification';
-import type { string_app_id } from '../../../types/typeAliases';
-import type { string_url } from '../../../types/typeAliases';
+import type { string_app_id, string_url } from '../../../types/typeAliases';
 import type { really_any } from '../../../utils/organization/really_any';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';

package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts

@@ -1,4 +1,4 @@
-import type { string_user_id } from '../../../types/typeAliases';
+import type { string_markdown_text, string_mime_type_with_wildcard, string_user_id } from '../../../types/typeAliases';
 import { MultipleLlmExecutionTools } from '../../_multiple/MultipleLlmExecutionTools';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
@@ -7,12 +7,18 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  * @private internal type for `$provideLlmToolsFromEnv` and `$provideLlmToolsForTestingAndScriptsAndPlayground`
  */
 export type CreateLlmToolsFromConfigurationOptions = {
+    /**
+     * Title of the LLM tools
+     *
+     * @default 'LLM Tools from Configuration'
+     */
+    readonly title?: string_mime_type_with_wildcard & string_markdown_text;
     /**
      * This will will be passed to the created `LlmExecutionTools`
      *
      * @default false
      */
-    isVerbose?: boolean;
+    readonly isVerbose?: boolean;
     /**
      * Identifier of the end user
      *

package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts

@@ -1,16 +1,8 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
-import type { EmbeddingPromptResult } from '../../execution/PromptResult';
-import type { PromptResult } from '../../execution/PromptResult';
-import type { ChatPrompt } from '../../types/Prompt';
-import type { CompletionPrompt } from '../../types/Prompt';
-import type { EmbeddingPrompt } from '../../types/Prompt';
-import type { Prompt } 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';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, PromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt, CompletionPrompt, EmbeddingPrompt, Prompt } from '../../types/Prompt';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
@@ -18,6 +10,7 @@ import type { string_title } from '../../types/typeAliases';
  * @public exported from `@promptbook/core`
  */
 export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
+    readonly title: string_title & string_markdown_text;
     /**
      * Array of execution tools in order of priority
      */
@@ -25,8 +18,7 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**
      * Gets array of execution tools in order of priority
      */
-    constructor(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>);
-    get title(): string_title & string_markdown_text;
+    constructor(title: string_title & string_markdown_text, ...llmExecutionTools: ReadonlyArray<LlmExecutionTools>);
     get description(): string_markdown;
     get profile(): {
         name: string;

package/esm/typings/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts

@@ -0,0 +1,11 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
+/**
+ * Just returns the given `LlmExecutionTools` or joins multiple into one
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools: undefined | LlmExecutionTools | ReadonlyArray<LlmExecutionTools>): LlmExecutionTools | MultipleLlmExecutionTools;
+/**
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ */

package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts

@@ -1,4 +1,5 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import { string_markdown_text, string_title } from '../../types/typeAliases';
 import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
 /**
  * Joins multiple LLM Execution Tools into one
@@ -15,7 +16,7 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function joinLlmExecutionTools(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
+export declare function joinLlmExecutionTools(title: string_title & string_markdown_text, ...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts

@@ -11,5 +11,6 @@ import type { string_postprocessing_function_name } from '../../types/typeAliase
  */
 export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>): Promise<string>;
 /**
+ * TODO: Do not use LoremIpsum, but use some faked text that looks more human-promptbook-like
  * TODO: [💝] Unite object for expecting amount and format - use here also a format
  */

package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -1,12 +1,9 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { ChatPromptResult, CompletionPromptResult } from '../../execution/PromptResult';
 import type { Prompt } 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';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 /**
  * Mocked execution Tools for just echoing the requests for testing purposes.
  *

package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -1,13 +1,9 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
-import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from '../../execution/PromptResult';
 import type { Prompt } 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';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 /**
  * Mocked execution Tools for just faking expected responses for testing purposes
  *

package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts

@@ -1,6 +1,5 @@
 import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
-import type { Scraper } from '../_common/Scraper';
-import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { Scraper, ScraperSourceHandler } from '../_common/Scraper';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';

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

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.101.0-17`).
+ * It follows semantic versioning (e.g., `0.101.0-18`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/documents",
-    "version": "0.101.0-18",
+    "version": "0.101.0-19",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.101.0-18"
+        "@promptbook/core": "0.101.0-19"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-18';
+    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-19';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3120,6 +3120,25 @@
      * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
      */
 
+    /**
+     * Takes an item or an array of items and returns an array of items
+     *
+     * 1) Any item except array and undefined returns array with that one item (also null)
+     * 2) Undefined returns empty array
+     * 3) Array returns itself
+     *
+     * @private internal utility
+     */
+    function arrayableToArray(input) {
+        if (input === undefined) {
+            return [];
+        }
+        if (input instanceof Array) {
+            return input;
+        }
+        return [input];
+    }
+
     /**
      * Predefined profiles for LLM providers to maintain consistency across the application
      * These profiles represent each provider as a virtual persona in chat interfaces
@@ -3200,12 +3219,10 @@
         /**
          * Gets array of execution tools in order of priority
          */
-        constructor(...llmExecutionTools) {
+        constructor(title, ...llmExecutionTools) {
+            this.title = title;
             this.llmExecutionTools = llmExecutionTools;
         }
-        get title() {
-            return 'Multiple LLM Providers';
-        }
         get description() {
             const innerModelsTitlesAndDescriptions = this.llmExecutionTools
                 .map(({ title, description }, index) => {
@@ -3291,7 +3308,7 @@
                             return await llmExecutionTools.callEmbeddingModel(prompt);
                         // <- case [🤖]:
                         default:
-                            throw new UnexpectedError(`Unknown model variant "${prompt.modelRequirements.modelVariant}"`);
+                            throw new UnexpectedError(`Unknown model variant "${prompt.modelRequirements.modelVariant}" in ${llmExecutionTools.title}`);
                     }
                 }
                 catch (error) {
@@ -3312,7 +3329,7 @@
                 //     2) AnthropicClaude throw PipelineExecutionError: Parameter `{knowledge}` is not defined
                 //     3) ...
                 spaceTrim__default["default"]((block) => `
-                          All execution tools failed:
+                          All execution tools of ${this.title} failed:
 
                           ${block(errors
                 .map(({ error, llmExecutionTools }, i) => `${i + 1}) **${llmExecutionTools.title}** thrown **${error.name || 'Error'}:** ${error.message}`)
@@ -3321,11 +3338,11 @@
                     `));
             }
             else if (this.llmExecutionTools.length === 0) {
-                throw new PipelineExecutionError(`You have not provided any \`LlmExecutionTools\``);
+                throw new PipelineExecutionError(`You have not provided any \`LlmExecutionTools\` into ${this.title}`);
             }
             else {
                 throw new PipelineExecutionError(spaceTrim__default["default"]((block) => `
-                          You have not provided any \`LlmExecutionTools\` that support model variant "${prompt.modelRequirements.modelVariant}"
+                          You have not provided any \`LlmExecutionTools\` that support model variant "${prompt.modelRequirements.modelVariant}" into ${this.title}
 
                           Available \`LlmExecutionTools\`:
                           ${block(this.description)}
@@ -3355,7 +3372,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    function joinLlmExecutionTools(...llmExecutionTools) {
+    function joinLlmExecutionTools(title, ...llmExecutionTools) {
         if (llmExecutionTools.length === 0) {
             const warningMessage = spaceTrim__default["default"](`
             You have not provided any \`LlmExecutionTools\`
@@ -3387,30 +3404,27 @@
             };
             */
         }
-        return new MultipleLlmExecutionTools(...llmExecutionTools);
+        return new MultipleLlmExecutionTools(title || 'Multiple LLM Providers joined by `joinLlmExecutionTools`', ...llmExecutionTools);
     }
     /**
      * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
      */
 
     /**
-     * Takes an item or an array of items and returns an array of items
-     *
-     * 1) Any item except array and undefined returns array with that one item (also null)
-     * 2) Undefined returns empty array
-     * 3) Array returns itself
+     * Just returns the given `LlmExecutionTools` or joins multiple into one
      *
-     * @private internal utility
+     * @public exported from `@promptbook/core`
      */
-    function arrayableToArray(input) {
-        if (input === undefined) {
-            return [];
-        }
-        if (input instanceof Array) {
-            return input;
-        }
-        return [input];
+    function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools) {
+        const _llms = arrayableToArray(oneOrMoreLlmExecutionTools);
+        const llmTools = _llms.length === 1
+            ? _llms[0]
+            : joinLlmExecutionTools('Multiple LLM Providers joined by `getSingleLlmExecutionTools`', ..._llms);
+        return llmTools;
     }
+    /**
+     * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+     */
 
     /**
      * Prepares the persona for the pipeline
@@ -3429,8 +3443,7 @@
             pipeline: await collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-persona.book'),
             tools,
         });
-        const _llms = arrayableToArray(tools.llm);
-        const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+        const llmTools = getSingleLlmExecutionTools(tools.llm);
         const availableModels = (await llmTools.listModels())
             .filter(({ modelVariant }) => modelVariant === 'CHAT')
             .map(({ modelName, modelDescription }) => ({
@@ -4192,9 +4205,7 @@
         if (tools === undefined || tools.llm === undefined) {
             throw new MissingToolsError('LLM tools are required for preparing the pipeline');
         }
-        // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
-        const _llms = arrayableToArray(tools.llm);
-        const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+        const llmTools = getSingleLlmExecutionTools(tools.llm);
         const llmToolsWithUsage = countUsage(llmTools);
         //    <- TODO: [🌯]
         /*
@@ -5337,9 +5348,7 @@
             $scriptPipelineExecutionErrors: [],
             $failedResults: [], // Track all failed attempts
         };
-        // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
-        const _llms = arrayableToArray(tools.llm);
-        const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+        const llmTools = getSingleLlmExecutionTools(tools.llm);
         attempts: for (let attemptIndex = -jokerParameterNames.length; attemptIndex < maxAttempts; attemptIndex++) {
             const isJokerAttempt = attemptIndex < 0;
             const jokerParameterName = jokerParameterNames[jokerParameterNames.length + attemptIndex];
@@ -5859,9 +5868,7 @@
             return ''; // <- Note: Np knowledge present, return empty string
         }
         try {
-            // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
-            const _llms = arrayableToArray(tools.llm);
-            const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+            const llmTools = getSingleLlmExecutionTools(tools.llm);
             const taskEmbeddingPrompt = {
                 title: 'Knowledge Search',
                 modelRequirements: {
@@ -6578,9 +6585,7 @@
                 throw new MissingToolsError('LLM tools are required for scraping external files');
                 // <- Note: This scraper is used in all other scrapers, so saying "external files" not "markdown files"
             }
-            // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
-            const _llms = arrayableToArray(llm);
-            const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+            const llmTools = getSingleLlmExecutionTools(llm);
             // TODO: [🌼] In future use `ptbk make` and made getPipelineCollection
             const collection = createCollectionFromJson(...PipelineCollection);
             const prepareKnowledgeFromMarkdownExecutor = createPipelineExecutor({