@promptbook/core 0.80.0-0 → 0.80.0

package/README.md

@@ -23,10 +23,6 @@
 
 
 
-<blockquote style="color: #ff8811">
-    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
-</blockquote>
-
 ## 📦 Package `@promptbook/core`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).

package/esm/index.es.js

@@ -23,7 +23,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.79.0';
+var PROMPTBOOK_ENGINE_VERSION = '0.80.0-1';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1514,6 +1514,7 @@ function extractParameterNames(template) {
 /**
  * Unprepare just strips the preparation data of the pipeline
  *
+ * @deprecated In future version this function will be removed or deprecated
  * @public exported from `@promptbook/core`
  */
 function unpreparePipeline(pipeline) {
@@ -7712,7 +7713,7 @@ var parameterCommandParser = {
      * Note: `$` is used to indicate that this function mutates given `pipelineJson`
      */
     $applyToPipelineJson: function (command, $pipelineJson) {
-        // Note: [🍣] Do nothing, its application is implemented separately in `pipelineStringToJsonSync`
+        // Note: [🍣] Do nothing, its application is implemented separately in `precompilePipeline`
     },
     /**
      * Apply the PARAMETER command to the `pipelineJson`
@@ -7720,7 +7721,7 @@ var parameterCommandParser = {
      * Note: `$` is used to indicate that this function mutates given `taskJson`
      */
     $applyToTaskJson: function (command, $taskJson, $pipelineJson) {
-        // Note: [🍣] Do nothing, its application is implemented separately in `pipelineStringToJsonSync`
+        // Note: [🍣] Do nothing, its application is implemented separately in `precompilePipeline`
     },
     /**
      * Converts the PARAMETER command back to string
@@ -8228,7 +8229,7 @@ var COMMANDS = [
  * @returns the parser for the command
  * @throws {UnexpectedError} if the parser is not found
  *
- * @private within the pipelineStringToJson
+ * @private within the compilePipeline
  */
 function getParserForCommand(command) {
     var commandParser = COMMANDS.find(function (commandParser) { return commandParser.name === command.type; });
@@ -8264,7 +8265,7 @@ function removeMarkdownFormatting(str) {
  * @returns parsed command object
  * @throws {ParseError} if the command is invalid
  *
- * @private within the pipelineStringToJson
+ * @private within the compilePipeline
  */
 function parseCommand(raw, usagePlace) {
     if (raw.includes('\n') || raw.includes('\r')) {
@@ -8679,7 +8680,7 @@ var QuickChatbotHla = {
 /**
  * All high-level abstractions
  *
- * @private internal index of `pipelineStringToJsonSync` (= used for sync) and `preparePipeline` (= used for async)
+ * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
  */
 var HIGH_LEVEL_ABSTRACTIONS = [
     ImplicitFormfactorHla,
@@ -8953,8 +8954,8 @@ function titleToName(value) {
  * Compile pipeline from string (markdown) format to JSON format synchronously
  *
  * Note: There are 3 similar functions:
- * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -8965,7 +8966,7 @@ function titleToName(value) {
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-function pipelineStringToJsonSync(pipelineString) {
+function precompilePipeline(pipelineString) {
     var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e, e_6, _f;
     var $pipelineJson = {
         title: DEFAULT_TITLE,
@@ -9385,7 +9386,7 @@ function pipelineStringToJsonSync(pipelineString) {
     // TODO: [🍙] Maybe do reorder of `$pipelineJson` here
     return exportJson({
         name: 'pipelineJson',
-        message: "Result of `pipelineStringToJsonSync`",
+        message: "Result of `precompilePipeline`",
         order: ORDER_OF_PIPELINE_JSON,
         value: __assign({ formfactorName: 'GENERIC' }, $pipelineJson),
     });
@@ -9406,8 +9407,8 @@ function pipelineStringToJsonSync(pipelineString) {
  * Compile pipeline from string (markdown) format to JSON format
  *
  * Note: There are 3 similar functions:
- * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -9420,13 +9421,13 @@ function pipelineStringToJsonSync(pipelineString) {
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-function pipelineStringToJson(pipelineString, tools, options) {
+function compilePipeline(pipelineString, tools, options) {
     return __awaiter(this, void 0, void 0, function () {
         var pipelineJson;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    pipelineJson = pipelineStringToJsonSync(pipelineString);
+                    pipelineJson = precompilePipeline(pipelineString);
                     if (!(tools !== undefined && tools.llm !== undefined)) return [3 /*break*/, 2];
                     return [4 /*yield*/, preparePipeline(pipelineJson, tools, options || {
                             rootDirname: null,
@@ -9435,7 +9436,7 @@ function pipelineStringToJson(pipelineString, tools, options) {
                     pipelineJson = _a.sent();
                     _a.label = 2;
                 case 2: 
-                // Note: No need to use `$exportJson` because `pipelineStringToJsonSync` and `preparePipeline` already do that
+                // Note: No need to use `$exportJson` because `precompilePipeline` and `preparePipeline` already do that
                 return [2 /*return*/, pipelineJson];
             }
         });
@@ -9552,7 +9553,7 @@ function prettifyPipelineString(pipelineString, options) {
                 case 0:
                     isGraphAdded = options.isGraphAdded, isPrettifyed = options.isPrettifyed;
                     if (!isGraphAdded) return [3 /*break*/, 2];
-                    return [4 /*yield*/, pipelineStringToJson(pipelineString)];
+                    return [4 /*yield*/, compilePipeline(pipelineString)];
                 case 1:
                     pipelineJson = _a.sent();
                     promptbookMermaid_1 = renderPromptbookMermaid(pipelineJson, {
@@ -11129,5 +11130,5 @@ var PrefixStorage = /** @class */ (function () {
     return PrefixStorage;
 }());
 
-export { $llmToolsMetadataRegister, $llmToolsRegister, $scrapersMetadataRegister, $scrapersRegister, ADMIN_EMAIL, ADMIN_GITHUB_NAME, AbstractFormatError, BOOK_LANGUAGE_VERSION, BlackholeStorage, BoilerplateError, BoilerplateFormfactorDefinition, CLAIM, CallbackInterfaceTools, ChatbotFormfactorDefinition, CollectionError, CsvFormatDefinition, CsvFormatError, DEFAULT_BOOKS_DIRNAME, DEFAULT_CSV_SETTINGS, DEFAULT_EXECUTIONS_CACHE_DIRNAME, DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_AUTO_INSTALLED, DEFAULT_IS_VERBOSE, DEFAULT_MAX_EXECUTION_ATTEMPTS, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, DEFAULT_MAX_PARALLEL_COUNT, DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME, DEFAULT_REMOTE_URL, DEFAULT_REMOTE_URL_PATH, DEFAULT_SCRAPE_CACHE_DIRNAME, DEFAULT_TITLE, EXPECTATION_UNITS, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, ExpectError, FORMFACTOR_DEFINITIONS, GENERIC_PIPELINE_INTERFACE, GeneratorFormfactorDefinition, GenericFormfactorDefinition, KnowledgeScrapeError, LOGO_DARK_SRC, LOGO_LIGHT_SRC, LimitReachedError, MANDATORY_CSV_SETTINGS, MAX_FILENAME_LENGTH, MODEL_VARIANTS, MatcherFormfactorDefinition, MemoryStorage, MissingToolsError, MultipleLlmExecutionTools, NAME, NonTaskSectionTypes, NotFoundError, NotYetImplementedError, ORDER_OF_PIPELINE_JSON, PROMPTBOOK_ENGINE_VERSION, PROMPTBOOK_ERRORS, ParseError, PipelineExecutionError, PipelineLogicError, PipelineUrlError, PrefixStorage, RESERVED_PARAMETER_NAMES, SET_IS_VERBOSE, SectionTypes, SheetsFormfactorDefinition, TaskTypes, TextFormatDefinition, TranslatorFormfactorDefinition, UNCERTAIN_USAGE, UnexpectedError, ZERO_USAGE, _AnthropicClaudeMetadataRegistration, _AzureOpenAiMetadataRegistration, _DocumentScraperMetadataRegistration, _GoogleMetadataRegistration, _LegacyDocumentScraperMetadataRegistration, _MarkdownScraperMetadataRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiMetadataRegistration, _PdfScraperMetadataRegistration, _WebsiteScraperMetadataRegistration, addUsage, assertsExecutionSuccessful, cacheLlmTools, collectionToJson, countTotalUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, getPipelineInterface, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, prepareKnowledgePieces, preparePersona, preparePipeline, prepareTasks, prettifyPipelineString, removePipelineCommand, renamePipelineParameter, stringifyPipelineJson, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline };
+export { $llmToolsMetadataRegister, $llmToolsRegister, $scrapersMetadataRegister, $scrapersRegister, ADMIN_EMAIL, ADMIN_GITHUB_NAME, AbstractFormatError, BOOK_LANGUAGE_VERSION, BlackholeStorage, BoilerplateError, BoilerplateFormfactorDefinition, CLAIM, CallbackInterfaceTools, ChatbotFormfactorDefinition, CollectionError, CsvFormatDefinition, CsvFormatError, DEFAULT_BOOKS_DIRNAME, DEFAULT_CSV_SETTINGS, DEFAULT_EXECUTIONS_CACHE_DIRNAME, DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_AUTO_INSTALLED, DEFAULT_IS_VERBOSE, DEFAULT_MAX_EXECUTION_ATTEMPTS, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, DEFAULT_MAX_PARALLEL_COUNT, DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME, DEFAULT_REMOTE_URL, DEFAULT_REMOTE_URL_PATH, DEFAULT_SCRAPE_CACHE_DIRNAME, DEFAULT_TITLE, EXPECTATION_UNITS, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, ExpectError, FORMFACTOR_DEFINITIONS, GENERIC_PIPELINE_INTERFACE, GeneratorFormfactorDefinition, GenericFormfactorDefinition, KnowledgeScrapeError, LOGO_DARK_SRC, LOGO_LIGHT_SRC, LimitReachedError, MANDATORY_CSV_SETTINGS, MAX_FILENAME_LENGTH, MODEL_VARIANTS, MatcherFormfactorDefinition, MemoryStorage, MissingToolsError, MultipleLlmExecutionTools, NAME, NonTaskSectionTypes, NotFoundError, NotYetImplementedError, ORDER_OF_PIPELINE_JSON, PROMPTBOOK_ENGINE_VERSION, PROMPTBOOK_ERRORS, ParseError, PipelineExecutionError, PipelineLogicError, PipelineUrlError, PrefixStorage, RESERVED_PARAMETER_NAMES, SET_IS_VERBOSE, SectionTypes, SheetsFormfactorDefinition, TaskTypes, TextFormatDefinition, TranslatorFormfactorDefinition, UNCERTAIN_USAGE, UnexpectedError, ZERO_USAGE, _AnthropicClaudeMetadataRegistration, _AzureOpenAiMetadataRegistration, _DocumentScraperMetadataRegistration, _GoogleMetadataRegistration, _LegacyDocumentScraperMetadataRegistration, _MarkdownScraperMetadataRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiMetadataRegistration, _PdfScraperMetadataRegistration, _WebsiteScraperMetadataRegistration, addUsage, assertsExecutionSuccessful, cacheLlmTools, collectionToJson, compilePipeline, countTotalUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, getPipelineInterface, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, pipelineJsonToString, precompilePipeline, prepareKnowledgePieces, preparePersona, preparePipeline, prepareTasks, prettifyPipelineString, removePipelineCommand, renamePipelineParameter, stringifyPipelineJson, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline };
 //# sourceMappingURL=index.es.js.map