@promptbook/openai 0.53.0 → 0.54.1

package/README.md

@@ -612,7 +612,7 @@ There are [postprocessing functions](#postprocessing-functions) that can be used
 Executor is a simple async function that takes **input parameters** and returns **output parameters**.
 It is constructed by combining execution tools and promptbook to execute together.
 
-### 🃏 Jokers
+### 🃏 Jokers (conditions) 
 
 Joker is a previously defined parameter that is used to bypass some parts of the pipeline.
 If the joker is present in the template, it is checked to see if it meets the requirements (without postprocessing), and if so, it is used instead of executing that prompt template. There can be multiple wildcards in a prompt template, if so they are checked in order and the first one that meets the requirements is used.

package/esm/typings/_packages/core.index.d.ts

@@ -2,6 +2,15 @@ import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptb
 import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
 import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
 import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
+import { ExpectError } from '../errors/_ExpectError';
+import { PromptbookExecutionError } from '../errors/PromptbookExecutionError';
+import { PromptbookLibraryError } from '../errors/PromptbookLibraryError';
+import { PromptbookLogicError } from '../errors/PromptbookLogicError';
+import { PromptbookNotFoundError } from '../errors/PromptbookNotFoundError';
+import { PromptbookReferenceError } from '../errors/PromptbookReferenceError';
+import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
+import { TemplateError } from '../errors/TemplateError';
+import { UnexpectedError } from '../errors/UnexpectedError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
@@ -27,3 +36,4 @@ export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
+export { ExpectError, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, TemplateError, UnexpectedError, };

package/esm/typings/_packages/types.index.d.ts

@@ -23,6 +23,5 @@ import type { client_id, string_char, string_chat_prompt, string_completion_prom
 import { FromtoItems } from '../utils/FromtoItems';
 export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
- * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -3,6 +3,7 @@ import type { ExecutionType } from '../ExecutionTypes';
 import type { ModelRequirements } from '../ModelRequirements';
 import type { ScriptLanguage } from '../ScriptLanguage';
 import type { number_integer } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
 import type { number_positive_or_zero } from '../typeAliases';
 import type { string_javascript } from '../typeAliases';
 import type { string_javascript_name } from '../typeAliases';
@@ -92,7 +93,7 @@ interface PromptTemplateJsonCommon {
      * Description of the prompt template
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
      *

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

@@ -1,3 +1,4 @@
+import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
@@ -21,5 +22,5 @@ export type PromptTemplateParameterJson = {
      * Description of the parameter
      * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
 };

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

@@ -1,3 +1,4 @@
+import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 import type { PromptTemplateJson } from './PromptTemplateJson';
@@ -23,7 +24,7 @@ export type PromptbookJson = {
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly title: string;
+    readonly title: string_markdown_text;
     /**
      * Version of the .ptbk.json file
      */
@@ -32,7 +33,7 @@ export type PromptbookJson = {
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * Set of variables that are used across the pipeline
      */

package/esm/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -1,5 +1,6 @@
 import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
+import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 /**
@@ -32,7 +33,7 @@ export type ExecutionReportJson = {
     /**
      * Description of the promptbook which was executed
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * Sequence of prompt templates in order which were executed
      */

package/package.json

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

package/umd/typings/_packages/core.index.d.ts

@@ -2,6 +2,15 @@ import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptb
 import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
 import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
 import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
+import { ExpectError } from '../errors/_ExpectError';
+import { PromptbookExecutionError } from '../errors/PromptbookExecutionError';
+import { PromptbookLibraryError } from '../errors/PromptbookLibraryError';
+import { PromptbookLogicError } from '../errors/PromptbookLogicError';
+import { PromptbookNotFoundError } from '../errors/PromptbookNotFoundError';
+import { PromptbookReferenceError } from '../errors/PromptbookReferenceError';
+import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
+import { TemplateError } from '../errors/TemplateError';
+import { UnexpectedError } from '../errors/UnexpectedError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
@@ -27,3 +36,4 @@ export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
+export { ExpectError, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, TemplateError, UnexpectedError, };

package/umd/typings/_packages/types.index.d.ts

@@ -23,6 +23,5 @@ import type { client_id, string_char, string_chat_prompt, string_completion_prom
 import { FromtoItems } from '../utils/FromtoItems';
 export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
- * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -3,6 +3,7 @@ import type { ExecutionType } from '../ExecutionTypes';
 import type { ModelRequirements } from '../ModelRequirements';
 import type { ScriptLanguage } from '../ScriptLanguage';
 import type { number_integer } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
 import type { number_positive_or_zero } from '../typeAliases';
 import type { string_javascript } from '../typeAliases';
 import type { string_javascript_name } from '../typeAliases';
@@ -92,7 +93,7 @@ interface PromptTemplateJsonCommon {
      * Description of the prompt template
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
      *

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

@@ -1,3 +1,4 @@
+import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
@@ -21,5 +22,5 @@ export type PromptTemplateParameterJson = {
      * Description of the parameter
      * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
 };

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

@@ -1,3 +1,4 @@
+import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 import type { PromptTemplateJson } from './PromptTemplateJson';
@@ -23,7 +24,7 @@ export type PromptbookJson = {
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly title: string;
+    readonly title: string_markdown_text;
     /**
      * Version of the .ptbk.json file
      */
@@ -32,7 +33,7 @@ export type PromptbookJson = {
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * Set of variables that are used across the pipeline
      */

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

@@ -1,5 +1,6 @@
 import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
+import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 /**
@@ -32,7 +33,7 @@ export type ExecutionReportJson = {
     /**
      * Description of the promptbook which was executed
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * Sequence of prompt templates in order which were executed
      */