@promptbook/remote-client 0.61.0-26 → 0.61.0-28

package/esm/index.es.js

@@ -208,13 +208,13 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
 }());
 /**
  * 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
  */
 
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.61.0-25';
+var PROMPTBOOK_VERSION = '0.61.0-27';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 export { PROMPTBOOK_VERSION, RemoteLlmExecutionTools };

package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -43,6 +43,5 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
 export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json pipelines
  * Note: [🟢] This code should never be published outside of `@pipeline/node`
  */

package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts

@@ -7,7 +7,7 @@ import type { string_json } from '../../types/typeAliases';
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**
- * TODO: !!!! Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
  * TODO: [🍙] Make some standart order of json properties

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -26,11 +26,11 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🧠][🐣] !!!! Validate that all samples match expectations
- * TODO: [🧠][🐣] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🧠][🐣] !!!! Validate that persona can be used only with CHAT variant
- * TODO: !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: !!!! Validate that reserved parameter is not used as joker
- * TODO: [🧠] !!! Validationg not only logic itself but imports around - files and websites and rerefenced pipelines exists
+ * TODO: [🐣] !!!! Validate that all samples match expectations
+ * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

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

@@ -48,5 +48,5 @@ export type PipelineExecutorResult = {
 };
 /**
  * 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
  */

package/esm/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/esm/typings/src/execution/createPipelineExecutor.d.ts

@@ -47,8 +47,8 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
- * TODO: !!!! return `preparedPipeline` from execution
- * TODO: !!!! `isNotPreparedWarningSupressed`
+ * 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
@@ -57,5 +57,5 @@ export {};
  * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
  * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- * TODO: [💷] !!!! `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result
+ * TODO: [🧠][💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result BUT maybe NOT to preserve pure JSON object
  */

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

@@ -41,7 +41,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: !!!! [🍆] JSON mode
+ * TODO:  [🍆] JSON mode
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError

package/esm/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/esm/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/esm/typings/src/prepare/isPipelinePrepared.d.ts

@@ -8,7 +8,7 @@ export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
  * TODO: [🔼] Export via core or utils
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
- *     - Is context in each template
- *     - Are samples prepared
- *     - Are templates prepared
+ *     - [🏍] ? Is context in each template
+ *     - [♨] Are samples prepared
+ *     - [♨] Are templates prepared
  */

package/esm/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/esm/typings/src/prepare/prepareTemplates.d.ts

@@ -21,7 +21,7 @@ export {};
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: !!!!! Index the samples and maybe templates
+ * TODO: [♨] !!! Prepare index the samples and maybe templates
  * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch

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

@@ -91,7 +91,7 @@ export type CommonModelRequirements = {
     readonly maxTokens?: number;
 };
 /**
- * TODO: [🔼] !!!! Export all from `@promptbook/types`
+ * TODO: [🔼] !!!!! (<- To all [🔼]) Export all from `@promptbook/types`
  * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
  * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
  *       [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)

package/esm/typings/src/utils/extractParameterNames.d.ts

@@ -7,6 +7,3 @@ import type { string_template } from '../types/typeAliases';
  * @returns the list of parameter names
  */
 export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;
-/**
- * TODO: !!!!! Rename to extractParameterNames
- */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.61.0-26",
+    "version": "0.61.0-28",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.61.0-26"
+        "@promptbook/core": "0.61.0-28"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -212,13 +212,13 @@
     }());
     /**
      * 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
      */
 
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.61.0-25';
+    var PROMPTBOOK_VERSION = '0.61.0-27';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;

package/umd/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -43,6 +43,5 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
 export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json pipelines
  * Note: [🟢] This code should never be published outside of `@pipeline/node`
  */

package/umd/typings/src/conversion/utils/stringifyPipelineJson.d.ts

@@ -7,7 +7,7 @@ import type { string_json } from '../../types/typeAliases';
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**
- * TODO: !!!! Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
  * TODO: [🍙] Make some standart order of json properties

package/umd/typings/src/conversion/validation/validatePipeline.d.ts

@@ -26,11 +26,11 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🧠][🐣] !!!! Validate that all samples match expectations
- * TODO: [🧠][🐣] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🧠][🐣] !!!! Validate that persona can be used only with CHAT variant
- * TODO: !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: !!!! Validate that reserved parameter is not used as joker
- * TODO: [🧠] !!! Validationg not only logic itself but imports around - files and websites and rerefenced pipelines exists
+ * TODO: [🐣] !!!! Validate that all samples match expectations
+ * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

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

@@ -48,5 +48,5 @@ export type PipelineExecutorResult = {
 };
 /**
  * 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
  */

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

@@ -47,8 +47,8 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
- * TODO: !!!! return `preparedPipeline` from execution
- * TODO: !!!! `isNotPreparedWarningSupressed`
+ * 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
@@ -57,5 +57,5 @@ export {};
  * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
  * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- * TODO: [💷] !!!! `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result
+ * TODO: [🧠][💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result BUT maybe NOT to preserve pure JSON object
  */

package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -41,7 +41,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: !!!! [🍆] JSON mode
+ * TODO:  [🍆] JSON mode
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError

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/isPipelinePrepared.d.ts

@@ -8,7 +8,7 @@ export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
  * TODO: [🔼] Export via core or utils
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
- *     - Is context in each template
- *     - Are samples prepared
- *     - Are templates prepared
+ *     - [🏍] ? Is context in each template
+ *     - [♨] Are samples prepared
+ *     - [♨] Are templates prepared
  */

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/prepare/prepareTemplates.d.ts

@@ -21,7 +21,7 @@ export {};
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: !!!!! Index the samples and maybe templates
+ * TODO: [♨] !!! Prepare index the samples and maybe templates
  * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch

package/umd/typings/src/types/ModelRequirements.d.ts

@@ -91,7 +91,7 @@ export type CommonModelRequirements = {
     readonly maxTokens?: number;
 };
 /**
- * TODO: [🔼] !!!! Export all from `@promptbook/types`
+ * TODO: [🔼] !!!!! (<- To all [🔼]) Export all from `@promptbook/types`
  * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
  * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
  *       [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)

package/umd/typings/src/utils/extractParameterNames.d.ts

@@ -7,6 +7,3 @@ import type { string_template } from '../types/typeAliases';
  * @returns the list of parameter names
  */
 export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;
-/**
- * TODO: !!!!! Rename to extractParameterNames
- */