@promptbook/templates 0.92.0-4 → 0.92.0-6

package/esm/index.es.js

@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.92.0-4';
+const PROMPTBOOK_ENGINE_VERSION = '0.92.0-6';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1567,7 +1567,7 @@ function getTemplatesPipelineCollection() {
             "preparations": [
                 {
                     "id": 1,
-                    "promptbookVersion": "0.92.0-3",
+                    "promptbookVersion": "0.92.0-5",
                     "usage": {
                         "price": {
                             "value": 0.01695
@@ -2038,7 +2038,7 @@ function getTemplatesPipelineCollection() {
             "preparations": [
                 {
                     "id": 1,
-                    "promptbookVersion": "0.92.0-3",
+                    "promptbookVersion": "0.92.0-5",
                     "usage": {
                         "price": {
                             "value": 0.01695
@@ -2626,7 +2626,7 @@ function getTemplatesPipelineCollection() {
             "preparations": [
                 {
                     "id": 1,
-                    "promptbookVersion": "0.92.0-3",
+                    "promptbookVersion": "0.92.0-5",
                     "usage": {
                         "price": {
                             "value": 0.016332
@@ -2774,7 +2774,7 @@ function getTemplatesPipelineCollection() {
             "preparations": [
                 {
                     "id": 1,
-                    "promptbookVersion": "0.92.0-3",
+                    "promptbookVersion": "0.92.0-5",
                     "usage": {
                         "price": {
                             "value": 0.016377
@@ -2870,7 +2870,7 @@ function getTemplatesPipelineCollection() {
             "preparations": [
                 {
                     "id": 1,
-                    "promptbookVersion": "0.92.0-3",
+                    "promptbookVersion": "0.92.0-5",
                     "usage": {
                         "price": {
                             "value": 0
@@ -3013,7 +3013,7 @@ function getTemplatesPipelineCollection() {
             "preparations": [
                 {
                     "id": 1,
-                    "promptbookVersion": "0.92.0-3",
+                    "promptbookVersion": "0.92.0-5",
                     "usage": {
                         "price": {
                             "value": 0.016524
@@ -3175,7 +3175,7 @@ function getTemplatesPipelineCollection() {
             "preparations": [
                 {
                     "id": 1,
-                    "promptbookVersion": "0.92.0-3",
+                    "promptbookVersion": "0.92.0-5",
                     "usage": {
                         "price": {
                             "value": 0.017784
@@ -3511,7 +3511,7 @@ function getTemplatesPipelineCollection() {
             "preparations": [
                 {
                     "id": 1,
-                    "promptbookVersion": "0.92.0-3",
+                    "promptbookVersion": "0.92.0-5",
                     "usage": {
                         "price": {
                             "value": 0.018192

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

@@ -91,6 +91,8 @@ import { filterModels } from '../llm-providers/_common/filterModels';
 import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$llmToolsMetadataRegister';
 import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
 import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
+import { MODEL_TRUST_LEVEL } from '../llm-providers/_common/register/LlmToolsMetadata';
+import { MODEL_ORDER } from '../llm-providers/_common/register/LlmToolsMetadata';
 import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
 import { countUsage } from '../llm-providers/_common/utils/count-total-usage/countUsage';
 import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
@@ -230,6 +232,8 @@ export { filterModels };
 export { $llmToolsMetadataRegister };
 export { $llmToolsRegister };
 export { createLlmToolsFromConfiguration };
+export { MODEL_TRUST_LEVEL };
+export { MODEL_ORDER };
 export { cacheLlmTools };
 export { countUsage };
 export { limitTotalUsage };

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

@@ -7,6 +7,7 @@ import { serializeError } from '../errors/utils/serializeError';
 import { forEachAsync } from '../execution/utils/forEachAsync';
 import { isValidCsvString } from '../formats/csv/utils/isValidCsvString';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { jsonParse } from '../formats/json/utils/jsonParse';
 import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
 import { prompt } from '../pipeline/prompt-notation';
 import { promptTemplate } from '../pipeline/prompt-notation';
@@ -91,6 +92,7 @@ export { serializeError };
 export { forEachAsync };
 export { isValidCsvString };
 export { isValidJsonString };
+export { jsonParse };
 export { isValidXmlString };
 export { prompt };
 export { promptTemplate };

package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts

@@ -1,5 +1,5 @@
-import type { LlmExecutionToolsWithTotalUsage } from '../../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { CacheLlmToolsOptions } from '../../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
+import type { LlmExecutionToolsWithTotalUsage } from '../../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { string_promptbook_server_url } from '../../types/typeAliases';
 type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & {
     /**

package/esm/typings/src/conversion/archive/loadArchive.d.ts

@@ -1,6 +1,6 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { string_filename } from '../../types/typeAliases';
-import type { FilesystemTools } from '../../execution/FilesystemTools';
 /**
  * Loads the books from the archive file with `.bookc` extension
  *
@@ -10,7 +10,7 @@ import type { FilesystemTools } from '../../execution/FilesystemTools';
  *
  * @private utility of Prompbook
  */
-export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<Array<PipelineJson>>;
+export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<ReadonlyArray<PipelineJson>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

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

@@ -3,12 +3,17 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
 /**
  * @@@
  *
  * @private internal type of `getKnowledgeFoTask`
  */
 type GetKnowledgeForTaskOptions = {
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
     /**
      * @@@
      */
@@ -21,7 +26,14 @@ type GetKnowledgeForTaskOptions = {
 /**
  * @@@
  *
+ * Here is the place where RAG (retrieval-augmented generation) happens
+ *
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
 export {};
+/**
+ * TODO: !!!! Verify if this is working
+ * TODO: [♨] Implement Better - use keyword search
+ * TODO: [♨] Examples of values
+ */

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

@@ -2,12 +2,17 @@ import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { ReservedParameters } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
 /**
  * @@@
  *
  * @private internal type of `getReservedParametersForTask`
  */
 type GetReservedParametersForTaskOptions = {
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
     /**
      * @@@
      */

package/esm/typings/src/formats/json/utils/jsonParse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Converts a JavaScript Object Notation (JSON) string into an object.
+ *
+ * Note: This is wrapper around `JSON.parse()` with better error and type handling
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function jsonParse<T>(value: string): T;
+/**
+ * TODO: !!!! Use in Promptbook.studio
+ */

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

@@ -3,6 +3,41 @@ import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
+/**
+ * How is the model provider trusted?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_TRUST_LEVEL: {
+    readonly FULL: "Model is running on the local machine, training data and model weights are known, data are ethically sourced";
+    readonly OPEN: "Model is open source, training data and model weights are known";
+    readonly PARTIALLY_OPEN: "Model is open source, but training data and model weights are not (fully) known";
+    readonly CLOSED_LOCAL: "Model can be run locally, but it is not open source";
+    readonly CLOSED_FREE: "Model is behind API gateway but free to use";
+    readonly CLOSED_BUSINESS: "Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications";
+    readonly CLOSED: "Model is behind API gateway and paid";
+    readonly UNTRUSTED: "Model has questions about the training data and ethics, but it is not known if it is a problem or not";
+    readonly VURNABLE: "Model has some known serious vulnerabilities, leaks, ethical problems, etc.";
+};
+/**
+ * How is the model provider important?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_ORDER: {
+    /**
+     * Top-tier models, e.g. OpenAI, Anthropic,...
+     */
+    readonly TOP_TIER: 333;
+    /**
+     * Mid-tier models, e.g. Llama, Mistral, etc.
+     */
+    readonly NORMAL: 100;
+    /**
+     * Low-tier models, e.g. Phi, Tiny, etc.
+     */
+    readonly LOW_TIER: 0;
+};
 /**
  * @@@
  *
@@ -13,6 +48,14 @@ export type LlmToolsMetadata = Registered & {
      * @@@
      */
     readonly title: string_title;
+    /**
+     * How is the model is trusted?
+     */
+    readonly trustLevel: keyof typeof MODEL_TRUST_LEVEL;
+    /**
+     * How is the model provider important and should be sorted in the list of available providers?
+     */
+    readonly order: typeof MODEL_ORDER[keyof typeof MODEL_ORDER] | number;
     /**
      * List of environment variables that can be used to configure the provider
      *

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

@@ -16,6 +16,13 @@ export declare const openapiJson: {
                 responses: {
                     '200': {
                         description: string;
+                        content: {
+                            'text/markdown': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
                     };
                 };
             };
@@ -46,13 +53,22 @@ export declare const openapiJson: {
                     };
                 };
                 responses: {
-                    '200': {
+                    '201': {
                         description: string;
                         content: {
                             'application/json': {
                                 schema: {
                                     type: string;
                                     properties: {
+                                        isSuccess: {
+                                            type: string;
+                                        };
+                                        message: {
+                                            type: string;
+                                        };
+                                        error: {
+                                            type: string;
+                                        };
                                         identification: {
                                             type: string;
                                         };
@@ -61,6 +77,43 @@ export declare const openapiJson: {
                             };
                         };
                     };
+                    '400': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        error: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '401': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        isSuccess: {
+                                            type: string;
+                                            enum: boolean[];
+                                        };
+                                        message: {
+                                            type: string;
+                                        };
+                                        error: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
                 };
             };
         };
@@ -82,6 +135,16 @@ export declare const openapiJson: {
                             };
                         };
                     };
+                    '500': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
                 };
             };
         };
@@ -111,6 +174,28 @@ export declare const openapiJson: {
                     };
                     '404': {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        error: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '500': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
                     };
                 };
             };
@@ -128,11 +213,172 @@ export declare const openapiJson: {
                                     type: string;
                                     items: {
                                         type: string;
+                                        properties: {
+                                            nonce: {
+                                                type: string;
+                                            };
+                                            taskId: {
+                                                type: string;
+                                            };
+                                            taskType: {
+                                                type: string;
+                                            };
+                                            status: {
+                                                type: string;
+                                            };
+                                            createdAt: {
+                                                type: string;
+                                                format: string;
+                                            };
+                                            updatedAt: {
+                                                type: string;
+                                                format: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/executions/last': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        nonce: {
+                                            type: string;
+                                        };
+                                        taskId: {
+                                            type: string;
+                                        };
+                                        taskType: {
+                                            type: string;
+                                        };
+                                        status: {
+                                            type: string;
+                                        };
+                                        errors: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        warnings: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        createdAt: {
+                                            type: string;
+                                            format: string;
+                                        };
+                                        updatedAt: {
+                                            type: string;
+                                            format: string;
+                                        };
+                                        currentValue: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '404': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/executions/{taskId}': {
+            get: {
+                summary: string;
+                description: string;
+                parameters: {
+                    in: string;
+                    name: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                    description: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        nonce: {
+                                            type: string;
+                                        };
+                                        taskId: {
+                                            type: string;
+                                        };
+                                        taskType: {
+                                            type: string;
+                                        };
+                                        status: {
+                                            type: string;
+                                        };
+                                        errors: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        warnings: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        createdAt: {
+                                            type: string;
+                                            format: string;
+                                        };
+                                        updatedAt: {
+                                            type: string;
+                                            format: string;
+                                        };
+                                        currentValue: {
+                                            type: string;
+                                        };
                                     };
                                 };
                             };
                         };
                     };
+                    '404': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
                 };
             };
         };
@@ -149,12 +395,19 @@ export declare const openapiJson: {
                                 properties: {
                                     pipelineUrl: {
                                         type: string;
+                                        description: string;
+                                    };
+                                    book: {
+                                        type: string;
+                                        description: string;
                                     };
                                     inputParameters: {
                                         type: string;
+                                        description: string;
                                     };
                                     identification: {
                                         type: string;
+                                        description: string;
                                     };
                                 };
                             };
@@ -174,13 +427,154 @@ export declare const openapiJson: {
                     };
                     '400': {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        error: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '404': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/api-docs': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/swagger': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/openapi': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
                     };
                 };
             };
         };
     };
-    components: {};
-    tags: never[];
+    components: {
+        schemas: {
+            Error: {
+                type: string;
+                properties: {
+                    error: {
+                        type: string;
+                    };
+                };
+            };
+            ExecutionTaskSummary: {
+                type: string;
+                properties: {
+                    nonce: {
+                        type: string;
+                    };
+                    taskId: {
+                        type: string;
+                    };
+                    taskType: {
+                        type: string;
+                    };
+                    status: {
+                        type: string;
+                    };
+                    createdAt: {
+                        type: string;
+                        format: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                        format: string;
+                    };
+                };
+            };
+            ExecutionTaskFull: {
+                type: string;
+                properties: {
+                    nonce: {
+                        type: string;
+                    };
+                    taskId: {
+                        type: string;
+                    };
+                    taskType: {
+                        type: string;
+                    };
+                    status: {
+                        type: string;
+                    };
+                    errors: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    warnings: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    createdAt: {
+                        type: string;
+                        format: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                        format: string;
+                    };
+                    currentValue: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+    tags: {
+        name: string;
+        description: string;
+    }[];
 };
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/templates",
-    "version": "0.92.0-4",
+    "version": "0.92.0-6",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/templates.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-4"
+        "@promptbook/core": "0.92.0-6"
     },
     "dependencies": {
         "prettier": "2.8.1",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-4';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-6';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1574,7 +1574,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-3",
+                        "promptbookVersion": "0.92.0-5",
                         "usage": {
                             "price": {
                                 "value": 0.01695
@@ -2045,7 +2045,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-3",
+                        "promptbookVersion": "0.92.0-5",
                         "usage": {
                             "price": {
                                 "value": 0.01695
@@ -2633,7 +2633,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-3",
+                        "promptbookVersion": "0.92.0-5",
                         "usage": {
                             "price": {
                                 "value": 0.016332
@@ -2781,7 +2781,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-3",
+                        "promptbookVersion": "0.92.0-5",
                         "usage": {
                             "price": {
                                 "value": 0.016377
@@ -2877,7 +2877,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-3",
+                        "promptbookVersion": "0.92.0-5",
                         "usage": {
                             "price": {
                                 "value": 0
@@ -3020,7 +3020,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-3",
+                        "promptbookVersion": "0.92.0-5",
                         "usage": {
                             "price": {
                                 "value": 0.016524
@@ -3182,7 +3182,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-3",
+                        "promptbookVersion": "0.92.0-5",
                         "usage": {
                             "price": {
                                 "value": 0.017784
@@ -3518,7 +3518,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-3",
+                        "promptbookVersion": "0.92.0-5",
                         "usage": {
                             "price": {
                                 "value": 0.018192