@promptbook/types 0.70.0-1 → 0.71.0-12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (233) hide show
  1. package/README.md +31 -58
  2. package/esm/typings/promptbook-collection/index.d.ts +0 -3
  3. package/esm/typings/src/_packages/browser.index.d.ts +3 -1
  4. package/esm/typings/src/_packages/cli.index.d.ts +20 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +45 -15
  6. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  7. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  8. package/esm/typings/src/_packages/markdown-utils.index.d.ts +6 -0
  9. package/esm/typings/src/_packages/node.index.d.ts +14 -6
  10. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  11. package/esm/typings/src/_packages/types.index.d.ts +53 -25
  12. package/esm/typings/src/_packages/utils.index.d.ts +4 -4
  13. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  14. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  15. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  16. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -2
  17. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  18. package/esm/typings/src/cli/cli-commands/test-command.d.ts +13 -0
  19. package/esm/typings/src/cli/main.d.ts +1 -1
  20. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  21. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +11 -6
  22. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  23. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  24. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +3 -7
  25. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  26. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +2 -3
  27. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  28. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  29. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  30. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  31. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  32. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  33. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  34. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  35. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  36. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  37. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  38. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  39. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  40. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  41. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  42. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -4
  43. package/esm/typings/src/config.d.ts +32 -3
  44. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +4 -15
  45. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  46. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -0
  47. package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts +2 -1
  48. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  49. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +10 -5
  50. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
  51. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +3 -3
  52. package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +5 -5
  53. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  54. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  55. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  56. package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
  57. package/esm/typings/src/execution/ExecutionTools.d.ts +20 -8
  58. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  59. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +9 -8
  60. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTemplateResult.d.ts +45 -0
  61. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +23 -0
  62. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +29 -0
  63. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  64. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +58 -0
  65. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +60 -0
  66. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  67. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +69 -0
  68. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  69. package/esm/typings/src/execution/createPipelineExecutor/getContextForTemplate.d.ts +10 -0
  70. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTemplate.d.ts +27 -0
  71. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTemplate.d.ts +30 -0
  72. package/esm/typings/src/execution/createPipelineExecutor/getSamplesForTemplate.d.ts +10 -0
  73. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  74. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +3 -0
  75. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  76. package/esm/typings/src/execution/utils/checkExpectations.d.ts +2 -0
  77. package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -0
  78. package/esm/typings/src/execution/utils/usageToHuman.d.ts +3 -4
  79. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +14 -15
  80. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  81. package/esm/typings/src/formats/csv/{ListFormatDefinition.d.ts → CsvFormatDefinition.d.ts} +6 -3
  82. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  83. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  84. package/esm/typings/src/formats/index.d.ts +1 -1
  85. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +4 -3
  86. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  87. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +4 -3
  88. package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
  89. package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
  90. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
  91. package/esm/typings/src/llm-providers/_common/{getLlmToolsForCli.d.ts → register/$provideLlmToolsForCli.d.ts} +4 -3
  92. package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
  93. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +27 -0
  94. package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
  95. package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +5 -4
  96. package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
  97. package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
  98. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +5 -4
  99. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +1 -1
  100. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -1
  101. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +3 -3
  102. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  103. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +2 -2
  104. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  105. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
  106. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
  107. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +8 -1
  108. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +2 -2
  109. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  110. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
  111. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
  112. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
  113. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +2 -2
  114. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +2 -2
  115. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +1 -0
  116. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
  117. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -1
  118. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +2 -2
  119. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  120. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +4 -3
  121. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +4 -3
  122. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +1 -1
  123. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +1 -1
  124. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +3 -3
  125. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +2 -2
  126. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  127. package/esm/typings/src/personas/preparePersona.d.ts +4 -3
  128. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +68 -0
  129. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +1 -1
  130. package/esm/typings/src/prepare/preparePipeline.d.ts +3 -2
  131. package/esm/typings/src/prepare/prepareTemplates.d.ts +4 -3
  132. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  133. package/esm/typings/src/scrapers/_common/Scraper.d.ts +66 -0
  134. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  135. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +5 -4
  136. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  137. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  138. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
  139. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  140. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  141. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  142. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  143. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +33 -0
  144. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  145. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +13 -0
  146. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  147. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  148. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  149. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  150. package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
  151. package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
  152. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  153. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  154. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  155. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  156. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
  157. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
  158. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  159. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  160. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  161. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
  162. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
  163. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  164. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  165. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  166. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
  167. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
  168. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +47 -0
  169. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  170. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  171. package/esm/typings/src/scrapers/website/register-constructor.d.ts +13 -0
  172. package/esm/typings/src/scrapers/website/register-metadata.d.ts +24 -0
  173. package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +12 -0
  174. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  175. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +2 -2
  176. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +2 -2
  177. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +4 -4
  178. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  179. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +1 -1
  180. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  181. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  182. package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
  183. package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
  184. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +9 -2
  185. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -0
  186. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +3 -3
  187. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +5 -0
  188. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  189. package/esm/typings/src/types/typeAliases.d.ts +16 -12
  190. package/esm/typings/src/utils/$Register.d.ts +19 -6
  191. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  192. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  193. package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts +23 -0
  194. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  195. package/esm/typings/src/utils/expectation-counters/index.d.ts +3 -0
  196. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +3 -3
  197. package/esm/typings/src/utils/files/$isFileExisting.d.ts +3 -3
  198. package/esm/typings/src/utils/files/$listAllFiles.d.ts +5 -4
  199. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  200. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  201. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  202. package/esm/typings/src/utils/organization/{f.d.ts → empty_object.d.ts} +5 -1
  203. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  204. package/esm/typings/src/utils/{extractParameterNames.d.ts → parameters/extractParameterNames.d.ts} +2 -2
  205. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  206. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  207. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  208. package/esm/typings/src/utils/{replaceParameters.d.ts → parameters/replaceParameters.d.ts} +2 -2
  209. package/esm/typings/src/utils/parameters/replaceParameters.test.d.ts +1 -0
  210. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +1 -1
  211. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +1 -1
  212. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  213. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  214. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  215. package/package.json +17 -13
  216. package/esm/typings/src/execution/createPipelineExecutor.d.ts +0 -72
  217. package/esm/typings/src/formats/list/ListFormatDefinition.d.ts +0 -16
  218. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  219. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  220. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  221. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  222. package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts +0 -25
  223. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  224. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  225. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  226. /package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.test.d.ts +0 -0
  227. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/MarkdownScraper.test.d.ts} +0 -0
  228. /package/esm/typings/src/{execution/utils/usageToHuman.test.d.ts → scrapers/website/WebsiteScraper.test.d.ts} +0 -0
  229. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → scrapers/website/utils/markdownConverter.test.d.ts} +0 -0
  230. /package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.test.d.ts +0 -0
  231. /package/esm/typings/src/{personas/preparePersona.test.d.ts → utils/execCommand/execCommand.test.d.ts} +0 -0
  232. /package/esm/typings/src/utils/{extractParameterNames.test.d.ts → execCommand/execCommandNormalizeOptions.test.d.ts} +0 -0
  233. /package/esm/typings/src/utils/{replaceParameters.test.d.ts → files/extensionToMimeType.test.d.ts} +0 -0
@@ -1,12 +1,12 @@
1
1
  import type { Promisable } from 'type-fest';
2
- import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
3
- import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
4
4
  /**
5
5
  * Options for `CallbackInterfaceTools`
6
6
  *
7
7
  * @public exported from `@promptbook/core`
8
8
  */
9
- export type CallbackInterfaceToolsOptions = CommonExecutionToolsOptions & {
9
+ export type CallbackInterfaceToolsOptions = CommonToolsOptions & {
10
10
  /**
11
11
  * The callback function to be called when promptDialog is called
12
12
  */
@@ -1,6 +1,6 @@
1
- import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
2
- import type { UserInterfaceTools } from '../../../execution/UserInterfaceTools';
3
- import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
1
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
2
+ import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
3
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
4
4
  /**
5
5
  * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
6
6
  *
@@ -11,12 +11,12 @@ import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/U
11
11
  */
12
12
  export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
13
13
  private readonly options;
14
- constructor(options?: CommonExecutionToolsOptions);
14
+ constructor(options?: CommonToolsOptions);
15
15
  /**
16
16
  * Trigger window.DIALOG TEMPLATE
17
17
  */
18
18
  promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
19
19
  }
20
20
  /**
21
- * Note: [🔵] This code should never be published outside of `@promptbook/browser`
21
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
22
22
  */
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This error indicates problems parsing the format value
3
+ *
4
+ * For example, when the format value is not a valid JSON or CSV
5
+ * This is not thrown directly but in extended classes
6
+ *
7
+ * @public exported from `@promptbook/core`
8
+ */
9
+ export declare class AbstractFormatError extends Error {
10
+ constructor(message: string);
11
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error indicates that the promptbook can not retrieve knowledge from external sources
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class KnowledgeScrapeError extends Error {
7
+ readonly name = "KnowledgeScrapeError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error type indicates that some tools are missing for pipeline execution or preparation
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class MissingToolsError extends Error {
7
+ readonly name = "MissingToolsError";
8
+ constructor(message: string);
9
+ }
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Note: Keep it public to allow people to make their own execution tools
5
5
  */
6
- export type CommonExecutionToolsOptions = {
6
+ export type CommonToolsOptions = {
7
7
  /**
8
8
  * If true, the internal executions will be logged
9
9
  */
@@ -1,3 +1,4 @@
1
+ import type { Scraper } from '../scrapers/_common/Scraper';
1
2
  import type { Arrayable } from '../types/Arrayable';
2
3
  import type { LlmExecutionTools } from './LlmExecutionTools';
3
4
  import type { ScriptExecutionTools } from './ScriptExecutionTools';
@@ -9,12 +10,21 @@ import type { UserInterfaceTools } from './UserInterfaceTools';
9
10
  */
10
11
  export type ExecutionTools = {
11
12
  /**
12
- * Tools for executing prompts to large language models like GPT-4
13
+ * Tools for executing prompts in large language models
13
14
  *
14
- * Tip: Use `createLlmToolsFromEnv()` to use all available LLM providers you configured
15
- * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
15
+ * Tip: Use `$provideLlmToolsFromEnv()` to use all available LLM providers you configured
16
+ *
17
+ * @default [] - If not provided, no LLM execution will be possible - it does not make sense in most cases
16
18
  */
17
- llm?: Arrayable<LlmExecutionTools>;
19
+ readonly llm?: Arrayable<LlmExecutionTools>;
20
+ /**
21
+ * Scrapers for extracting knowledge from external sources
22
+ *
23
+ * Tip: Use `$provideScrapersForNode` OR `$provideScrapersForBrowser` to use all available scrapers
24
+ *
25
+ * @default [] - If not provided, no external knowledge extraction will be possible
26
+ */
27
+ readonly scrapers?: Arrayable<Scraper>;
18
28
  /**
19
29
  * Tools for executing scripts
20
30
  *
@@ -22,15 +32,17 @@ export type ExecutionTools = {
22
32
  * If none of them supports the script, an error is thrown
23
33
  * Tip: Use here `new JavascriptExecutionTools()`
24
34
  *
25
- * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
26
35
  * @default [] - If not provided, no script execution will be possible
27
36
  */
28
- script?: Arrayable<ScriptExecutionTools>;
37
+ readonly script?: Arrayable<ScriptExecutionTools>;
29
38
  /**
30
39
  * Tools for interacting with the user
31
40
  *
32
41
  * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
33
- * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
34
42
  */
35
- userInterface?: UserInterfaceTools;
43
+ readonly userInterface?: UserInterfaceTools;
36
44
  };
45
+ /**
46
+ * TODO: [🍂] Maybe make llm = $provideLlmToolsFromEnv() without problem with bundle contaminated by only `@promptbook/node` and `@promptbook/cli` stuff
47
+ * TODO: [🍂] Same with scrapers
48
+ */
@@ -14,5 +14,6 @@ export type PipelineExecutor = {
14
14
  (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
15
15
  };
16
16
  /**
17
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
17
18
  * TODO: [🧠] Should this file be in /execution or /types folder?
18
19
  */
@@ -1,7 +1,8 @@
1
+ import { ReadonlyDeep } from 'type-fest';
2
+ import type { ErrorJson } from '../errors/utils/ErrorJson';
1
3
  import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
2
- import type { Parameters } from '../types/typeAliases';
3
4
  import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
4
- import type { ErrorJson } from '../errors/utils/ErrorJson';
5
+ import type { Parameters } from '../types/typeAliases';
5
6
  import type { PromptResultUsage } from './PromptResultUsage';
6
7
  /**
7
8
  * @@@
@@ -14,7 +15,7 @@ export type PipelineExecutorResult = {
14
15
  *
15
16
  * Note: If the execution was not successful, there are only some of the result parameters
16
17
  */
17
- readonly outputParameters: Parameters;
18
+ readonly outputParameters: Readonly<Parameters>;
18
19
  /**
19
20
  * Whether the execution was successful, details are aviable in `executionReport`
20
21
  */
@@ -22,26 +23,26 @@ export type PipelineExecutorResult = {
22
23
  /**
23
24
  * Added usage of whole execution, detailed usage is aviable in `executionReport`
24
25
  */
25
- readonly usage: PromptResultUsage;
26
+ readonly usage: ReadonlyDeep<PromptResultUsage>;
26
27
  /**
27
28
  * Errors that occured during the execution, details are aviable in `executionReport`
28
29
  */
29
- readonly errors: Array<ErrorJson>;
30
+ readonly errors: ReadonlyDeep<Array<ErrorJson>>;
30
31
  /**
31
32
  * Warnings that occured during the execution, details are aviable in `executionReport`
32
33
  */
33
- readonly warnings: Array<ErrorJson>;
34
+ readonly warnings: ReadonlyDeep<Array<ErrorJson>>;
34
35
  /**
35
36
  * The report of the execution with all details
36
37
  */
37
- readonly executionReport: ExecutionReportJson;
38
+ readonly executionReport: ReadonlyDeep<ExecutionReportJson>;
38
39
  /**
39
40
  * The prepared pipeline that was used for the execution
40
41
  *
41
42
  * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
42
43
  * If you passed not fully prepared pipeline, this is same pipeline but fully prepared
43
44
  */
44
- readonly preparedPipeline: PipelineJson;
45
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
45
46
  };
46
47
  /**
47
48
  * TODO: [🧠] Should this file be in /execution or /types folder?
@@ -0,0 +1,45 @@
1
+ import { ExpectError } from '../../errors/ExpectError';
2
+ import type { Prompt } from '../../types/Prompt';
3
+ import type { ChatPromptResult } from '../PromptResult';
4
+ import type { CompletionPromptResult } from '../PromptResult';
5
+ import type { EmbeddingPromptResult } from '../PromptResult';
6
+ import type { PromptResult } from '../PromptResult';
7
+ /**
8
+ * @@@
9
+ *
10
+ * @private internal utility of `createPipelineExecutor`
11
+ */
12
+ export type $OngoingTemplateResult = {
13
+ /**
14
+ * @@@
15
+ */
16
+ $prompt?: Prompt;
17
+ /**
18
+ * @@@
19
+ */
20
+ $chatResult?: ChatPromptResult;
21
+ /**
22
+ * @@@
23
+ */
24
+ $completionResult?: CompletionPromptResult;
25
+ /**
26
+ * @@@
27
+ */
28
+ $embeddingResult?: EmbeddingPromptResult;
29
+ /**
30
+ * @@@
31
+ */
32
+ $result: PromptResult | null;
33
+ /**
34
+ * @@@
35
+ */
36
+ $resultString: string | null;
37
+ /**
38
+ * @@@
39
+ */
40
+ $expectError: ExpectError | null;
41
+ /**
42
+ * @@@
43
+ */
44
+ $scriptPipelineExecutionErrors: Array<Error>;
45
+ };
@@ -0,0 +1,23 @@
1
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
2
+ import type { ExecutionTools } from '../ExecutionTools';
3
+ import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
4
+ /**
5
+ * Options for `createPipelineExecutor`
6
+ */
7
+ export type CreatePipelineExecutorOptions = {
8
+ /**
9
+ * The pipeline to be executed
10
+ */
11
+ readonly pipeline: PipelineJson;
12
+ /**
13
+ * The execution tools to be used during the execution of the pipeline
14
+ */
15
+ readonly tools: ExecutionTools;
16
+ /**
17
+ * Optional settings for the pipeline executor
18
+ */
19
+ readonly settings?: Partial<CreatePipelineExecutorSettings>;
20
+ };
21
+ /**
22
+ * TODO: !!!!!! Unite `CreatePipelineExecutorOptions` and `CreatePipelineExecutorSettings` OR describe the difference
23
+ */
@@ -0,0 +1,29 @@
1
+ import type { CsvSettings } from '../../formats/csv/CsvSettings';
2
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
+ export type CreatePipelineExecutorSettings = Omit<PrepareAndScrapeOptions, 'llmTools'> & {
4
+ /**
5
+ * When executor does not satisfy expectations it will be retried this amount of times
6
+ *
7
+ * @default MAX_EXECUTION_ATTEMPTS
8
+ */
9
+ readonly maxExecutionAttempts: number;
10
+ /**
11
+ * Settings for CSV format
12
+ *
13
+ * @default DEFAULT_CSV_SETTINGS
14
+ */
15
+ readonly csvSettings: CsvSettings;
16
+ /**
17
+ * If you pass fully prepared pipeline, this does not matter
18
+ *
19
+ * Otherwise:
20
+ * If false or not set, warning is shown when pipeline is not prepared
21
+ * If true, warning is suppressed
22
+ *
23
+ * @default false
24
+ */
25
+ readonly isNotPreparedWarningSupressed: boolean;
26
+ };
27
+ /**
28
+ * TODO: [🤹‍♂️] More granular setting for limits of execution + better waiting for queue
29
+ */
@@ -0,0 +1,13 @@
1
+ import type { PipelineExecutor } from '../PipelineExecutor';
2
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
3
+ /**
4
+ * Creates executor function from pipeline and execution tools.
5
+ *
6
+ * @returns The executor function
7
+ * @throws {PipelineLogicError} on logical error in the pipeline
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
11
+ /**
12
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
13
+ */
@@ -0,0 +1,58 @@
1
+ import type { Promisable, ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
3
+ import type { TaskProgress } from '../../types/TaskProgress';
4
+ import type { Parameters } from '../../types/typeAliases';
5
+ import type { ExecutionTools } from '../ExecutionTools';
6
+ import type { PipelineExecutorResult } from '../PipelineExecutorResult';
7
+ import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
8
+ /**
9
+ * @@@
10
+ *
11
+ * @private internal type of `executePipeline`
12
+ */
13
+ type ExecutePipelineOptions = {
14
+ /**
15
+ * @@@
16
+ */
17
+ readonly inputParameters: Readonly<Parameters>;
18
+ /**
19
+ * @@@
20
+ */
21
+ readonly tools: ExecutionTools;
22
+ /**
23
+ * @@@
24
+ */
25
+ onProgress?(taskProgress: TaskProgress): Promisable<void>;
26
+ /**
27
+ * @@@
28
+ */
29
+ readonly pipeline: PipelineJson;
30
+ /**
31
+ * @@@
32
+ */
33
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
34
+ /**
35
+ * @@@
36
+ */
37
+ readonly setPreparedPipeline: (preparedPipeline: ReadonlyDeep<PipelineJson>) => void;
38
+ /**
39
+ * @@@
40
+ */
41
+ readonly pipelineIdentification: string;
42
+ /**
43
+ * Settings for the pipeline executor
44
+ */
45
+ readonly settings: CreatePipelineExecutorSettings;
46
+ };
47
+ /**
48
+ * @@@
49
+ *
50
+ * Note: This is not a `PipelineExecutor` (which is binded with one exact pipeline), but a utility function of `createPipelineExecutor` which creates `PipelineExecutor`
51
+ *
52
+ * @private internal utility of `createPipelineExecutor`
53
+ */
54
+ export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
55
+ export {};
56
+ /**
57
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
58
+ */
@@ -0,0 +1,60 @@
1
+ import { Promisable, ReadonlyDeep } from 'type-fest';
2
+ import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
3
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
4
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
5
+ import type { TaskProgress } from '../../types/TaskProgress';
6
+ import type { Parameters } from '../../types/typeAliases';
7
+ import type { ExecutionTools } from '../ExecutionTools';
8
+ import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
9
+ /**
10
+ * @@@
11
+ *
12
+ * @private internal type of `executeTemplate`
13
+ */
14
+ type executeSingleTemplateOptions = {
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly currentTemplate: ReadonlyDeep<TemplateJson>;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
23
+ /**
24
+ * @@@
25
+ */
26
+ readonly parametersToPass: Readonly<Parameters>;
27
+ /**
28
+ * @@@
29
+ */
30
+ readonly tools: ExecutionTools;
31
+ /**
32
+ * @@@
33
+ */
34
+ readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
35
+ /**
36
+ * Settings for the pipeline executor
37
+ */
38
+ readonly settings: CreatePipelineExecutorSettings;
39
+ /**
40
+ * @@@
41
+ */
42
+ readonly $executionReport: ExecutionReportJson;
43
+ /**
44
+ * @@@
45
+ */
46
+ readonly pipelineIdentification: string;
47
+ };
48
+ /**
49
+ * @@@
50
+ *
51
+ * @private internal utility of `createPipelineExecutor`
52
+ */
53
+ export declare function executeTemplate(options: executeSingleTemplateOptions): Promise<Readonly<Parameters>>;
54
+ export {};
55
+ /**
56
+ * TODO: [🤹‍♂️]
57
+ */
58
+ /**
59
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
60
+ */
@@ -0,0 +1,15 @@
1
+ import type { TODO_any } from '../../utils/organization/TODO_any';
2
+ import type { ExecuteAttemptsOptions } from './40-executeAttempts';
3
+ /**
4
+ * @@@
5
+ *
6
+ * @private internal type of `executeFormatSubvalues`
7
+ */
8
+ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
9
+ /**
10
+ * @@@
11
+ *
12
+ * @private internal utility of `createPipelineExecutor`
13
+ */
14
+ export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
15
+ export {};
@@ -0,0 +1,69 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
3
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
4
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
5
+ import type { Parameters } from '../../types/typeAliases';
6
+ import type { string_parameter_name } from '../../types/typeAliases';
7
+ import type { TODO_string } from '../../utils/organization/TODO_string';
8
+ import type { ExecutionTools } from '../ExecutionTools';
9
+ import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
10
+ /**
11
+ * @@@
12
+ *
13
+ * @private internal type of `executeAttempts`
14
+ */
15
+ export type ExecuteAttemptsOptions = {
16
+ /**
17
+ * @@@
18
+ */
19
+ readonly jokerParameterNames: Readonly<Array<string_parameter_name>>;
20
+ /**
21
+ * @@@
22
+ */
23
+ readonly priority: number;
24
+ /**
25
+ * @@@
26
+ */
27
+ readonly maxAttempts: number;
28
+ /**
29
+ * @@@
30
+ */
31
+ readonly preparedContent: TODO_string;
32
+ /**
33
+ * @@@
34
+ */
35
+ readonly parameters: Readonly<Parameters>;
36
+ /**
37
+ * @@@
38
+ */
39
+ readonly template: ReadonlyDeep<TemplateJson>;
40
+ /**
41
+ * @@@
42
+ */
43
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
44
+ /**
45
+ * @@@
46
+ */
47
+ readonly tools: ExecutionTools;
48
+ /**
49
+ * Settings for the pipeline executor
50
+ */
51
+ readonly settings: CreatePipelineExecutorSettings;
52
+ /**
53
+ * @@@
54
+ */
55
+ readonly $executionReport: ExecutionReportJson;
56
+ /**
57
+ * @@@
58
+ */
59
+ readonly pipelineIdentification: string;
60
+ };
61
+ /**
62
+ * @@@
63
+ *
64
+ * @private internal utility of `createPipelineExecutor`
65
+ */
66
+ export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
67
+ /**
68
+ * TODO: Break into smaller functions
69
+ */
@@ -0,0 +1,34 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
3
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
4
+ import type { Parameters } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal type of `createPipelineExecutor`
9
+ */
10
+ type FilterJustOutputParametersOptions = {
11
+ /**
12
+ * @@@
13
+ */
14
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly parametersToPass: Readonly<Parameters>;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly $warnings: PipelineExecutionError[];
23
+ /**
24
+ * @@@
25
+ */
26
+ readonly pipelineIdentification: string;
27
+ };
28
+ /**
29
+ * @@@
30
+ *
31
+ * @private internal utility of `createPipelineExecutor`
32
+ */
33
+ export declare function filterJustOutputParameters(options: FilterJustOutputParametersOptions): Parameters;
34
+ export {};
@@ -0,0 +1,10 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
3
+ import type { string_markdown } from '../../types/typeAliases';
4
+ import type { string_parameter_value } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal utility of `createPipelineExecutor`
9
+ */
10
+ export declare function getContextForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
@@ -0,0 +1,27 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
3
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
4
+ import type { string_markdown } from '../../types/typeAliases';
5
+ import type { string_parameter_value } from '../../types/typeAliases';
6
+ /**
7
+ * @@@
8
+ *
9
+ * @private internal type of `getKnowledgeForTemplate`
10
+ */
11
+ type GetKnowledgeForTemplateOptions = {
12
+ /**
13
+ * @@@
14
+ */
15
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
16
+ /**
17
+ * @@@
18
+ */
19
+ readonly template: ReadonlyDeep<TemplateJson>;
20
+ };
21
+ /**
22
+ * @@@
23
+ *
24
+ * @private internal utility of `createPipelineExecutor`
25
+ */
26
+ export declare function getKnowledgeForTemplate(options: GetKnowledgeForTemplateOptions): Promise<string_parameter_value & string_markdown>;
27
+ export {};
@@ -0,0 +1,30 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
3
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
4
+ import type { ReservedParameters } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal type of `getReservedParametersForTemplate`
9
+ */
10
+ type GetReservedParametersForTemplateOptions = {
11
+ /**
12
+ * @@@
13
+ */
14
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly template: ReadonlyDeep<TemplateJson>;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly pipelineIdentification: string;
23
+ };
24
+ /**
25
+ * @@@
26
+ *
27
+ * @private internal utility of `createPipelineExecutor`
28
+ */
29
+ export declare function getReservedParametersForTemplate(options: GetReservedParametersForTemplateOptions): Promise<Readonly<ReservedParameters>>;
30
+ export {};
@@ -0,0 +1,10 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
3
+ import type { string_markdown } from '../../types/typeAliases';
4
+ import type { string_parameter_value } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal utility of `createPipelineExecutor`
9
+ */
10
+ export declare function getSamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
@@ -4,4 +4,4 @@ import type { EmbeddingVector } from './EmbeddingVector';
4
4
  *
5
5
  * @public exported from `@promptbook/core`
6
6
  */
7
- export declare function embeddingVectorToString(embeddingVector: EmbeddingVector): string;
7
+ export declare function embeddingVectorToString(embeddingVector: Readonly<EmbeddingVector>): string;
@@ -6,3 +6,6 @@ import type { TranslatorOptions } from './automatic-translators/TranslatorOption
6
6
  export declare function translateMessages({ automaticTranslator, from, to, }: {
7
7
  automaticTranslator: AutomaticTranslator;
8
8
  } & TranslatorOptions): Promise<void>;
9
+ /**
10
+ * TODO: [😶] Unite floder listing
11
+ */