@promptbook/vercel 0.76.0

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

@@ -0,0 +1,45 @@
+import type { Prompt } from '../../../types/Prompt';
+import type { string_user_id } from '../../../types/typeAliases';
+import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
+import type { CollectionRemoteServerClientOptions } from './RemoteServerOptions';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is a request from client to server
+ */
+export type PromptbookServer_Prompt_Request<TCustomOptions> = PromptbookServer_Prompt_CollectionRequest<TCustomOptions> | PromptbookServer_Prompt_AnonymousRequest;
+export type PromptbookServer_Prompt_CollectionRequest<TCustomOptions> = CollectionRemoteServerClientOptions<TCustomOptions> & {
+    /**
+     * Application mode
+     */
+    readonly isAnonymous: false;
+    /**
+     * The Prompt to execute
+     */
+    readonly prompt: Prompt;
+};
+export type PromptbookServer_Prompt_AnonymousRequest = {
+    /**
+     * 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 | null;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+    /**
+     * The Prompt to execute
+     */
+    readonly prompt: Prompt;
+};
+/**
+ * TODO: [👡] DRY `PromptbookServer_Prompt_Request` and `PromptbookServer_ListModels_Request`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ */

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

@@ -0,0 +1,12 @@
+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
+ */
+export type PromptbookServer_Prompt_Response = {
+    /**
+     * The result of the prompt
+     */
+    readonly promptResult: PromptResult;
+};

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

@@ -0,0 +1,54 @@
+import type { CommonToolsOptions } from '../../../execution/CommonToolsOptions';
+import type { string_base_url } from '../../../types/typeAliases';
+import type { string_uri } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
+import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
+import type { CollectionRemoteServerClientOptions } from './RemoteServerOptions';
+/**
+ * Options for `RemoteLlmExecutionTools`
+ *
+ * @public exported from `@promptbook/remote-client`
+ */
+export type RemoteLlmExecutionToolsOptions<TCustomOptions> = CommonToolsOptions & {
+    /**
+     * URL of the remote PROMPTBOOK 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;
+    /**
+     * Mode of the server to connect to
+     */
+    isAnonymous: boolean;
+} & ({
+    /**
+     * Use anonymous server with anonymous mode
+     */
+    readonly isAnonymous: true;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+    /**
+     * 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 | null;
+} | ({
+    /**
+     * Use anonymous server with client identification and fixed collection
+     */
+    readonly isAnonymous: false;
+} & CollectionRemoteServerClientOptions<TCustomOptions>));
+/**
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */

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

@@ -0,0 +1,73 @@
+import type { Promisable } from 'type-fest';
+import type { PipelineCollection } from '../../../collection/PipelineCollection';
+import type { CommonToolsOptions } from '../../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { string_app_id } from '../../../types/typeAliases';
+import type { string_uri } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
+/**
+ * @@@
+ *
+ * There are two modes of remote server:
+ *
+ * 1) **Application mode** Server will recieve `collection` and execute prompts only from this collection
+ * 2) **Anonymous mode** Server will recieve full `LlmToolsConfiguration` (with api keys) and just acts as a proxy
+ *    In anonymous mode, `collection` will be ignored and any prompt will be executed
+ *
+ * You can enable both modes at the same time.
+ *
+ * @public exported from `@promptbook/remote-client`
+ * @public exported from `@promptbook/remote-server`
+ */
+export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
+    /**
+     * Port on which the server will listen
+     */
+    readonly port: number;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+} & (AnonymousRemoteServerOptions | CollectionRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & CollectionRemoteServerOptions<TCustomOptions>));
+export type AnonymousRemoteServerOptions = {
+    /**
+     * Enable anonymous mode
+     */
+    readonly isAnonymousModeAllowed: true;
+};
+export type CollectionRemoteServerOptions<TCustomOptions> = {
+    /**
+     * Enable application mode
+     */
+    readonly isApplicationModeAllowed: true;
+    /**
+     * Promptbook collection to use
+     *
+     * This is used to check validity of the prompt to prevent misuse
+     */
+    readonly collection: PipelineCollection;
+    /**
+     * Creates llm execution tools for each client
+     */
+    createLlmExecutionTools(options: CollectionRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
+};
+export type CollectionRemoteServerClientOptions<TCustomOptions> = {
+    /**
+     * @@@
+     */
+    readonly appId: string_app_id | null;
+    /**
+     * @@@
+     */
+    readonly userId: string_user_id | null;
+    /**
+     * @@@
+     */
+    readonly customOptions?: TCustomOptions;
+};
+/**
+ * TODO: Constrain anonymous mode for specific models / providers
+ */

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+import '../../openai/register-constructor';
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

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

@@ -0,0 +1,23 @@
+import type { IDestroyable } from 'destroyable';
+import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ * @public exported from `@promptbook/remote-server`
+ */
+export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
+/**
+ * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
+ * TODO: Handle progress - support streaming
+ * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
+ * 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
+ */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -0,0 +1,17 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PersonaPreparedJson } from '../pipeline/PipelineJson/PersonaJson';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { string_persona_description } from '../types/typeAliases';
+/**
+ * Prepares the persona for the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ * @public exported from `@promptbook/core`
+ */
+export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+/**
+ * TODO: [🔃][main] !! If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🏢] !! Check validity of `modelName` in pipeline
+ * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] !! Check validity of `temperature` in pipeline
+ */

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

@@ -0,0 +1,22 @@
+import type { InputParameterJson } from '../PipelineJson/ParameterJson';
+import type { OutputParameterJson } from '../PipelineJson/ParameterJson';
+/**
+ * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ */
+export type PipelineInterface = {
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly inputParameters: ReadonlyArray<InputParameterJson>;
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly outputParameters: ReadonlyArray<OutputParameterJson>;
+};

package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @@@
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GENERIC_PIPELINE_INTERFACE: {
+    readonly inputParameters: readonly [];
+    readonly outputParameters: readonly [];
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getPipelineInterface(pipeline: PipelineJson): PipelineInterface;

package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts

@@ -0,0 +1,26 @@
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ */
+export type IsPipelineImplementingInterfaceOptions = {
+    /**
+     * @@@
+     */
+    pipeline: PipelineJson;
+    /**
+     * @@@
+     */
+    pipelineInterface: PipelineInterface;
+};
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPipelineImplementingInterface(options: IsPipelineImplementingInterfaceOptions): boolean;

package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPipelineInterfacesEqual(pipelineInterface1: PipelineInterface, pipelineInterface2: PipelineInterface): boolean;

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

@@ -0,0 +1,100 @@
+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>;
+    /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this task
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/66
+     */
+    readonly jokerParameterNames?: Array<string_parameter_name>;
+    /**
+     * @@@
+     */
+    readonly foreach?: ForeachJson;
+    /**
+     * Type of the execution
+     * This determines if the task is send to LLM, user or some scripting evaluation
+     */
+    readonly taskType: SectionType;
+    /**
+     * Content of the task with {placeholders} for parameters
+     *
+     * @@@ content vs preparedContent
+     */
+    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * @@@ Content of the task with {placeholders} for parameters
+     *
+     * @@@ content vs preparedContent
+     *
+     * @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: [♈] Probbably 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 sourceContent: 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
+ */