@promptbook/openai 0.67.9 → 0.68.0-1

package/esm/typings/src/prepare/prepareTemplates.d.ts

@@ -1,7 +1,7 @@
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PromptTemplateJson } from '../types/PipelineJson/PromptTemplateJson';
+import type { TemplateJson } from '../types/PipelineJson/TemplateJson';
 import type { PrepareOptions } from './PrepareOptions';
-type PrepareTemplateInput = Pick<PipelineJson, 'promptTemplates' | 'parameters'> & {
+type PrepareTemplateInput = Pick<PipelineJson, 'templates' | 'parameters'> & {
     /**
      * @@@
      */
@@ -11,7 +11,7 @@ type PreparedTemplates = {
     /**
      * @@@ Sequence of prompt templates that are chained together to form a pipeline
      */
-    readonly promptTemplatesPrepared: Array<PromptTemplateJson>;
+    readonly templatesPrepared: Array<TemplateJson>;
 };
 /**
  * @@@
@@ -28,5 +28,4 @@ export {};
  * 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/esm/typings/src/prepare/unpreparePipeline.d.ts

@@ -8,5 +8,5 @@ export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
 /**
  * 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
+ * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -1,4 +1,4 @@
-import { Promisable } from 'type-fest';
+import type { Promisable } from 'type-fest';
 /**
  * Storage of objects with asynchronous API
  *

package/esm/typings/src/storage/utils/PrefixStorage.d.ts

@@ -1,4 +1,4 @@
-import { Promisable } from 'type-fest';
+import type { Promisable } from 'type-fest';
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 /**
  * This class behaves like LocalStorage but separates keys by prefix

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

@@ -52,6 +52,8 @@ export type EmbeddingModelRequirements = CommonModelRequirements & {
  * Common properties for all model requirements variants
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the model requirements
  */
 export type CommonModelRequirements = {
     /**

package/esm/typings/src/types/PipelineJson/DialogTemplateJson.d.ts

@@ -0,0 +1,13 @@
+import type { TemplateJsonCommon } from './TemplateJsonCommon';
+/**
+ * Template for prompt to user
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/76
+ */
+export type DialogTemplateJson = TemplateJsonCommon & {
+    readonly blockType: 'DIALOG_TEMPLATE';
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/types/PipelineJson/Expectations.d.ts

@@ -36,5 +36,5 @@ export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTEN
  */
 export type ExpectationAmount = number_integer & (number_positive | 0);
 /**
- * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
+ * TODO: [💝] Unite object for expecting amount and format - remove format
  */

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

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

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

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

package/esm/typings/src/types/PipelineJson/{PromptTemplateParameterJson.d.ts → ParameterJson.d.ts}

@@ -6,7 +6,7 @@ import type { string_parameter_value } from '../typeAliases';
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptTemplateParameterJson = {
+export type ParameterJson = {
     /**
      * Name of the parameter
      * - It must be unique across the pipeline
@@ -34,5 +34,5 @@ export type PromptTemplateParameterJson = {
 };
 /**
  * TODO: [♈] Probbably move expectations from templates to parameters
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

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

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

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

@@ -1,3 +1,4 @@
+import type { ModelRequirements } from '../ModelRequirements';
 import type { string_file_path } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
@@ -5,11 +6,11 @@ import type { string_semantic_version } from '../typeAliases';
 import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
 import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
 import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
+import type { ParameterJson } from './ParameterJson';
 import type { PersonaJson } from './PersonaJson';
 import type { PersonaPreparedJson } from './PersonaJson';
 import type { PreparationJson } from './PreparationJson';
-import type { PromptTemplateJson } from './PromptTemplateJson';
-import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
+import type { TemplateJson } from './TemplateJson';
 /**
  * Promptbook is the **core concept of this package**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
@@ -50,11 +51,15 @@ export type PipelineJson = {
     /**
      * Set of variables that are used across the pipeline
      */
-    readonly parameters: Array<PromptTemplateParameterJson>;
+    readonly parameters: Array<ParameterJson>;
+    /**
+     * Default model requirements for the model for all `templates`
+     */
+    readonly defaultModelRequirements?: Partial<ModelRequirements>;
     /**
      * Sequence of prompt templates that are chained together to form a pipeline
      */
-    readonly promptTemplates: Array<PromptTemplateJson>;
+    readonly templates: Array<TemplateJson>;
     /**
      * Set of information that are used as external knowledge in the pipeline
      *
@@ -81,7 +86,7 @@ export type PipelineJson = {
     readonly preparations: Array<PreparationJson>;
 };
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard 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/esm/typings/src/types/PipelineJson/PreparationJson.d.ts

@@ -16,7 +16,7 @@ export type PreparationJson = {
     readonly usage: PromptResultUsage;
 };
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard 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/esm/typings/src/types/PipelineJson/PromptTemplateJson.d.ts

@@ -1,15 +1,26 @@
-import type { ___ } from '../../utils/organization/___';
-import type { LlmTemplateJson } from './LlmTemplateJson';
-import type { PromptDialogJson } from './PromptDialogJson';
-import type { ScriptJson } from './ScriptJson';
-import type { SimpleTemplateJson } from './SimpleTemplateJson';
+import type { ModelRequirements } from '../ModelRequirements';
+import type { string_name } from '../typeAliases';
+import type { TemplateJsonCommon } from './TemplateJsonCommon';
 /**
- * Describes one prompt template in the promptbook
+ * Template for prompt to LLM
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
+export type PromptTemplateJson = TemplateJsonCommon & {
+    readonly blockType: 'PROMPT_TEMPLATE';
+    /**
+     * Name of the persona who will be responding to this prompt
+     */
+    readonly personaName?: string_name;
+    /**
+     * Requirements for the model
+     * - This is required only for blockType PROMPT_TEMPLATE
+     */
+    readonly modelRequirements?: Partial<ModelRequirements>;
+};
 /**
- * TODO: [🧠][🥜] What is propper name for this - "Template", "Prompt template",...
- * TODO: [🧠][🥜] Reduce confusion of `PromptTemplateJson` vs (`LlmTemplateJson` which is 'PROMPT_TEMPLATE')
+ * 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 standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/{ScriptJson.d.ts → ScriptTemplateJson.d.ts}

@@ -1,13 +1,13 @@
 import type { ScriptLanguage } from '../ScriptLanguage';
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+import type { TemplateJsonCommon } from './TemplateJsonCommon';
 /**
  * Template for script execution
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/77
  */
-export type ScriptJson = PromptTemplateJsonCommon & {
-    readonly blockType: 'SCRIPT';
+export type ScriptTemplateJson = TemplateJsonCommon & {
+    readonly blockType: 'SCRIPT_TEMPLATE';
     /**
      * Language of the script
      * - This is required only for blockType SCRIPT
@@ -16,5 +16,5 @@ export type ScriptJson = PromptTemplateJsonCommon & {
     readonly contentLanguage?: ScriptLanguage;
 };
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -1,13 +1,13 @@
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+import type { TemplateJsonCommon } from './TemplateJsonCommon';
 /**
  * Template for simple concatenation of strings
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/17
  */
-export type SimpleTemplateJson = PromptTemplateJsonCommon & {
+export type SimpleTemplateJson = TemplateJsonCommon & {
     readonly blockType: 'SIMPLE_TEMPLATE';
 };
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/TemplateJson.d.ts

@@ -0,0 +1,11 @@
+import type { ___or___ } from '../../utils/organization/___or___';
+import type { DialogTemplateJson } from './DialogTemplateJson';
+import type { PromptTemplateJson } from './PromptTemplateJson';
+import type { ScriptTemplateJson } from './ScriptTemplateJson';
+import type { SimpleTemplateJson } from './SimpleTemplateJson';
+/**
+ * Describes one (prompt) template in the promptbook
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type TemplateJson = PromptTemplateJson | SimpleTemplateJson | ScriptTemplateJson | DialogTemplateJson | ___or___ | ___or___;

package/esm/typings/src/types/PipelineJson/{PromptTemplateJsonCommon.d.ts → TemplateJsonCommon.d.ts}

@@ -1,5 +1,5 @@
 import type { BlockType } from '../../commands/BLOCK/BlockTypes';
-import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
+import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
 import type { string_javascript } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
@@ -12,7 +12,7 @@ import type { Expectations } from './Expectations';
 /**
  * Common properties of all prompt templates
  */
-export interface PromptTemplateJsonCommon {
+export interface TemplateJsonCommon {
     /**
      * Name of the template
      * - It must be unique across the pipeline
@@ -83,14 +83,13 @@ export interface PromptTemplateJsonCommon {
      * @see https://github.com/webgptorg/promptbook/discussions/30
      * @deprecated [💝]
      */
-    readonly expectFormat?: ExpectFormatCommand['format'];
+    readonly format?: FormatCommand['format'];
     /**
      * Name of the parameter that is the result of the prompt template
      */
     readonly resultingParameterName: string_name;
 }
 /**
- * TODO: [🧠][🥜]
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  * TODO: [♈] Probbably move expectations from templates to parameters
  */

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

@@ -1,4 +1,4 @@
-import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
+import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
 import type { ChatModelRequirements } from './ModelRequirements';
 import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
@@ -54,6 +54,8 @@ export type EmbeddingPrompt = CommonPrompt & {
  * Common properties for all prompt results
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the prompts
  */
 export type CommonPrompt = {
     /**
@@ -89,7 +91,7 @@ export type CommonPrompt = {
      * Note: Expectations are performed after all postprocessing steps
      * @deprecated [💝]
      */
-    readonly expectFormat?: ExpectFormatCommand['format'];
+    readonly format?: FormatCommand['format'];
     /**
      * Unique identifier of the pipeline with specific template name as hash
      *

package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts

@@ -10,5 +10,6 @@ export declare function addAutoGeneratedSection(content: string_markdown, option
     readonly sectionContent: string_markdown;
 }): string_markdown;
 /**
+ * TODO: !!!!!! Somw way how to connect this with commands
  * TODO: [🏛] This can be part of markdown builder
  */

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -27,7 +27,7 @@ export type CodeBlock = {
  *
  * @param markdown any valid markdown
  * @returns code blocks with language and content
- * @throws {ParsingError} if block is not closed properly
+ * @throws {ParseError} if block is not closed properly
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;

package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -3,7 +3,7 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
 /**
  * Extracts exactly ONE code block from markdown.
  *
- * - When there are multiple or no code blocks the function throws a `ParsingError`
+ * - When there are multiple or no code blocks the function throws a `ParseError`
  *
  * Note: There are multiple simmilar function:
  * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
@@ -14,7 +14,7 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  * @param markdown any valid markdown
  * @returns code block with language and content
  * @public exported from `@promptbook/markdown-utils`
- * @throws {ParsingError} if there is not exactly one code block in the markdown
+ * @throws {ParseError} if there is not exactly one code block in the markdown
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***

package/esm/typings/src/utils/organization/___and___.d.ts

@@ -0,0 +1,7 @@
+import type { really_unknown } from './really_unknown';
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ *
+ * @private within the repository
+ */
+export type ___and___ = really_unknown;

package/esm/typings/src/utils/organization/{___.d.ts → ___or___.d.ts}

@@ -3,4 +3,4 @@
  *
  * @private within the repository
  */
-export type ___ = never;
+export type ___or___ = never;

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

@@ -5,7 +5,7 @@
  * Note: it also works only with decimal numbers
  *
  * @returns parsed number
- * @throws {ParsingError} if the value is not a number
+ * @throws {ParseError} if the value is not a number
  *
  * @public exported from `@promptbook/utils`
  */

package/esm/typings/src/utils/serialization/clonePipeline.d.ts

@@ -9,5 +9,5 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
  */
 export declare function clonePipeline(pipeline: PipelineJson): PipelineJson;
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.67.9",
+    "version": "0.68.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.67.9"
+        "@promptbook/core": "0.68.0-1"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -14,7 +14,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.67.8';
+    var PROMPTBOOK_VERSION = '0.68.0-0';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -1361,14 +1361,14 @@
          */
         OpenAiExecutionTools.prototype.callChatModel = function (prompt) {
             return __awaiter(this, void 0, void 0, function () {
-                var content, parameters, modelRequirements, expectFormat, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+                var content, parameters, modelRequirements, format, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
                             if (this.options.isVerbose) {
                                 console.info('💬 OpenAI callChatModel call', { prompt: prompt });
                             }
-                            content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements, expectFormat = prompt.expectFormat;
+                            content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements, format = prompt.format;
                             return [4 /*yield*/, this.getClient()];
                         case 1:
                             client = _a.sent();
@@ -1385,7 +1385,7 @@
                                 // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
                                 // <- Note: [🧆]
                             };
-                            if (expectFormat === 'JSON') {
+                            if (format === 'JSON') {
                                 modelSettings.response_format = {
                                     type: 'json_object',
                                 };