@promptbook/markdown-utils 0.82.0-0 → 0.82.0-2

package/esm/typings/src/_packages/remote-client.index.d.ts

@@ -2,11 +2,17 @@ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { compilePipelineOnRemoteServer } from '../conversion/compilePipelineOnRemoteServer';
 import { RemoteLlmExecutionTools } from '../llm-providers/remote/RemoteLlmExecutionTools';
 import { preparePipelineOnRemoteServer } from '../prepare/preparePipelineOnRemoteServer';
-import type { RemoteLlmExecutionToolsOptions } from '../remote-server/interfaces/RemoteLlmExecutionToolsOptions';
-import type { RemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
+import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
+import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { compilePipelineOnRemoteServer };
 export { RemoteLlmExecutionTools };
 export { preparePipelineOnRemoteServer };
-export type { RemoteLlmExecutionToolsOptions };
+export type { PromptbookServer_Identification };
+export type { PromptbookServer_ApplicationIdentification };
+export type { PromptbookServer_AnonymousIdentification };
+export type { RemoteClientOptions };
 export type { RemoteServerOptions };

package/esm/typings/src/_packages/remote-server.index.d.ts

@@ -1,6 +1,12 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
-import type { RemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
+import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
 import { startRemoteServer } from '../remote-server/startRemoteServer';
+import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
-export type { RemoteServerOptions };
+export type { PromptbookServer_Identification };
+export type { PromptbookServer_ApplicationIdentification };
+export type { PromptbookServer_AnonymousIdentification };
 export { startRemoteServer };
+export type { RemoteServerOptions };

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

@@ -87,21 +87,14 @@ import type { SimpleTaskJson } from '../pipeline/PipelineJson/SimpleTaskJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PipelineString } from '../pipeline/PipelineString';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
-import type { PromptbookServer_Error } from '../remote-server/interfaces/PromptbookServer_Error';
-import type { PromptbookServer_ListModels_Request } from '../remote-server/interfaces/PromptbookServer_ListModels_Request';
-import type { PromptbookServer_ListModels_CollectionRequest } from '../remote-server/interfaces/PromptbookServer_ListModels_Request';
-import type { PromptbookServer_ListModels_AnonymousRequest } from '../remote-server/interfaces/PromptbookServer_ListModels_Request';
-import type { PromptbookServer_ListModels_Response } from '../remote-server/interfaces/PromptbookServer_ListModels_Response';
-import type { PromptbookServer_Prompt_Progress } from '../remote-server/interfaces/PromptbookServer_Prompt_Progress';
-import type { PromptbookServer_Prompt_Request } from '../remote-server/interfaces/PromptbookServer_Prompt_Request';
-import type { PromptbookServer_Prompt_CollectionRequest } from '../remote-server/interfaces/PromptbookServer_Prompt_Request';
-import type { PromptbookServer_Prompt_AnonymousRequest } from '../remote-server/interfaces/PromptbookServer_Prompt_Request';
-import type { PromptbookServer_Prompt_Response } from '../remote-server/interfaces/PromptbookServer_Prompt_Response';
-import type { RemoteLlmExecutionToolsOptions } from '../remote-server/interfaces/RemoteLlmExecutionToolsOptions';
-import type { RemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
-import type { AnonymousRemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
-import type { ApplicationRemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
-import type { ApplicationRemoteServerClientOptions } from '../remote-server/interfaces/RemoteServerOptions';
+import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
+import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
+import type { AnonymousRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
+import type { ApplicationRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
+import type { ApplicationRemoteServerClientOptions } from '../remote-server/types/RemoteServerOptions';
 import type { Converter } from '../scrapers/_common/Converter';
 import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
 import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
@@ -118,6 +111,8 @@ import type { CompletionModelRequirements } from '../types/ModelRequirements';
 import type { ChatModelRequirements } from '../types/ModelRequirements';
 import type { EmbeddingModelRequirements } from '../types/ModelRequirements';
 import type { ModelVariant } from '../types/ModelVariant';
+import type { NonEmptyArray } from '../types/NonEmptyArray';
+import type { NonEmptyReadonlyArray } from '../types/NonEmptyArray';
 import type { Prompt } from '../types/Prompt';
 import type { CompletionPrompt } from '../types/Prompt';
 import type { ChatPrompt } from '../types/Prompt';
@@ -353,17 +348,10 @@ export type { SimpleTaskJson };
 export type { TaskJson };
 export type { PipelineString };
 export type { PrepareAndScrapeOptions };
-export type { PromptbookServer_Error };
-export type { PromptbookServer_ListModels_Request };
-export type { PromptbookServer_ListModels_CollectionRequest };
-export type { PromptbookServer_ListModels_AnonymousRequest };
-export type { PromptbookServer_ListModels_Response };
-export type { PromptbookServer_Prompt_Progress };
-export type { PromptbookServer_Prompt_Request };
-export type { PromptbookServer_Prompt_CollectionRequest };
-export type { PromptbookServer_Prompt_AnonymousRequest };
-export type { PromptbookServer_Prompt_Response };
-export type { RemoteLlmExecutionToolsOptions };
+export type { PromptbookServer_Identification };
+export type { PromptbookServer_ApplicationIdentification };
+export type { PromptbookServer_AnonymousIdentification };
+export type { RemoteClientOptions };
 export type { RemoteServerOptions };
 export type { AnonymousRemoteServerOptions };
 export type { ApplicationRemoteServerOptions };
@@ -384,6 +372,8 @@ export type { CompletionModelRequirements };
 export type { ChatModelRequirements };
 export type { EmbeddingModelRequirements };
 export type { ModelVariant };
+export type { NonEmptyArray };
+export type { NonEmptyReadonlyArray };
 export type { Prompt };
 export type { CompletionPrompt };
 export type { ChatPrompt };

package/esm/typings/src/collection/PipelineCollection.d.ts

@@ -20,6 +20,8 @@ export type PipelineCollection = {
     getPipelineByUrl(url: string_pipeline_url): Promisable<PipelineJson>;
     /**
      * Checks whether given prompt was defined in any pipeline in the collection
+     *
+     * @deprecated Make better mechanism for skimming the remote server
      */
     isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
 };

package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts

@@ -1,6 +1,6 @@
-import type { RemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../pipeline/PipelineString';
+import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
 /**
  * Compile pipeline from string (markdown) format to JSON format
  *
@@ -10,9 +10,12 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * Note: This function acts as compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
- * @param options - Options for remote server compilation
+ * @param options - Configuration of the remote server
  * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/remote-client`
  */
-export declare function compilePipelineOnRemoteServer<TCustomOptions = undefined>(pipelineString: PipelineString, options: RemoteServerOptions<TCustomOptions>): Promise<PipelineJson>;
+export declare function compilePipelineOnRemoteServer<TCustomOptions = undefined>(pipelineString: PipelineString, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
+/**
+ * TODO: !!!! Do not return Promise<PipelineJson> But PreparePipelineTask
+ */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts

@@ -1,6 +1,6 @@
 import type { ClientOptions } from '@anthropic-ai/sdk';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
-import type { RemoteLlmExecutionToolsOptions } from '../../remote-server/interfaces/RemoteLlmExecutionToolsOptions';
+import type { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
 /**
  * Options for `AnthropicClaudeExecutionTools`
  *
@@ -25,7 +25,7 @@ export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & Cl
  */
 export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
     isProxied: true;
-} & Pick<RemoteLlmExecutionToolsOptions<undefined>, 'remoteUrl' | 'path'>;
+} & Pick<RemoteClientOptions<undefined>, 'remoteUrl' | 'path'>;
 /**
  * TODO: [🧠][🤺] Pass `userId`
  */

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -3,13 +3,13 @@ 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 { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
 import type { ChatPrompt } from '../../types/Prompt';
 import type { CompletionPrompt } from '../../types/Prompt';
 import type { EmbeddingPrompt } 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 { RemoteLlmExecutionToolsOptions } from '../../remote-server/interfaces/RemoteLlmExecutionToolsOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
  *
@@ -20,8 +20,8 @@ import type { RemoteLlmExecutionToolsOptions } from '../../remote-server/interfa
  * @public exported from `@promptbook/remote-client`
  */
 export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> implements LlmExecutionTools {
-    protected readonly options: RemoteLlmExecutionToolsOptions<TCustomOptions>;
-    constructor(options: RemoteLlmExecutionToolsOptions<TCustomOptions>);
+    protected readonly options: RemoteClientOptions<TCustomOptions>;
+    constructor(options: RemoteClientOptions<TCustomOptions>);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     /**
@@ -32,10 +32,6 @@ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> impleme
      * List all available models that can be used
      */
     listModels(): Promise<ReadonlyArray<AvailableModel>>;
-    /**
-     * Creates a connection to the remote proxy server.
-     */
-    private makeConnection;
     /**
      * Calls remote proxy server to use a chat model
      */

package/esm/typings/src/other/templates/getBookTemplates.d.ts

@@ -1,12 +1,14 @@
+import { SetRequired } from 'type-fest';
 import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { NonEmptyReadonlyArray } from '../../types/NonEmptyArray';
 /**
  * @@@
  *
  * @singleton
  * @private internal cache of `getBookTemplate`
  */
-export declare let pipelines: Array<PipelineJson> | null;
+export declare let pipelines: Array<SetRequired<PipelineJson, 'pipelineUrl'>> | null;
 /**
  * Get template for new book
  *
@@ -14,9 +16,9 @@ export declare let pipelines: Array<PipelineJson> | null;
  * @returns list of pipelines
  * @public exported from `@promptbook/templates`
  */
-export declare function getBookTemplates(formfactorName?: string_formfactor_name): ReadonlyArray<PipelineJson>;
+export declare function getBookTemplates(formfactorName?: string_formfactor_name): NonEmptyReadonlyArray<SetRequired<PipelineJson, 'pipelineUrl'>>;
 /**
- * TODO: Unit test
+ * TODO: Unit test + test that what we guarantee - always return non-empty array is true for e
  * TODO: [🧠] Which is the best place for this function
  * TODO: !!6 For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
  */

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

@@ -1,5 +1,5 @@
-import type { RemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
 /**
  * Prepare pipeline on remote server
  *
@@ -11,4 +11,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
  *
  * @public exported from `@promptbook/remote-client`
  */
-export declare function preparePipelineOnRemoteServer<TCustomOptions = undefined>(pipeline: PipelineJson, options: RemoteServerOptions<TCustomOptions>): Promise<PipelineJson>;
+export declare function preparePipelineOnRemoteServer<TCustomOptions = undefined>(pipeline: PipelineJson, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
+/**
+ * TODO: !!!! Do not return Promise<PipelineJson> But PreparePipelineTask
+ */

package/esm/typings/src/remote-server/createRemoteClient.d.ts

@@ -0,0 +1,10 @@
+import type { Socket } from 'socket.io-client';
+import type { RemoteClientOptions } from './types/RemoteClientOptions';
+/**
+ * Creates a connection to the remote proxy server.
+ *
+ * Note: This function creates a connection to the remote server and returns a socket but responsibility of closing the connection is on the caller
+ *
+ * @private internal utility function
+ */
+export declare function createRemoteClient<TCustomOptions = undefined>(options: RemoteClientOptions<TCustomOptions>): Promise<Socket>;

package/esm/typings/src/remote-server/{interfaces → socket-types/_common}/PromptbookServer_Error.d.ts

@@ -1,7 +1,7 @@
-import type { ErrorJson } from '../../errors/utils/ErrorJson';
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
 /**
- * Socket.io error for remote text generation
- *
  * This is sent from server to client when error occurs and stops the process
+ *
+ * @private internal type of remote server
  */
 export type PromptbookServer_Error = ErrorJson;

package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Progress.d.ts

@@ -0,0 +1,10 @@
+import type { TaskProgress } from '../../../types/TaskProgress';
+/**
+ * This is sent from server to client as indication of prograss arbitrarily and may be sent multiple times
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_Progress = TaskProgress;
+/**
+ * TODO: `PromptbookServer_Progress` is unused for now, but it will be used in the future
+ */

package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts

@@ -0,0 +1,49 @@
+import type { LlmToolsConfiguration } from '../../../llm-providers/_common/register/LlmToolsConfiguration';
+import type { string_user_id } from '../../../types/typeAliases';
+import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteServerOptions';
+/**
+ * Identification of client for Socket.io remote server
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_Identification<TCustomOptions> = PromptbookServer_ApplicationIdentification<TCustomOptions> | PromptbookServer_AnonymousIdentification;
+/**
+ * Application mode is @@@!!!
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_ApplicationIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
+    /**
+     * Application mode
+     */
+    readonly isAnonymous: false;
+};
+/**
+ * Anonymous mode is @@@!!!
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_AnonymousIdentification = {
+    /**
+     * Anonymous mode
+     */
+    readonly isAnonymous: true;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
+     */
+    readonly userId?: string_user_id;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+};
+/**
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt - Pass `userId` in `PromptbookServer_ListModels_Request`
+ */

package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts

@@ -0,0 +1,17 @@
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * List models available in the server
+ *
+ * This is a request from client to server
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_ListModels_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+};
+/**
+ * TODO: [🧠] Listing models inanonymous mode does not make sence - keeping only to preserve consistency
+ */

package/esm/typings/src/remote-server/{interfaces → socket-types/listModels}/PromptbookServer_ListModels_Response.d.ts

@@ -1,8 +1,10 @@
-import type { AvailableModel } from '../../execution/AvailableModel';
+import type { AvailableModel } from '../../../execution/AvailableModel';
 /**
- * Socket.io error for remote text generation
+ * Models available for use in the server
  *
  * This is sent from server to client when models are listed
+ *
+ * @private internal type of remote server
  */
 export type PromptbookServer_ListModels_Response = {
     /**

package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts

@@ -0,0 +1,17 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * This is a request from client to server to prepare a pipeline
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_PreparePipeline_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    /**
+     * The Pipeline to prepare
+     */
+    readonly pipeline: PipelineJson;
+};

package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+/**
+ * This is sent from server to client when the pipeline is prepared
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_PreparePipeline_Response = {
+    /**
+     * Prepared pipeline
+     */
+    readonly preparedPipeline: PipelineJson;
+};

package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts

@@ -0,0 +1,17 @@
+import type { Prompt } from '../../../types/Prompt';
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * This is a request from client to server to execute a prompt
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_Prompt_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    /**
+     * The Prompt to execute
+     */
+    readonly prompt: Prompt;
+};

package/esm/typings/src/remote-server/{interfaces → socket-types/prompt}/PromptbookServer_Prompt_Response.d.ts

@@ -1,8 +1,8 @@
-import type { PromptResult } from '../../execution/PromptResult';
+import type { PromptResult } from '../../../execution/PromptResult';
 /**
- * Socket.io error for remote text generation
- *
  * This is sent from server to client when the generated text is completed
+ *
+ * @private internal type of remote server
  */
 export type PromptbookServer_Prompt_Response = {
     /**

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -1,5 +1,5 @@
 import type { IDestroyable } from 'destroyable';
-import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
+import type { RemoteServerOptions } from './types/RemoteServerOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
  *
@@ -11,6 +11,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
 /**
+ * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
@@ -19,5 +20,5 @@ export declare function startRemoteServer<TCustomOptions = undefined>(options: R
  * TODO: [🗯] Timeout on chat to free up resources
  * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
  * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
- * TODO: Constrain anonymous mode for specific models / providers
+ * TODO: Allow to constrain anonymous mode for specific models / providers
  */

package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts

@@ -0,0 +1,32 @@
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { string_base_url } from '../../types/typeAliases';
+import type { string_uri } from '../../types/typeAliases';
+import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
+/**
+ * Options for `RemoteLlmExecutionTools`
+ *
+ * @public exported from `@promptbook/remote-client`
+ */
+export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
+    /**
+     * URL of the remote server
+     * On this server will be connected to the socket.io server
+     */
+    readonly remoteUrl: string_base_url;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
+     * Identification of client for Socket.io remote server
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+};
+/**
+ * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */

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

@@ -5,6 +5,7 @@
  * 2) Undefined represents empty array
  * 3) Array represents itself
  *
+ * @deprecated Use `Arrayable` from `type-fest` instead
  * @private internal type
  */
 export type Arrayable<TItem> = TItem | ReadonlyArray<TItem> | undefined;

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

@@ -0,0 +1,8 @@
+/**
+ * Represents an array that is guaranteed to have at least one element
+ */
+export type NonEmptyArray<TItem> = [TItem, ...TItem[]];
+/**
+ * Represents an array that is guaranteed to have at least one element and is readonly
+ */
+export type NonEmptyReadonlyArray<TItem> = ReadonlyArray<TItem> & NonEmptyArray<TItem>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.82.0-0",
+    "version": "0.82.0-2",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-23';
+    var PROMPTBOOK_ENGINE_VERSION = '0.82.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -360,7 +360,7 @@
      * TODO: [🏢] Make this logic part of `JsonFormatDefinition` or `isValidJsonString`
      */
 
-    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge from Markdown\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md`\n-   INPUT PARAMETER `{knowledgeContent}` Markdown document content\n-   OUTPUT PARAMETER `{knowledgePieces}` The knowledge JSON object\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}\n```\n\n`-> {knowledgePieces}`\n"}],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Keywords\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md`\n-   INPUT PARAMETER `{knowledgePieceContent}` The content\n-   OUTPUT PARAMETER `{keywords}` Keywords separated by comma\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}\n```\n\n`-> {keywords}`\n"}],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge-piece Title\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-title.book.md`\n-   INPUT PARAMETER `{knowledgePieceContent}` The content\n-   OUTPUT PARAMETER `{title}` The title of the document\n\n## Knowledge\n\n-   EXPECT MIN 1 WORD\n-   EXPECT MAX 8 WORDS\n\n```markdown\nYou are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n-   Your output format is JSON object\n-   Write just the JSON object, no other text should be present\n-   It contains the following keys:\n    -   `modelName`: The name of the model to use\n    -   `systemMessage`: The system message to provide context to the model\n    -   `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelRequirements",format:"JSON",dependentParameterNames:["availableModelNames","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book.md`\n-   INPUT PARAMETER `{availableModelNames}` List of available model names separated by comma (,)\n-   INPUT PARAMETER `{personaDescription}` Description of the persona\n-   OUTPUT PARAMETER `{modelRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n-   FORMAT JSON\n\n```markdown\nYou are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n\\`\\`\\`json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n\\`\\`\\`\n\n## Instructions\n\n-   Your output format is JSON object\n-   Write just the JSON object, no other text should be present\n-   It contains the following keys:\n    -   `modelName`: The name of the model to use\n    -   `systemMessage`: The system message to provide context to the model\n    -   `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}\n```\n\n`-> {modelRequirements}`\n"}],sourceFile:"./books/prepare-persona.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book.md",formfactorName:"GENERIC",parameters:[{name:"book",description:"The book to prepare the title for",isInput:true,isOutput:false},{name:"title",description:"Best title for the book",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-title",title:"Make title",content:"Make best title for given text which describes the task:\n\n> {book}\n\n## Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Title starts with emoticon",resultingParameterName:"title",expectations:{words:{min:1,max:8},lines:{min:1,max:1}},dependentParameterNames:["book"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Title\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-title.book.md`\n-   INPUT PARAMETER `{book}` The book to prepare the title for\n-   OUTPUT PARAMETER `{title}` Best title for the book\n\n## Make title\n\n-   EXPECT MIN 1 Word\n-   EXPECT MAX 8 Words\n-   EXPECT EXACTLY 1 Line\n\n```markdown\nMake best title for given text which describes the task:\n\n> {book}\n\n## Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Title starts with emoticon\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-title.book.md"}];
+    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge from Markdown\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md`\n-   INPUT PARAMETER `{knowledgeContent}` Markdown document content\n-   OUTPUT PARAMETER `{knowledgePieces}` The knowledge JSON object\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}\n```\n\n`-> {knowledgePieces}`\n"}],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Keywords\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md`\n-   INPUT PARAMETER `{knowledgePieceContent}` The content\n-   OUTPUT PARAMETER `{keywords}` Keywords separated by comma\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}\n```\n\n`-> {keywords}`\n"}],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge-piece Title\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-title.book.md`\n-   INPUT PARAMETER `{knowledgePieceContent}` The content\n-   OUTPUT PARAMETER `{title}` The title of the document\n\n## Knowledge\n\n-   EXPECT MIN 1 WORD\n-   EXPECT MAX 8 WORDS\n\n```markdown\nYou are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n-   Your output format is JSON object\n-   Write just the JSON object, no other text should be present\n-   It contains the following keys:\n    -   `modelName`: The name of the model to use\n    -   `systemMessage`: The system message to provide context to the model\n    -   `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelRequirements",format:"JSON",dependentParameterNames:["availableModelNames","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book.md`\n-   INPUT PARAMETER `{availableModelNames}` List of available model names separated by comma (,)\n-   INPUT PARAMETER `{personaDescription}` Description of the persona\n-   OUTPUT PARAMETER `{modelRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n-   FORMAT JSON\n\n```markdown\nYou are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n\\`\\`\\`json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n\\`\\`\\`\n\n## Instructions\n\n-   Your output format is JSON object\n-   Write just the JSON object, no other text should be present\n-   It contains the following keys:\n    -   `modelName`: The name of the model to use\n    -   `systemMessage`: The system message to provide context to the model\n    -   `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}\n```\n\n`-> {modelRequirements}`\n"}],sourceFile:"./books/prepare-persona.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book.md",formfactorName:"GENERIC",parameters:[{name:"book",description:"The book to prepare the title for",isInput:true,isOutput:false},{name:"title",description:"Best title for the book",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-title",title:"Make title",content:"Make best title for given text which describes the workflow:\n\n## Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n-   Title starts with emoticon\n-   Title should not mention the input and output of the workflow but the main purpose of the workflow\n    _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}",resultingParameterName:"title",expectations:{words:{min:1,max:8},lines:{min:1,max:1}},dependentParameterNames:["book"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Title\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-title.book.md`\n-   INPUT PARAMETER `{book}` The book to prepare the title for\n-   OUTPUT PARAMETER `{title}` Best title for the book\n\n## Make title\n\n-   EXPECT MIN 1 Word\n-   EXPECT MAX 8 Words\n-   EXPECT EXACTLY 1 Line\n\n```markdown\nMake best title for given text which describes the workflow:\n\n## Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n-   Title starts with emoticon\n-   Title should not mention the input and output of the workflow but the main purpose of the workflow\n    _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-title.book.md"}];
 
     /**
      * Function `validatePipelineString` will validate the if the string is a valid pipeline string