@promptbook/openai 0.32.5 → 0.33.0-1

package/esm/typings/execution/PtpExecutor.d.ts

@@ -13,7 +13,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export interface PtpExecutor {
-    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+    (inputParameters: Record<string_name, string | Array<string>>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
          * Whether the execution was successful
          */
@@ -31,7 +31,7 @@ export interface PtpExecutor {
          *
          * Note: If the execution was not successful, there are only some of the result parameters
          */
-        outputParameters: Record<string_name, string>;
+        outputParameters: Record<string_name, string | Array<string>>;
     }>;
 }
 /**

package/esm/typings/types/Command.d.ts

@@ -6,7 +6,7 @@ import type { ExpectationAmount, ExpectationUnit } from './PromptTemplatePipelin
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | SplitCommand | JoinCommand | ExpectCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -65,12 +65,25 @@ export interface ParameterCommand {
 }
 /**
  * Postprocess command describes which function to use for postprocessing
- * This will be created as separate EXECUTE SCRIPT block bellow
  */
 export interface PostprocessCommand {
     readonly type: 'POSTPROCESS';
     readonly functionName: string_name;
 }
+/**
+ * Split command describes which function to use for split postprocessing
+ */
+export interface SplitCommand {
+    readonly type: 'SPLIT';
+    readonly functionName: string_name;
+}
+/**
+ * Join command describes which function to use for join postprocessing
+ */
+export interface JoinCommand {
+    readonly type: 'JOIN';
+    readonly functionName: string_name;
+}
 /**
  * Expect command describes the desired output of the prompt template (after post-processing)
  * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.

package/esm/typings/types/PromptTemplatePipelineJson/PromptTemplateJson.d.ts

@@ -85,6 +85,13 @@ interface PromptTemplateJsonCommon {
      * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
      */
     readonly jokers?: Array<string>;
+    /**
+     * Iterate through following array parameters
+     */
+    readonly iterators?: Array<{
+        parameterName: string_name;
+        indexName: string_name;
+    }>;
     /**
      * Type of the execution
      * This determines if the prompt template is send to LLM, user or some scripting evaluation
@@ -98,6 +105,14 @@ interface PromptTemplateJsonCommon {
      * List of postprocessing steps that are executed after the prompt template
      */
     readonly postprocessing?: Array<string_javascript_name>;
+    /**
+     * Split postprocessing function
+     */
+    readonly split?: string_javascript_name;
+    /**
+     * Join postprocessing function
+     */
+    readonly join?: string_javascript_name;
     /**
      * Expect this amount of each unit in the answer
      *

package/esm/typings/types/PromptTemplatePipelineJson/PromptTemplateParameterJson.d.ts

@@ -9,6 +9,12 @@ export interface PromptTemplateParameterJson {
      * - It should start lowercase and contain letters and numbers
      */
     readonly name: string_name;
+    /**
+     * The type of the parameter
+     *
+     * - 'LIST' means `Array<string>`
+     */
+    readonly type: 'string' | 'list';
     /**
      * The parameter is input of the pipeline
      *

package/esm/typings/utils/extractParameters.d.ts

@@ -7,4 +7,7 @@ import { string_name, string_template } from '../types/typeAliases';
  *
  * @private within the library
  */
-export declare function extractParameters(template: string_template): Array<string_name>;
+export declare function extractParameters(template: string_template): Array<{
+    parameterName: string_name;
+    indexName?: string_name;
+}>;

package/esm/typings/utils/iterateListParameters.d.ts

@@ -0,0 +1,8 @@
+import { string_javascript_name } from '../types/typeAliases';
+/**
+ * Iterates over nested for loops from 0 to i-1, j-1, k-1, ...
+ * Each index add new dimension of the iteration
+ *
+ * @private within the library
+ */
+export declare function iterateListParameters<TIndexes extends Record<string_javascript_name, number>>(indexRangeValues: TIndexes): Generator<TIndexes>;

package/esm/typings/utils/iterateListParameters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/utils/postprocessing/test/assertsPostprocessingFunctionIsWorking.d.ts

@@ -0,0 +1,6 @@
+export declare function assertsPostprocessingFunctionIsWorking(): void;
+/**
+ * TODO: !!!! Use
+ * TODO: !!!! Export to utils
+ * TODO: !!!! Annotate
+ */ 

package/esm/typings/utils/postprocessing/test/postprocessing.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/utils/postprocessing-splitters/test/assertsSplitterFunctionIsWorking.d.ts

@@ -0,0 +1,6 @@
+export declare function assertsSplitterFunctionIsWorking(): void;
+/**
+ * TODO: !!!! Use
+ * TODO: !!!! Export to utils
+ * TODO: !!!! Annotate
+ */ 

package/esm/typings/utils/postprocessing-splitters/test/postprocessing-splitters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.32.5",
+    "version": "0.33.0-1",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -37,7 +37,7 @@
         "openai": "4.2.0"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.32.5"
+        "@promptbook/core": "0.33.0-1"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/execution/PtpExecutor.d.ts

@@ -13,7 +13,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export interface PtpExecutor {
-    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+    (inputParameters: Record<string_name, string | Array<string>>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
          * Whether the execution was successful
          */
@@ -31,7 +31,7 @@ export interface PtpExecutor {
          *
          * Note: If the execution was not successful, there are only some of the result parameters
          */
-        outputParameters: Record<string_name, string>;
+        outputParameters: Record<string_name, string | Array<string>>;
     }>;
 }
 /**

package/umd/typings/types/Command.d.ts

@@ -6,7 +6,7 @@ import type { ExpectationAmount, ExpectationUnit } from './PromptTemplatePipelin
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | SplitCommand | JoinCommand | ExpectCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -65,12 +65,25 @@ export interface ParameterCommand {
 }
 /**
  * Postprocess command describes which function to use for postprocessing
- * This will be created as separate EXECUTE SCRIPT block bellow
  */
 export interface PostprocessCommand {
     readonly type: 'POSTPROCESS';
     readonly functionName: string_name;
 }
+/**
+ * Split command describes which function to use for split postprocessing
+ */
+export interface SplitCommand {
+    readonly type: 'SPLIT';
+    readonly functionName: string_name;
+}
+/**
+ * Join command describes which function to use for join postprocessing
+ */
+export interface JoinCommand {
+    readonly type: 'JOIN';
+    readonly functionName: string_name;
+}
 /**
  * Expect command describes the desired output of the prompt template (after post-processing)
  * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.

package/umd/typings/types/PromptTemplatePipelineJson/PromptTemplateJson.d.ts

@@ -85,6 +85,13 @@ interface PromptTemplateJsonCommon {
      * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
      */
     readonly jokers?: Array<string>;
+    /**
+     * Iterate through following array parameters
+     */
+    readonly iterators?: Array<{
+        parameterName: string_name;
+        indexName: string_name;
+    }>;
     /**
      * Type of the execution
      * This determines if the prompt template is send to LLM, user or some scripting evaluation
@@ -98,6 +105,14 @@ interface PromptTemplateJsonCommon {
      * List of postprocessing steps that are executed after the prompt template
      */
     readonly postprocessing?: Array<string_javascript_name>;
+    /**
+     * Split postprocessing function
+     */
+    readonly split?: string_javascript_name;
+    /**
+     * Join postprocessing function
+     */
+    readonly join?: string_javascript_name;
     /**
      * Expect this amount of each unit in the answer
      *

package/umd/typings/types/PromptTemplatePipelineJson/PromptTemplateParameterJson.d.ts

@@ -9,6 +9,12 @@ export interface PromptTemplateParameterJson {
      * - It should start lowercase and contain letters and numbers
      */
     readonly name: string_name;
+    /**
+     * The type of the parameter
+     *
+     * - 'LIST' means `Array<string>`
+     */
+    readonly type: 'string' | 'list';
     /**
      * The parameter is input of the pipeline
      *

package/umd/typings/utils/extractParameters.d.ts

@@ -7,4 +7,7 @@ import { string_name, string_template } from '../types/typeAliases';
  *
  * @private within the library
  */
-export declare function extractParameters(template: string_template): Array<string_name>;
+export declare function extractParameters(template: string_template): Array<{
+    parameterName: string_name;
+    indexName?: string_name;
+}>;

package/umd/typings/utils/iterateListParameters.d.ts

@@ -0,0 +1,8 @@
+import { string_javascript_name } from '../types/typeAliases';
+/**
+ * Iterates over nested for loops from 0 to i-1, j-1, k-1, ...
+ * Each index add new dimension of the iteration
+ *
+ * @private within the library
+ */
+export declare function iterateListParameters<TIndexes extends Record<string_javascript_name, number>>(indexRangeValues: TIndexes): Generator<TIndexes>;

package/umd/typings/utils/iterateListParameters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/utils/postprocessing/test/assertsPostprocessingFunctionIsWorking.d.ts

@@ -0,0 +1,6 @@
+export declare function assertsPostprocessingFunctionIsWorking(): void;
+/**
+ * TODO: !!!! Use
+ * TODO: !!!! Export to utils
+ * TODO: !!!! Annotate
+ */ 

package/umd/typings/utils/postprocessing/test/postprocessing.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/utils/postprocessing-splitters/test/assertsSplitterFunctionIsWorking.d.ts

@@ -0,0 +1,6 @@
+export declare function assertsSplitterFunctionIsWorking(): void;
+/**
+ * TODO: !!!! Use
+ * TODO: !!!! Export to utils
+ * TODO: !!!! Annotate
+ */ 

package/umd/typings/utils/postprocessing-splitters/test/postprocessing-splitters.test.d.ts

@@ -0,0 +1 @@
+export {};