@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
package/README.md CHANGED
@@ -16,6 +16,16 @@ Supercharge your use of large language models
16
16
 
17
17
 
18
18
 
19
+ ## ✨ New Features
20
+
21
+ - ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
22
+
23
+ <blockquote style="color: #ff8811">
24
+ <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>.
25
+ </blockquote>
26
+
27
+
28
+
19
29
  ## 📦 Package `@promptbook/types`
20
30
 
21
31
  - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -65,13 +75,15 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
65
75
 
66
76
  ## 🤍 The Promptbook Whitepaper
67
77
 
78
+
79
+
68
80
  If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
69
81
 
70
82
  But often you will struggle with the limitations of LLMs, such as hallucinations, off-topic responses, poor quality output, language drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses. When this happens, you generally have three options:
71
83
 
72
84
  1. **Fine-tune** the model to your specifications or even train your own.
73
85
  2. **Prompt-engineer** the prompt to the best shape you can achieve.
74
- 3. Use **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
86
+ 3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
75
87
 
76
88
  In all of these situations, but especially in 3., the Promptbook library can make your life easier.
77
89
 
@@ -83,7 +95,9 @@ In all of these situations, but especially in 3., the Promptbook library can mak
83
95
  - Promptbook has built in versioning. You can test multiple **A/B versions** of pipelines and see which one works best.
84
96
  - Promptbook is designed to do [**RAG** (Retrieval-Augmented Generation)](https://github.com/webgptorg/promptbook/discussions/41) and other advanced techniques. You can use **knowledge** to improve the quality of the output.
85
97
 
86
- ## 🧔 Promptbook _(for prompt-engeneers)_
98
+
99
+
100
+ ## 🧔 Pipeline _(for prompt-engeneers)_
87
101
 
88
102
  **P**romp**t** **b**oo**k** markdown file (or `.ptbk.md` file) is document that describes a **pipeline** - a series of prompts that are chained together to form somewhat reciepe for transforming natural language input.
89
103
 
@@ -105,7 +119,6 @@ File `write-website-content.ptbk.md`:
105
119
  > Instructions for creating web page content.
106
120
  >
107
121
  > - PIPELINE URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
108
- > - PROMPTBOOK VERSION 0.0.1
109
122
  > - INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
110
123
  > - INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
111
124
  > - OUTPUT PARAM `{websiteContent}` Web content
@@ -344,6 +357,10 @@ Or you can install them separately:
344
357
  - **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
345
358
  - **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
346
359
  - **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
360
+ - **[@promptbook/pdf](https://www.npmjs.com/package/@promptbook/pdf)** - Read knowledge from `.pdf` documents
361
+ - **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
362
+ - **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
363
+ - **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
347
364
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
348
365
  - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
349
366
 
@@ -400,6 +417,8 @@ The following glossary is used to clarify certain concepts:
400
417
  - When you want to **version** your prompts and **test multiple versions**
401
418
  - When you want to **log** the execution of prompts and backtrace the issues
402
419
 
420
+ [See more](https://github.com/webgptorg/promptbook/discussions/111)
421
+
403
422
  ### ➖ When not to use
404
423
 
405
424
  - When you have already implemented single simple prompt and it works fine for your job
@@ -409,6 +428,8 @@ The following glossary is used to clarify certain concepts:
409
428
  - When your main focus is on something other than text - like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
410
429
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
411
430
 
431
+ [See more](https://github.com/webgptorg/promptbook/discussions/112)
432
+
412
433
  ## 🐜 Known issues
413
434
 
414
435
  - [🤸‍♂️ Iterations not working yet](https://github.com/webgptorg/promptbook/discussions/55)
@@ -421,63 +442,15 @@ The following glossary is used to clarify certain concepts:
421
442
 
422
443
  ## ❔ FAQ
423
444
 
424
-
425
-
426
445
  If you have a question [start a discussion](https://github.com/webgptorg/promptbook/discussions/), [open an issue](https://github.com/webgptorg/promptbook/issues) or [write me an email](https://www.pavolhejny.com/contact).
427
446
 
428
- ### Why not just use the OpenAI SDK / Anthropic Claude SDK / ...?
429
-
430
- Different levels of abstraction. OpenAI library is for direct use of OpenAI API. This library is for a higher level of abstraction. It define pipelines that are independent of the underlying library, LLM model, or even LLM provider.
431
-
432
- ### How is it different from the Langchain library?
433
-
434
- Langchain is primarily aimed at ML developers working in Python. This library is for developers working in javascript/typescript and creating applications for end users.
435
-
436
- We are considering creating a bridge/converter between these two libraries.
437
-
438
-
439
-
440
- ### Promptbooks vs. OpenAI`s GPTs
441
-
442
- GPTs are chat assistants that can be assigned to specific tasks and materials. But they are still chat assistants. Promptbooks are a way to orchestrate many more predefined tasks to have much tighter control over the process. Promptbooks are not a good technology for creating human-like chatbots, GPTs are not a good technology for creating outputs with specific requirements.
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
- ### Where should I store my promptbooks?
459
-
460
- If you use raw SDKs, you just put prompts in the sourcecode, mixed in with typescript, javascript, python or whatever programming language you use.
461
-
462
- If you use promptbooks, you can store them in several places, each with its own advantages and disadvantages:
463
-
464
- 1. As **source code**, typically git-committed. In this case you can use the versioning system and the promptbooks will be tightly coupled with the version of the application. You still get the power of promptbooks, as you separate the concerns of the prompt-engineer and the programmer.
465
-
466
- 2. As data in a **database** In this case, promptbooks are like posts / articles on the blog. They can be modified independently of the application. You don't need to redeploy the application to change the promptbooks. You can have multiple versions of promptbooks for each user. You can have a web interface for non-programmers to create and modify promptbooks. But you lose the versioning system and you still have to consider the interface between the promptbooks and the application _(= input and output parameters)_.
467
-
468
- 3. In a **configuration** in environment variables. This is a good way to store promptbooks if you have an application with multiple deployments and you want to have different but simple promptbooks for each deployment and you don't need to change them often.
469
-
470
- ### What should I do when I need same promptbook in multiple human languages?
471
-
472
- A single promptbook can be written for several _(human)_ languages at once. However, we recommend that you have separate promptbooks for each language.
473
-
474
- In large language models, you will get better results if you have prompts in the same language as the user input.
475
-
476
- The best way to manage this is to have suffixed promptbooks like `write-website-content.en.ptbk.md` and `write-website-content.cs.ptbk.md` for each supported language.
477
-
478
-
479
-
480
-
447
+ - [❔ Why not just use the OpenAI SDK / Anthropic Claude SDK / ...?](https://github.com/webgptorg/promptbook/discussions/114)
448
+ - [❔ How is it different from the OpenAI`s GPTs?](https://github.com/webgptorg/promptbook/discussions/118)
449
+ - [❔ How is it different from the Langchain?](https://github.com/webgptorg/promptbook/discussions/115)
450
+ - [❔ How is it different from the DSPy?](https://github.com/webgptorg/promptbook/discussions/117)
451
+ - [❔ How is it different from _anything_?](https://github.com/webgptorg/promptbook/discussions?discussions_q=is%3Aopen+label%3A%22Promptbook+vs%22)
452
+ - [❔ Is Promptbook using RAG _(Retrieval-Augmented Generation)_?](https://github.com/webgptorg/promptbook/discussions/123)
453
+ - [❔ Is Promptbook using function calling?](https://github.com/webgptorg/promptbook/discussions/124)
481
454
 
482
455
  ## ⌚ Changelog
483
456
 
@@ -1,7 +1,6 @@
1
1
  declare const _default: ({
2
2
  title: string;
3
3
  pipelineUrl: string;
4
- promptbookVersion: string;
5
4
  parameters: {
6
5
  name: string;
7
6
  description: string;
@@ -24,7 +23,6 @@ declare const _default: ({
24
23
  } | {
25
24
  title: string;
26
25
  pipelineUrl: string;
27
- promptbookVersion: string;
28
26
  parameters: {
29
27
  name: string;
30
28
  description: string;
@@ -53,7 +51,6 @@ declare const _default: ({
53
51
  } | {
54
52
  title: string;
55
53
  pipelineUrl: string;
56
- promptbookVersion: string;
57
54
  parameters: {
58
55
  name: string;
59
56
  description: string;
@@ -1,8 +1,10 @@
1
1
  import { PROMPTBOOK_VERSION } from '../version';
2
- import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
2
+ import { SimplePromptInterfaceTools } from '../dialogs/simple-prompt/SimplePromptInterfaceTools';
3
+ import { $provideScrapersForBrowser } from '../scrapers/_common/register/$provideScrapersForBrowser';
3
4
  import { getLocalStorage } from '../storage/local-storage/getLocalStorage';
4
5
  import { getSessionStorage } from '../storage/local-storage/getSessionStorage';
5
6
  export { PROMPTBOOK_VERSION };
6
7
  export { SimplePromptInterfaceTools };
8
+ export { $provideScrapersForBrowser };
7
9
  export { getLocalStorage };
8
10
  export { getSessionStorage };
@@ -6,6 +6,16 @@ import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/
6
6
  import { _AzureOpenAiRegistration } from '../llm-providers/azure-openai/register-constructor';
7
7
  import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
8
8
  import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
9
+ import { _LegacyDocumentScraperRegistration } from '../scrapers/document-legacy/register-constructor';
10
+ import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
11
+ import { _DocumentScraperRegistration } from '../scrapers/document/register-constructor';
12
+ import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
13
+ import { _MarkdownScraperRegistration } from '../scrapers/markdown/register-constructor';
14
+ import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
15
+ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
16
+ import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
17
+ import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
18
+ import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
9
19
  export { PROMPTBOOK_VERSION };
10
20
  export { _CLI };
11
21
  export { _AnthropicClaudeMetadataRegistration };
@@ -14,3 +24,13 @@ export { _AzureOpenAiMetadataRegistration };
14
24
  export { _AzureOpenAiRegistration };
15
25
  export { _OpenAiMetadataRegistration };
16
26
  export { _OpenAiRegistration };
27
+ export { _LegacyDocumentScraperRegistration };
28
+ export { _LegacyDocumentScraperMetadataRegistration };
29
+ export { _DocumentScraperRegistration };
30
+ export { _DocumentScraperMetadataRegistration };
31
+ export { _MarkdownScraperRegistration };
32
+ export { _MarkdownScraperMetadataRegistration };
33
+ export { _PdfScraperRegistration };
34
+ export { _PdfScraperMetadataRegistration };
35
+ export { _WebsiteScraperRegistration };
36
+ export { _WebsiteScraperMetadataRegistration };
@@ -13,23 +13,30 @@ import { MAX_FILENAME_LENGTH } from '../config';
13
13
  import { MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
14
14
  import { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
15
15
  import { EXECUTIONS_CACHE_DIRNAME } from '../config';
16
+ import { SCRAPE_CACHE_DIRNAME } from '../config';
16
17
  import { PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
17
18
  import { RESERVED_PARAMETER_NAMES } from '../config';
18
19
  import { DEFAULT_REMOTE_URL } from '../config';
19
20
  import { DEFAULT_REMOTE_URL_PATH } from '../config';
21
+ import { DEFAULT_CSV_SETTINGS } from '../config';
20
22
  import { IS_VERBOSE } from '../config';
23
+ import { IS_AUTO_INSTALLED } from '../config';
21
24
  import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
22
- import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
23
25
  import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
24
26
  import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
25
27
  import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
26
28
  import { stringifyPipelineJson } from '../conversion/utils/stringifyPipelineJson';
27
29
  import { validatePipeline } from '../conversion/validation/validatePipeline';
30
+ import { CallbackInterfaceTools } from '../dialogs/callback/CallbackInterfaceTools';
31
+ import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
32
+ import { AbstractFormatError } from '../errors/AbstractFormatError';
28
33
  import { CollectionError } from '../errors/CollectionError';
29
34
  import { EnvironmentMismatchError } from '../errors/EnvironmentMismatchError';
30
35
  import { ExpectError } from '../errors/ExpectError';
31
36
  import { ERRORS } from '../errors/index';
37
+ import { KnowledgeScrapeError } from '../errors/KnowledgeScrapeError';
32
38
  import { LimitReachedError } from '../errors/LimitReachedError';
39
+ import { MissingToolsError } from '../errors/MissingToolsError';
33
40
  import { NotFoundError } from '../errors/NotFoundError';
34
41
  import { NotYetImplementedError } from '../errors/NotYetImplementedError';
35
42
  import { ParseError } from '../errors/ParseError';
@@ -38,20 +45,20 @@ import { PipelineLogicError } from '../errors/PipelineLogicError';
38
45
  import { PipelineUrlError } from '../errors/PipelineUrlError';
39
46
  import { UnexpectedError } from '../errors/UnexpectedError';
40
47
  import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
41
- import { createPipelineExecutor } from '../execution/createPipelineExecutor';
48
+ import { createPipelineExecutor } from '../execution/createPipelineExecutor/00-createPipelineExecutor';
42
49
  import { embeddingVectorToString } from '../execution/embeddingVectorToString';
43
50
  import { ZERO_USAGE } from '../execution/utils/addUsage';
44
51
  import { addUsage } from '../execution/utils/addUsage';
45
52
  import { isPassingExpectations } from '../execution/utils/checkExpectations';
46
53
  import { usageToHuman } from '../execution/utils/usageToHuman';
47
54
  import { usageToWorktime } from '../execution/utils/usageToWorktime';
48
- import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackInterfaceTools';
49
- import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
50
- import { prepareKnowledgePieces } from '../knowledge/prepare-knowledge/_common/prepareKnowledgePieces';
51
- import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
52
- import { $llmToolsMetadataRegister } from '../llm-providers/_common/$llmToolsMetadataRegister';
53
- import { $llmToolsRegister } from '../llm-providers/_common/$llmToolsRegister';
54
- import { createLlmToolsFromConfiguration } from '../llm-providers/_common/createLlmToolsFromConfiguration';
55
+ import { CsvFormatDefinition } from '../formats/csv/CsvFormatDefinition';
56
+ import { CsvFormatError } from '../formats/csv/CsvFormatError';
57
+ import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
58
+ import { TextFormatDefinition } from '../formats/text/TextFormatDefinition';
59
+ import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$llmToolsMetadataRegister';
60
+ import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
61
+ import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
55
62
  import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
56
63
  import { countTotalUsage } from '../llm-providers/_common/utils/count-total-usage/countTotalUsage';
57
64
  import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
@@ -64,8 +71,16 @@ import { isPipelinePrepared } from '../prepare/isPipelinePrepared';
64
71
  import { preparePipeline } from '../prepare/preparePipeline';
65
72
  import { prepareTemplates } from '../prepare/prepareTemplates';
66
73
  import { unpreparePipeline } from '../prepare/unpreparePipeline';
74
+ import { prepareKnowledgePieces } from '../scrapers/_common/prepareKnowledgePieces';
75
+ import { $scrapersMetadataRegister } from '../scrapers/_common/register/$scrapersMetadataRegister';
76
+ import { $scrapersRegister } from '../scrapers/_common/register/$scrapersRegister';
77
+ import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
78
+ import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
79
+ import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
80
+ import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
81
+ import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
67
82
  import { MemoryStorage } from '../storage/memory/MemoryStorage';
68
- import { PrefixStorage } from '../storage/utils/PrefixStorage';
83
+ import { PrefixStorage } from '../storage/memory/utils/PrefixStorage';
69
84
  import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
70
85
  import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
71
86
  import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
@@ -86,23 +101,30 @@ export { MAX_FILENAME_LENGTH };
86
101
  export { MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
87
102
  export { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
88
103
  export { EXECUTIONS_CACHE_DIRNAME };
104
+ export { SCRAPE_CACHE_DIRNAME };
89
105
  export { PIPELINE_COLLECTION_BASE_FILENAME };
90
106
  export { RESERVED_PARAMETER_NAMES };
91
107
  export { DEFAULT_REMOTE_URL };
92
108
  export { DEFAULT_REMOTE_URL_PATH };
109
+ export { DEFAULT_CSV_SETTINGS };
93
110
  export { IS_VERBOSE };
111
+ export { IS_AUTO_INSTALLED };
94
112
  export { pipelineJsonToString };
95
- export type { PipelineStringToJsonOptions };
96
113
  export { pipelineStringToJson };
97
114
  export { pipelineStringToJsonSync };
98
115
  export { prettifyPipelineString };
99
116
  export { stringifyPipelineJson };
100
117
  export { validatePipeline };
118
+ export { CallbackInterfaceTools };
119
+ export type { CallbackInterfaceToolsOptions };
120
+ export { AbstractFormatError };
101
121
  export { CollectionError };
102
122
  export { EnvironmentMismatchError };
103
123
  export { ExpectError };
104
124
  export { ERRORS };
125
+ export { KnowledgeScrapeError };
105
126
  export { LimitReachedError };
127
+ export { MissingToolsError };
106
128
  export { NotFoundError };
107
129
  export { NotYetImplementedError };
108
130
  export { ParseError };
@@ -118,10 +140,10 @@ export { addUsage };
118
140
  export { isPassingExpectations };
119
141
  export { usageToHuman };
120
142
  export { usageToWorktime };
121
- export { CallbackInterfaceTools };
122
- export type { CallbackInterfaceToolsOptions };
123
- export { prepareKnowledgePieces };
124
- export { prepareKnowledgeFromMarkdown };
143
+ export { CsvFormatDefinition };
144
+ export { CsvFormatError };
145
+ export { MANDATORY_CSV_SETTINGS };
146
+ export { TextFormatDefinition };
125
147
  export { $llmToolsMetadataRegister };
126
148
  export { $llmToolsRegister };
127
149
  export { createLlmToolsFromConfiguration };
@@ -137,6 +159,14 @@ export { isPipelinePrepared };
137
159
  export { preparePipeline };
138
160
  export { prepareTemplates };
139
161
  export { unpreparePipeline };
162
+ export { prepareKnowledgePieces };
163
+ export { $scrapersMetadataRegister };
164
+ export { $scrapersRegister };
165
+ export { _LegacyDocumentScraperMetadataRegistration };
166
+ export { _DocumentScraperMetadataRegistration };
167
+ export { _MarkdownScraperMetadataRegistration };
168
+ export { _PdfScraperMetadataRegistration };
169
+ export { _WebsiteScraperMetadataRegistration };
140
170
  export { MemoryStorage };
141
171
  export { PrefixStorage };
142
172
  export { executionReportJsonToString };
@@ -0,0 +1,8 @@
1
+ import { PROMPTBOOK_VERSION } from '../version';
2
+ import { createDocumentScraper } from '../scrapers/document/createDocumentScraper';
3
+ import { DocumentScraper } from '../scrapers/document/DocumentScraper';
4
+ import { _DocumentScraperRegistration } from '../scrapers/document/register-constructor';
5
+ export { PROMPTBOOK_VERSION };
6
+ export { createDocumentScraper };
7
+ export { DocumentScraper };
8
+ export { _DocumentScraperRegistration };
@@ -0,0 +1,8 @@
1
+ import { PROMPTBOOK_VERSION } from '../version';
2
+ import { createLegacyDocumentScraper } from '../scrapers/document-legacy/createLegacyDocumentScraper';
3
+ import { LegacyDocumentScraper } from '../scrapers/document-legacy/LegacyDocumentScraper';
4
+ import { _LegacyDocumentScraperRegistration } from '../scrapers/document-legacy/register-constructor';
5
+ export { PROMPTBOOK_VERSION };
6
+ export { createLegacyDocumentScraper };
7
+ export { LegacyDocumentScraper };
8
+ export { _LegacyDocumentScraperRegistration };
@@ -1,6 +1,9 @@
1
1
  import { PROMPTBOOK_VERSION } from '../version';
2
2
  import { extractBlock } from '../postprocessing/utils/extractBlock';
3
3
  import { extractJsonBlock } from '../postprocessing/utils/extractJsonBlock';
4
+ import { createMarkdownScraper } from '../scrapers/markdown/createMarkdownScraper';
5
+ import { MarkdownScraper } from '../scrapers/markdown/MarkdownScraper';
6
+ import { _MarkdownScraperRegistration } from '../scrapers/markdown/register-constructor';
4
7
  import type { string_markdown } from '../types/typeAliases';
5
8
  import type { string_markdown_section } from '../types/typeAliases';
6
9
  import type { string_markdown_section_content } from '../types/typeAliases';
@@ -21,6 +24,9 @@ import { splitMarkdownIntoSections } from '../utils/markdown/splitMarkdownIntoSe
21
24
  export { PROMPTBOOK_VERSION };
22
25
  export { extractBlock };
23
26
  export { extractJsonBlock };
27
+ export { createMarkdownScraper };
28
+ export { MarkdownScraper };
29
+ export { _MarkdownScraperRegistration };
24
30
  export type { string_markdown };
25
31
  export type { string_markdown_section };
26
32
  export type { string_markdown_section_content };
@@ -1,10 +1,18 @@
1
1
  import { PROMPTBOOK_VERSION } from '../version';
2
2
  import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
3
- import { createLlmToolsFromConfigurationFromEnv } from '../llm-providers/_common/createLlmToolsFromConfigurationFromEnv';
4
- import { createLlmToolsFromEnv } from '../llm-providers/_common/createLlmToolsFromEnv';
5
- import { FilesStorage } from '../storage/files-storage/FilesStorage';
3
+ import { $provideExecutionToolsForNode } from '../execution/utils/$provideExecutionToolsForNode';
4
+ import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv';
5
+ import { $provideLlmToolsFromEnv } from '../llm-providers/_common/register/$provideLlmToolsFromEnv';
6
+ import { $provideScrapersForNode } from '../scrapers/_common/register/$provideScrapersForNode';
7
+ import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
8
+ import { $execCommand } from '../utils/execCommand/$execCommand';
9
+ import { $execCommands } from '../utils/execCommand/$execCommands';
6
10
  export { PROMPTBOOK_VERSION };
7
11
  export { createCollectionFromDirectory };
8
- export { createLlmToolsFromConfigurationFromEnv };
9
- export { createLlmToolsFromEnv };
10
- export { FilesStorage };
12
+ export { $provideExecutionToolsForNode };
13
+ export { $provideLlmToolsConfigurationFromEnv };
14
+ export { $provideLlmToolsFromEnv };
15
+ export { $provideScrapersForNode };
16
+ export { FileCacheStorage };
17
+ export { $execCommand };
18
+ export { $execCommands };
@@ -0,0 +1,8 @@
1
+ import { PROMPTBOOK_VERSION } from '../version';
2
+ import { createPdfScraper } from '../scrapers/pdf/createPdfScraper';
3
+ import { PdfScraper } from '../scrapers/pdf/PdfScraper';
4
+ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
5
+ export { PROMPTBOOK_VERSION };
6
+ export { createPdfScraper };
7
+ export { PdfScraper };
8
+ export { _PdfScraperRegistration };
@@ -7,14 +7,17 @@ import type { PipelineTemplateCommandParser } from '../commands/_common/types/Co
7
7
  import type { CommandParserInput } from '../commands/_common/types/CommandParser';
8
8
  import type { CommandUsagePlace } from '../commands/_common/types/CommandUsagePlaces';
9
9
  import type { ExpectCommand } from '../commands/EXPECT/ExpectCommand';
10
+ import type { ForeachJson } from '../commands/FOREACH/ForeachJson';
10
11
  import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
11
12
  import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
12
- import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
13
13
  import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
14
14
  import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
15
+ import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
15
16
  import type { ErrorJson } from '../errors/utils/ErrorJson';
16
17
  import type { AvailableModel } from '../execution/AvailableModel';
17
- import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
18
+ import type { CommonToolsOptions } from '../execution/CommonToolsOptions';
19
+ import type { CreatePipelineExecutorOptions } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorOptions';
20
+ import type { CreatePipelineExecutorSettings } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorSettings';
18
21
  import type { EmbeddingVector } from '../execution/EmbeddingVector';
19
22
  import type { ExecutionTools } from '../execution/ExecutionTools';
20
23
  import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
@@ -32,10 +35,11 @@ import type { ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExec
32
35
  import type { UncertainNumber } from '../execution/UncertainNumber';
33
36
  import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
34
37
  import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
35
- import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
36
- import type { LlmToolsConfiguration } from '../llm-providers/_common/LlmToolsConfiguration';
37
- import type { LlmToolsMetadata } from '../llm-providers/_common/LlmToolsMetadata';
38
- import type { LlmToolsOptions } from '../llm-providers/_common/LlmToolsOptions';
38
+ import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
39
+ import type { CsvSettings } from '../formats/csv/CsvSettings';
40
+ import type { LlmToolsConfiguration } from '../llm-providers/_common/register/LlmToolsConfiguration';
41
+ import type { LlmToolsMetadata } from '../llm-providers/_common/register/LlmToolsMetadata';
42
+ import type { LlmToolsOptions } from '../llm-providers/_common/register/LlmToolsOptions';
39
43
  import type { CacheItem } from '../llm-providers/_common/utils/cache/CacheItem';
40
44
  import type { CacheLlmToolsOptions } from '../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
41
45
  import type { LlmExecutionToolsWithTotalUsage } from '../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
@@ -60,11 +64,17 @@ import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/int
60
64
  import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
61
65
  import type { AnonymousRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
62
66
  import type { CollectionRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
63
- import type { PrepareOptions } from '../prepare/PrepareOptions';
67
+ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
68
+ import type { Converter } from '../scrapers/_common/Converter';
69
+ import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
70
+ import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
71
+ import type { Scraper } from '../scrapers/_common/Scraper';
72
+ import type { ScraperSourceHandler } from '../scrapers/_common/Scraper';
73
+ import type { ScraperIntermediateSource } from '../scrapers/_common/ScraperIntermediateSource';
64
74
  import type { JavascriptExecutionToolsOptions } from '../scripting/javascript/JavascriptExecutionToolsOptions';
65
75
  import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
66
76
  import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
67
- import type { FilesStorageOptions } from '../storage/files-storage/FilesStorageOptions';
77
+ import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
68
78
  import type { ExecutionPromptReportJson } from '../types/execution-report/ExecutionPromptReportJson';
69
79
  import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
70
80
  import type { ExecutionReportString } from '../types/execution-report/ExecutionReportString';
@@ -147,6 +157,7 @@ import type { string_data_url } from '../types/typeAliases';
147
157
  import type { string_base64 } from '../types/typeAliases';
148
158
  import type { string_href } from '../types/typeAliases';
149
159
  import type { string_url_image } from '../types/typeAliases';
160
+ import type { string_executable_path } from '../types/typeAliases';
150
161
  import type { string_uri } from '../types/typeAliases';
151
162
  import type { string_uri_part } from '../types/typeAliases';
152
163
  import type { string_uriid } from '../types/typeAliases';
@@ -161,13 +172,12 @@ import type { string_sha256 } from '../types/typeAliases';
161
172
  import type { string_semantic_version } from '../types/typeAliases';
162
173
  import type { string_version_dependency } from '../types/typeAliases';
163
174
  import type { string_file_extension } from '../types/typeAliases';
164
- import type { string_file_absolute_path } from '../types/typeAliases';
165
- import type { string_file_relative_path } from '../types/typeAliases';
166
- import type { string_file_path } from '../types/typeAliases';
167
- import type { string_folder_absolute_path } from '../types/typeAliases';
168
- import type { string_folder_relative_path } from '../types/typeAliases';
169
- import type { string_folder_path } from '../types/typeAliases';
175
+ import type { string_absolute_filename } from '../types/typeAliases';
176
+ import type { string_relative_filename } from '../types/typeAliases';
170
177
  import type { string_filename } from '../types/typeAliases';
178
+ import type { string_absolute_dirname } from '../types/typeAliases';
179
+ import type { string_relative_dirname } from '../types/typeAliases';
180
+ import type { string_dirname } from '../types/typeAliases';
171
181
  import type { string_person_fullname } from '../types/typeAliases';
172
182
  import type { string_person_profile } from '../types/typeAliases';
173
183
  import type { string_license } from '../types/typeAliases';
@@ -210,6 +220,9 @@ import type { number_megabytes } from '../types/typeAliases';
210
220
  import type { number_gigabytes } from '../types/typeAliases';
211
221
  import type { number_terabytes } from '../types/typeAliases';
212
222
  import type { Registered } from '../utils/$Register';
223
+ import type { Registration } from '../utils/$Register';
224
+ import type { IExecCommandOptions } from '../utils/execCommand/IExecCommandOptions';
225
+ import type { IExecCommandOptionsAdvanced } from '../utils/execCommand/IExecCommandOptions';
213
226
  import type { FromtoItems } from '../utils/FromtoItems';
214
227
  import type { CodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
215
228
  import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
@@ -220,6 +233,7 @@ import type { string_camelCase } from '../utils/normalization/normalizeTo_camelC
220
233
  import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
221
234
  import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
222
235
  import type { string_snake_case } from '../utils/normalization/normalizeTo_snake_case';
236
+ import type { empty_object } from '../utils/organization/empty_object';
223
237
  import type { really_any } from '../utils/organization/really_any';
224
238
  import type { TODO_any } from '../utils/organization/TODO_any';
225
239
  import type { string_promptbook_version } from '../version';
@@ -232,14 +246,17 @@ export type { PipelineTemplateCommandParser };
232
246
  export type { CommandParserInput };
233
247
  export type { CommandUsagePlace };
234
248
  export type { ExpectCommand };
249
+ export type { ForeachJson };
235
250
  export type { FormatCommand };
236
251
  export type { TemplateType };
237
- export type { PipelineStringToJsonOptions };
238
252
  export type { PrettifyOptions };
239
253
  export type { renderPipelineMermaidOptions };
254
+ export type { CallbackInterfaceToolsOptions };
240
255
  export type { ErrorJson };
241
256
  export type { AvailableModel };
242
- export type { CommonExecutionToolsOptions };
257
+ export type { CommonToolsOptions };
258
+ export type { CreatePipelineExecutorOptions };
259
+ export type { CreatePipelineExecutorSettings };
243
260
  export type { EmbeddingVector };
244
261
  export type { ExecutionTools };
245
262
  export type { LlmExecutionTools };
@@ -257,7 +274,8 @@ export type { ScriptExecutionToolsExecuteOptions };
257
274
  export type { UncertainNumber };
258
275
  export type { UserInterfaceTools };
259
276
  export type { UserInterfaceToolsPromptDialogOptions };
260
- export type { CallbackInterfaceToolsOptions };
277
+ export type { FormatSubvalueDefinition };
278
+ export type { CsvSettings };
261
279
  export type { LlmToolsConfiguration };
262
280
  export type { LlmToolsMetadata };
263
281
  export type { LlmToolsOptions };
@@ -285,11 +303,17 @@ export type { RemoteLlmExecutionToolsOptions };
285
303
  export type { RemoteServerOptions };
286
304
  export type { AnonymousRemoteServerOptions };
287
305
  export type { CollectionRemoteServerOptions };
288
- export type { PrepareOptions };
306
+ export type { PrepareAndScrapeOptions };
307
+ export type { Converter };
308
+ export type { ScraperAndConverterMetadata };
309
+ export type { ScraperConstructor };
310
+ export type { Scraper };
311
+ export type { ScraperSourceHandler };
312
+ export type { ScraperIntermediateSource };
289
313
  export type { JavascriptExecutionToolsOptions };
290
314
  export type { PostprocessingFunction };
291
315
  export type { PromptbookStorage };
292
- export type { FilesStorageOptions };
316
+ export type { FileCacheStorageOptions };
293
317
  export type { ExecutionPromptReportJson };
294
318
  export type { ExecutionReportJson };
295
319
  export type { ExecutionReportString };
@@ -372,6 +396,7 @@ export type { string_data_url };
372
396
  export type { string_base64 };
373
397
  export type { string_href };
374
398
  export type { string_url_image };
399
+ export type { string_executable_path };
375
400
  export type { string_uri };
376
401
  export type { string_uri_part };
377
402
  export type { string_uriid };
@@ -386,13 +411,12 @@ export type { string_sha256 };
386
411
  export type { string_semantic_version };
387
412
  export type { string_version_dependency };
388
413
  export type { string_file_extension };
389
- export type { string_file_absolute_path };
390
- export type { string_file_relative_path };
391
- export type { string_file_path };
392
- export type { string_folder_absolute_path };
393
- export type { string_folder_relative_path };
394
- export type { string_folder_path };
414
+ export type { string_absolute_filename };
415
+ export type { string_relative_filename };
395
416
  export type { string_filename };
417
+ export type { string_absolute_dirname };
418
+ export type { string_relative_dirname };
419
+ export type { string_dirname };
396
420
  export type { string_person_fullname };
397
421
  export type { string_person_profile };
398
422
  export type { string_license };
@@ -435,6 +459,9 @@ export type { number_megabytes };
435
459
  export type { number_gigabytes };
436
460
  export type { number_terabytes };
437
461
  export type { Registered };
462
+ export type { Registration };
463
+ export type { IExecCommandOptions };
464
+ export type { IExecCommandOptionsAdvanced };
438
465
  export type { FromtoItems };
439
466
  export type { CodeBlock };
440
467
  export type { MarkdownSection };
@@ -445,6 +472,7 @@ export type { string_camelCase };
445
472
  export type { string_PascalCase };
446
473
  export type { string_SCREAMING_CASE };
447
474
  export type { string_snake_case };
475
+ export type { empty_object };
448
476
  export type { really_any };
449
477
  export type { TODO_any };
450
478
  export type { string_promptbook_version };