@promptbook/openai 0.61.0-22 → 0.61.0-24

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

@@ -13,30 +13,38 @@ import type { PromptResultUsage } from './PromptResultUsage';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
-    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
-        /**
-         * Whether the execution was successful, details are aviable in `executionReport`
-         */
-        readonly isSuccessful: boolean;
-        /**
-         * Added usage of whole execution, detailed usage is aviable in `executionReport`
-         */
-        readonly usage: PromptResultUsage;
-        /**
-         * Errors that occured during the execution, details are aviable in `executionReport`
-         */
-        readonly errors: Array<PipelineExecutionError | Error>;
-        /**
-         * The report of the execution with all details
-         */
-        readonly executionReport: ExecutionReportJson;
-        /**
-         * Result parameters of the execution
-         *
-         * Note: If the execution was not successful, there are only some of the result parameters
-         */
-        readonly outputParameters: Parameters;
-    }>;
+    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+};
+/**
+ * @@@
+ */
+export type PipelineExecutorResult = {
+    /**
+     * Whether the execution was successful, details are aviable in `executionReport`
+     */
+    readonly isSuccessful: boolean;
+    /**
+     * Added usage of whole execution, detailed usage is aviable in `executionReport`
+     */
+    readonly usage: PromptResultUsage;
+    /**
+     * Errors that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly errors: Array<PipelineExecutionError | Error>;
+    /**
+     * Warnings that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly warnings: Array<PipelineExecutionError | Error>;
+    /**
+     * The report of the execution with all details
+     */
+    readonly executionReport: ExecutionReportJson;
+    /**
+     * Result parameters of the execution
+     *
+     * Note: If the execution was not successful, there are only some of the result parameters
+     */
+    readonly outputParameters: Parameters;
 };
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?

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

@@ -24,3 +24,6 @@ export type PromptResultUsage = {
  * Record of all possible measurable units
  */
 export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -7,4 +7,8 @@ export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
  * TODO: [🐠] Maybe base this on `makeValidator`
  * 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
  */

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

@@ -8,7 +8,6 @@ import type { PrepareOptions } from './PrepareOptions';
  */
 export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;
 /**
- * TODO: !!!!! 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/prepare/prepareTemplates.d.ts

@@ -0,0 +1,31 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PromptTemplateJson } from '../types/PipelineJson/PromptTemplateJson';
+import type { PrepareOptions } from './PrepareOptions';
+type PrepareTemplateInput = Pick<PipelineJson, 'promptTemplates' | 'parameters'> & {
+    /**
+     * @@@
+     */
+    readonly knowledgePiecesCount: number;
+};
+type PreparedTemplates = {
+    /**
+     * @@@ Sequence of prompt templates that are chained together to form a pipeline
+     */
+    readonly promptTemplatesPrepared: Array<PromptTemplateJson>;
+};
+/**
+ * @@@
+ */
+export declare function prepareTemplates(pipeline: PrepareTemplateInput, options: PrepareOptions): Promise<PreparedTemplates>;
+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: [🔼] !!! 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
+ * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🧠][🥜]
+ */

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

@@ -5,5 +5,7 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
 /**
  * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
  * TODO: Write tests for `preparePipeline`
+ * TODO: [🍙] Make some standart order of json properties
  */

package/umd/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts

@@ -65,3 +65,6 @@ export type KnowledgePiecePreparedJson = {
      */
     readonly preparationIds: Array<number_id>;
 };
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/umd/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts

@@ -22,3 +22,6 @@ export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
      */
     readonly preparationIds: Array<number_id>;
 };
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/umd/typings/src/types/PipelineJson/LlmTemplateJson.d.ts

@@ -21,4 +21,5 @@ export type LlmTemplateJson = PromptTemplateJsonCommon & {
  * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each template
  *       @see https://github.com/webgptorg/promptbook/discussions/79
  * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [🍙] Make some standart order of json properties
  */

package/umd/typings/src/types/PipelineJson/PersonaJson.d.ts

@@ -36,3 +36,6 @@ export type PersonaPreparedJson = PersonaJson & {
      */
     readonly preparationIds: Array<number_id>;
 };
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -79,6 +79,7 @@ export type PipelineJson = {
     readonly preparations: Array<PreparationJson>;
 };
 /**
+ * TODO: [🍙] Make some standart order of json properties
  * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
  * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
  *       But then immediately reverted back to the single type

package/umd/typings/src/types/PipelineJson/PreparationJson.d.ts

@@ -16,6 +16,7 @@ export type PreparationJson = {
     readonly modelUsage: PromptResultUsage;
 };
 /**
+ * TODO: [🍙] Make some standart order of json properties
  * TODO: Maybe put here used `modelName`
  * TODO: [🍥] When using `date` it changes all samples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
  */

package/umd/typings/src/types/PipelineJson/PromptDialogJson.d.ts

@@ -4,9 +4,10 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
  *
  * @see https://github.com/webgptorg/promptbook/discussions/76
  */
-export interface PromptDialogJson extends PromptTemplateJsonCommon {
+export type PromptDialogJson = PromptTemplateJsonCommon & {
     readonly blockType: 'PROMPT_DIALOG';
-}
+};
 /**
  * TODO: [🧠][🥜]
- */ 
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/umd/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts

@@ -49,8 +49,18 @@ export interface PromptTemplateJsonCommon {
     readonly blockType: BlockType;
     /**
      * Content of the template with {placeholders} for parameters
+     *
+     * @@@ content vs preparedContent
      */
     readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * @@@ Content of the template with {placeholders} for parameters
+     *
+     * @@@ content vs preparedContent
+     *
+     * @default "{content}"
+     */
+    readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
     /**
      * List of postprocessing steps that are executed after the prompt template
      *

package/umd/typings/src/types/PipelineJson/PromptTemplateParameterJson.d.ts

@@ -32,4 +32,5 @@ export type PromptTemplateParameterJson = {
 };
 /**
  * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [🍙] Make some standart order of json properties
  */

package/umd/typings/src/types/PipelineJson/ScriptJson.d.ts

@@ -5,7 +5,7 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
  *
  * @see https://github.com/webgptorg/promptbook/discussions/77
  */
-export interface ScriptJson extends PromptTemplateJsonCommon {
+export type ScriptJson = PromptTemplateJsonCommon & {
     readonly blockType: 'SCRIPT';
     /**
      * Language of the script
@@ -13,4 +13,7 @@ export interface ScriptJson extends PromptTemplateJsonCommon {
      *
      */
     readonly contentLanguage?: ScriptLanguage;
-}
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/umd/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts

@@ -4,6 +4,9 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
  *
  * @see https://github.com/webgptorg/promptbook/discussions/17
  */
-export interface SimpleTemplateJson extends PromptTemplateJsonCommon {
+export type SimpleTemplateJson = PromptTemplateJsonCommon & {
     readonly blockType: 'SIMPLE_TEMPLATE';
-}
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */