@promptbook/cli 0.61.0-27 → 0.61.0-29

package/umd/typings/src/execution/PipelineExecutor.d.ts

@@ -1,4 +1,5 @@
 import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
@@ -10,6 +11,8 @@ import type { PromptResultUsage } from './PromptResultUsage';
  *
  * It can be created with `createPipelineExecutor` function.
  *
+ * @@@ almost-JSON (what about errors)
+ *
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
@@ -17,8 +20,16 @@ export type PipelineExecutor = {
 };
 /**
  * @@@
+ *
+ * @@@ almost-JSON (what about errors)
  */
 export type PipelineExecutorResult = {
+    /**
+     * Result parameters of the execution
+     *
+     * Note: If the execution was not successful, there are only some of the result parameters
+     */
+    readonly outputParameters: Parameters;
     /**
      * Whether the execution was successful, details are aviable in `executionReport`
      */
@@ -40,13 +51,14 @@ export type PipelineExecutorResult = {
      */
     readonly executionReport: ExecutionReportJson;
     /**
-     * Result parameters of the execution
+     * The prepared pipeline that was used for the execution
      *
-     * Note: If the execution was not successful, there are only some of the result parameters
+     * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
+     *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
      */
-    readonly outputParameters: Parameters;
+    readonly preparedPipeline: PipelineJson;
 };
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?
- * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result
+ * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result - BUT maybe NOT?
  */

package/umd/typings/src/execution/PromptResult.d.ts

@@ -1,5 +1,6 @@
 import type { string_date_iso8601 } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
+import type { string_prompt } from '../types/typeAliases';
 import type { TODO_object } from '../utils/organization/TODO_object';
 import type { EmbeddingVector } from './EmbeddingVector';
 import type { PromptResultUsage } from './PromptResultUsage';
@@ -69,8 +70,22 @@ export type CommonPromptResult = {
      * Usage of the prompt execution
      */
     readonly usage: PromptResultUsage;
+    /**
+     * Exact text of the prompt (with all replacements)
+     *
+     * Note: This contains redundant information
+     */
+    readonly rawPromptContent: string_prompt;
+    /**
+     * Raw request to the model
+     *
+     * Note: This contains redundant information
+     */
+    readonly rawRequest: TODO_object | null;
     /**
      * Raw response from the model
+     *
+     * Note: This contains redundant information
      */
     readonly rawResponse: TODO_object;
 };

package/umd/typings/src/execution/createPipelineExecutor.d.ts

@@ -20,6 +20,16 @@ type CreatePipelineExecutorSettings = {
      * @default false
      */
     readonly isVerbose?: boolean;
+    /**
+     * If you pass fully prepared pipeline, this does not matter
+     *
+     * Otherwise:
+     * If false or not set, warning is shown when pipeline is not prepared
+     * If true, warning is suppressed
+     *
+     * @default false
+     */
+    readonly isNotPreparedWarningSupressed?: boolean;
 };
 /**
  * Options for `createPipelineExecutor`
@@ -47,8 +57,6 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
- * TODO: !!!!! return `preparedPipeline` from execution
- * TODO: !!!!! `isNotPreparedWarningSupressed`
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters

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

@@ -50,5 +50,5 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
 }
 /**
  * TODO: [🍓] Allow to list compatible models with each variant
- * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
+ * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

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

@@ -12,8 +12,8 @@ export declare function startRemoteServer(options: RemoteServerOptions): IDestro
 /**
  * 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: [🗯] 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
  */

package/umd/typings/src/prepare/preparePipeline.d.ts

@@ -12,6 +12,6 @@ export declare function preparePipeline(pipeline: PipelineJson, options: Prepare
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
- * TODO: [🎐] !!!!!! Use here countTotalUsage
+ * TODO: [🎐] !!!!! Use here countTotalUsage
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/umd/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -41,7 +41,7 @@ export type ExecutionReportJson = {
         /**
          * The prompt wich was executed
          */
-        readonly prompt: Omit<Prompt, 'pipelineUrl' | 'parameters'>;
+        readonly prompt: Omit<Prompt, 'pipelineUrl'>;
         /**
          * Result of the prompt execution (if not failed during LLM execution)
          */