@promptbook/node 0.92.0-3 → 0.92.0-30

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

@@ -30,11 +30,13 @@ export type PersonaJson = {
  */
 export type PersonaPreparedJson = PersonaJson & {
     /**
-     * Model requirements for the persona
+     * Models requirements for the persona
+     *
+     * Sorted by relevance, best-fitting models is first
      *
      * Note: The model must be CHAT variant to be usable through persona
      */
-    readonly modelRequirements: ChatModelRequirements;
+    readonly modelsRequirements: Array<ChatModelRequirements>;
     /**
      * List of preparation ids that were used to prepare this persona
      */

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

@@ -15,12 +15,12 @@ import type { PersonaPreparedJson } from './PersonaJson';
 import type { PreparationJson } from './PreparationJson';
 import type { TaskJson } from './TaskJson';
 /**
- * Promptbook is the **core concept of this package**.
+ * Represents a Promptbook pipeline defined in JSON format.
  * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
  *
  * Note: [🚉] This is fully serializable as JSON
  *
- * @see @@@ https://github.com/webgptorg/promptbook#promptbook
+ * @see The main Promptbook documentation for more details: https://github.com/webgptorg/promptbook#promptbook
  */
 export type PipelineJson = {
     /**
@@ -103,6 +103,7 @@ export type PipelineJson = {
     }>;
 };
 /**
+ * TODO: [🌪] Make type for deprecated pipelines
  * TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)
  * TODO: [🍙] Make some standard order of json properties
  * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }

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

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

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

@@ -7,8 +7,8 @@ import type { PipelineString } from './PipelineString';
  * 2) `promptTemplate` alias for `prompt`
  * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
- * @param strings @@@
- * @param values @@@
+ * @param strings The static string parts of the template literal
+ * @param values The dynamic values embedded within the template literal used as data
  * @returns the pipeline string
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts

@@ -21,5 +21,5 @@ import type { really_unknown } from '../../utils/organization/really_unknown';
 export declare function extractJsonBlock(markdown: string_markdown): string_json<really_unknown>;
 /**
  * TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
- * TODO: [🏢] Make this logic part of `JsonFormatDefinition` or `isValidJsonString`
+ * TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
  */

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

@@ -4,20 +4,23 @@ import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
 type PrepareTaskInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
     /**
-     * @@@
+     * The number of knowledge pieces available for the pipeline.
      */
     readonly knowledgePiecesCount: number;
 };
 type PreparedTasks = {
     /**
-     * @@@ Sequence of tasks that are chained together to form a pipeline
+     * The sequence of tasks after preparation.
      */
     readonly tasksPrepared: ReadonlyArray<TaskJson>;
 };
 /**
- * @@@
+ * Prepares tasks by adding knowledge to the prompt and ensuring all necessary parameters are included.
  *
- * @public exported from `@promptbook/core`
+ * @param tasks Sequence of tasks that are chained together to form a pipeline
+ * @returns A promise that resolves to the prepared tasks.
+ *
+ * @private internal utility of `preparePipeline`
  */
 export declare function prepareTasks(pipeline: PrepareTaskInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTasks>;
 export {};

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

@@ -28,7 +28,9 @@ export type paths = {
                     headers: {
                         readonly [name: string]: unknown;
                     };
-                    content?: never;
+                    content: {
+                        readonly "text/markdown": string;
+                    };
                 };
             };
         };
@@ -71,16 +73,44 @@ export type paths = {
             };
             readonly responses: {
                 /** @description Successful login */
-                readonly 200: {
+                readonly 201: {
                     headers: {
                         readonly [name: string]: unknown;
                     };
                     content: {
                         readonly "application/json": {
+                            readonly isSuccess?: boolean;
+                            readonly message?: string;
+                            readonly error?: Record<string, never>;
                             readonly identification?: Record<string, never>;
                         };
                     };
                 };
+                /** @description Bad request or login failed */
+                readonly 400: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": {
+                            readonly error?: Record<string, never>;
+                        };
+                    };
+                };
+                /** @description Authentication error */
+                readonly 401: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": {
+                            /** @enum {boolean} */
+                            readonly isSuccess?: false;
+                            readonly message?: string;
+                            readonly error?: Record<string, never>;
+                        };
+                    };
+                };
             };
         };
         readonly delete?: never;
@@ -118,6 +148,15 @@ export type paths = {
                         readonly "application/json": readonly string[];
                     };
                 };
+                /** @description No collection available */
+                readonly 500: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "text/plain": string;
+                    };
+                };
             };
         };
         readonly put?: never;
@@ -128,7 +167,7 @@ export type paths = {
         readonly patch?: never;
         readonly trace?: never;
     };
-    readonly [path: `/books/${string}`]: {
+    readonly "/books/{bookId}": {
         readonly parameters: {
             readonly query?: never;
             readonly header?: never;
@@ -165,7 +204,20 @@ export type paths = {
                     headers: {
                         readonly [name: string]: unknown;
                     };
-                    content?: never;
+                    content: {
+                        readonly "application/json": {
+                            readonly error?: Record<string, never>;
+                        };
+                    };
+                };
+                /** @description No collection available */
+                readonly 500: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "text/plain": string;
+                    };
                 };
             };
         };
@@ -203,7 +255,139 @@ export type paths = {
                         readonly [name: string]: unknown;
                     };
                     content: {
-                        readonly "application/json": readonly Record<string, never>[];
+                        readonly "application/json": readonly {
+                            readonly nonce?: string;
+                            readonly taskId?: string;
+                            readonly taskType?: string;
+                            readonly status?: string;
+                            /** Format: date-time */
+                            readonly createdAt?: string;
+                            /** Format: date-time */
+                            readonly updatedAt?: string;
+                        }[];
+                    };
+                };
+            };
+        };
+        readonly put?: never;
+        readonly post?: never;
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/executions/last": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * Get the last execution
+         * @description Returns details of the last execution task.
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description The last execution task with full details. */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": {
+                            readonly nonce?: string;
+                            readonly taskId?: string;
+                            readonly taskType?: string;
+                            readonly status?: string;
+                            readonly errors?: readonly Record<string, never>[];
+                            readonly warnings?: readonly Record<string, never>[];
+                            /** Format: date-time */
+                            readonly createdAt?: string;
+                            /** Format: date-time */
+                            readonly updatedAt?: string;
+                            readonly currentValue?: Record<string, never>;
+                        };
+                    };
+                };
+                /** @description No execution tasks found. */
+                readonly 404: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "text/plain": string;
+                    };
+                };
+            };
+        };
+        readonly put?: never;
+        readonly post?: never;
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/executions/{taskId}": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * Get specific execution
+         * @description Returns details of a specific execution task.
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path: {
+                    /** @description The ID of the execution task to retrieve. */
+                    readonly taskId: string;
+                };
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description The execution task with full details. */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": {
+                            readonly nonce?: string;
+                            readonly taskId?: string;
+                            readonly taskType?: string;
+                            readonly status?: string;
+                            readonly errors?: readonly Record<string, never>[];
+                            readonly warnings?: readonly Record<string, never>[];
+                            /** Format: date-time */
+                            readonly createdAt?: string;
+                            /** Format: date-time */
+                            readonly updatedAt?: string;
+                            readonly currentValue?: Record<string, never>;
+                        };
+                    };
+                };
+                /** @description Execution task not found. */
+                readonly 404: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "text/plain": string;
                     };
                 };
             };
@@ -239,8 +423,13 @@ export type paths = {
             readonly requestBody: {
                 readonly content: {
                     readonly "application/json": {
+                        /** @description URL of the pipeline to execute */
                         readonly pipelineUrl?: string;
+                        /** @description Alternative field for pipelineUrl */
+                        readonly book?: string;
+                        /** @description Parameters for pipeline execution */
                         readonly inputParameters?: Record<string, never>;
+                        /** @description User identification data */
                         readonly identification?: Record<string, never>;
                     };
                 };
@@ -257,6 +446,91 @@ export type paths = {
                 };
                 /** @description Invalid input. */
                 readonly 400: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": {
+                            readonly error?: Record<string, never>;
+                        };
+                    };
+                };
+                /** @description Pipeline not found. */
+                readonly 404: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "text/plain": string;
+                    };
+                };
+            };
+        };
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/api-docs": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * API documentation UI
+         * @description Swagger UI for API documentation
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description HTML Swagger UI */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        readonly put?: never;
+        readonly post?: never;
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/swagger": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * API documentation UI (alternative path)
+         * @description Swagger UI for API documentation
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description HTML Swagger UI */
+                readonly 200: {
                     headers: {
                         readonly [name: string]: unknown;
                     };
@@ -264,6 +538,47 @@ export type paths = {
                 };
             };
         };
+        readonly put?: never;
+        readonly post?: never;
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/openapi": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * OpenAPI specification
+         * @description Returns the OpenAPI JSON specification
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description OpenAPI specification */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": Record<string, never>;
+                    };
+                };
+            };
+        };
+        readonly put?: never;
+        readonly post?: never;
         readonly delete?: never;
         readonly options?: never;
         readonly head?: never;
@@ -273,7 +588,34 @@ export type paths = {
 };
 export type webhooks = Record<string, never>;
 export type components = {
-    schemas: never;
+    schemas: {
+        readonly Error: {
+            readonly error?: Record<string, never>;
+        };
+        readonly ExecutionTaskSummary: {
+            readonly nonce?: string;
+            readonly taskId?: string;
+            readonly taskType?: string;
+            readonly status?: string;
+            /** Format: date-time */
+            readonly createdAt?: string;
+            /** Format: date-time */
+            readonly updatedAt?: string;
+        };
+        readonly ExecutionTaskFull: {
+            readonly nonce?: string;
+            readonly taskId?: string;
+            readonly taskType?: string;
+            readonly status?: string;
+            readonly errors?: readonly Record<string, never>[];
+            readonly warnings?: readonly Record<string, never>[];
+            /** Format: date-time */
+            readonly createdAt?: string;
+            /** Format: date-time */
+            readonly updatedAt?: string;
+            readonly currentValue?: Record<string, never>;
+        };
+    };
     responses: never;
     parameters: never;
     requestBodies: never;