@promptbook/browser 0.72.0-3 → 0.72.0-30

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 (263) hide show
  1. package/README.md +11 -1
  2. package/esm/index.es.js +247 -6
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/browser.index.d.ts +3 -1
  5. package/esm/typings/src/_packages/cli.index.d.ts +20 -0
  6. package/esm/typings/src/_packages/core.index.d.ts +56 -28
  7. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  8. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  9. package/esm/typings/src/_packages/markdown-utils.index.d.ts +6 -0
  10. package/esm/typings/src/_packages/node.index.d.ts +18 -6
  11. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  12. package/esm/typings/src/_packages/types.index.d.ts +57 -33
  13. package/esm/typings/src/_packages/utils.index.d.ts +2 -2
  14. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  15. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  16. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  17. package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
  18. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  19. package/esm/typings/src/cli/cli-commands/test-command.d.ts +13 -0
  20. package/esm/typings/src/cli/main.d.ts +1 -1
  21. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  22. package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
  23. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +2 -2
  24. package/esm/typings/src/collection/collectionToJson.d.ts +1 -1
  25. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +11 -6
  26. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +1 -1
  27. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +1 -1
  28. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  29. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  30. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +5 -1
  31. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +1 -1
  32. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  33. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  34. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  35. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  36. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  37. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  38. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  39. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  40. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  41. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  42. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  43. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  44. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  45. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  46. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  47. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +5 -5
  48. package/esm/typings/src/config.d.ts +35 -12
  49. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +4 -15
  50. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  51. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  52. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +5 -5
  53. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
  54. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +3 -3
  55. package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +6 -6
  56. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  57. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  58. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  59. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  60. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  61. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  62. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  63. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  64. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  65. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  66. package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
  67. package/esm/typings/src/execution/EmbeddingVector.d.ts +1 -1
  68. package/esm/typings/src/execution/Executables.d.ts +18 -0
  69. package/esm/typings/src/execution/ExecutionTools.d.ts +35 -9
  70. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  71. package/esm/typings/src/execution/LlmExecutionTools.d.ts +2 -2
  72. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  73. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
  74. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +3 -2
  75. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +31 -5
  76. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +3 -0
  77. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +6 -12
  78. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +7 -18
  79. package/esm/typings/src/execution/createPipelineExecutor/{30-executeFormatCells.d.ts → 30-executeFormatSubvalues.d.ts} +2 -6
  80. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +9 -19
  81. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  82. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -3
  83. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +4 -0
  84. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  85. package/esm/typings/src/execution/utils/addUsage.d.ts +1 -1
  86. package/esm/typings/src/execution/utils/forEachAsync.d.ts +2 -1
  87. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
  88. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +3 -2
  89. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  90. package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
  91. package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
  92. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
  93. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  94. package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
  95. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromEnv.d.ts → register/$provideLlmToolsFromEnv.d.ts} +6 -5
  96. package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
  97. package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +6 -5
  98. package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
  99. package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
  100. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +12 -4
  101. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +4 -1
  102. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
  103. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +5 -5
  104. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  105. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  106. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
  107. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
  108. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +7 -1
  109. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +4 -3
  110. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  111. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
  112. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
  113. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
  114. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
  115. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
  116. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +4 -4
  117. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +4 -4
  118. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +4 -4
  119. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +1 -1
  120. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
  121. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +1 -2
  122. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -2
  123. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +4 -4
  124. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  125. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  126. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +5 -4
  127. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +5 -4
  128. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +4 -4
  129. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +16 -7
  130. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +4 -4
  131. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +7 -13
  132. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +3 -3
  133. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +11 -16
  134. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +24 -9
  135. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  136. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
  137. package/esm/typings/src/personas/preparePersona.d.ts +3 -2
  138. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +49 -0
  139. package/esm/typings/src/prepare/preparePipeline.d.ts +3 -2
  140. package/esm/typings/src/prepare/prepareTemplates.d.ts +4 -3
  141. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  142. package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
  143. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  144. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +5 -4
  145. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  146. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  147. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  148. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
  149. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  150. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  151. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  152. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  153. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  154. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  155. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  156. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  157. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  158. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  159. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  160. package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
  161. package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
  162. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  163. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  164. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  165. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  166. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
  167. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
  168. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  169. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  170. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  171. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
  172. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
  173. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  174. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  175. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  176. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
  177. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
  178. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  179. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  180. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  181. package/esm/typings/src/scrapers/website/register-constructor.d.ts +13 -0
  182. package/esm/typings/src/scrapers/website/register-metadata.d.ts +24 -0
  183. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  184. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  185. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -1
  186. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +3 -3
  187. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +3 -3
  188. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +7 -5
  189. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  190. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +2 -2
  191. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  192. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  193. package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
  194. package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
  195. package/esm/typings/src/types/Arrayable.d.ts +1 -1
  196. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  197. package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +4 -4
  198. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +10 -3
  199. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -1
  200. package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
  201. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
  202. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +2 -2
  203. package/esm/typings/src/types/Prompt.d.ts +2 -1
  204. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -4
  205. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  206. package/esm/typings/src/types/typeAliases.d.ts +27 -20
  207. package/esm/typings/src/utils/$Register.d.ts +20 -7
  208. package/esm/typings/src/utils/FromtoItems.d.ts +1 -1
  209. package/esm/typings/src/utils/arrayableToArray.d.ts +1 -1
  210. package/esm/typings/src/utils/emojis.d.ts +1 -1
  211. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  212. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  213. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +19 -0
  214. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  215. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  216. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  217. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
  218. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  219. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  220. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  221. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  222. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  223. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  224. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  225. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  226. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  227. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  228. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  229. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
  230. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
  231. package/esm/typings/src/utils/normalization/IKeywords.d.ts +2 -2
  232. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +2 -2
  233. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +2 -2
  234. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +2 -2
  235. package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -1
  236. package/esm/typings/src/utils/organization/keepUnused.d.ts +1 -1
  237. package/esm/typings/src/utils/random/$randomSeed.d.ts +1 -1
  238. package/esm/typings/src/utils/sets/intersection.d.ts +1 -1
  239. package/esm/typings/src/utils/sets/union.d.ts +1 -1
  240. package/esm/typings/src/utils/unwrapResult.d.ts +4 -4
  241. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  242. package/package.json +4 -3
  243. package/umd/index.umd.js +247 -5
  244. package/umd/index.umd.js.map +1 -1
  245. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +0 -40
  246. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  247. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  248. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  249. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  250. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +0 -22
  251. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  252. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  253. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +0 -15
  254. package/esm/typings/src/utils/files/$isFileExisting.d.ts +0 -14
  255. package/esm/typings/src/utils/files/$listAllFiles.d.ts +0 -17
  256. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  257. /package/esm/typings/src/{knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts → executables/apps/locateLibreoffice.test.d.ts} +0 -0
  258. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → executables/apps/locatePandoc.test.d.ts} +0 -0
  259. /package/esm/typings/src/{storage/files-storage/utils/nameToSubfolderPath.test.d.ts → executables/locateApp.test.d.ts} +0 -0
  260. /package/esm/typings/src/{utils/files/$isDirectoryExisting.test.d.ts → scrapers/_common/prepareKnowledgePieces.test.d.ts} +0 -0
  261. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/MarkdownScraper.test.d.ts} +0 -0
  262. /package/esm/typings/src/{utils/files/$isFileExisting.test.d.ts → scrapers/website/utils/createShowdownConverter.test.d.ts} +0 -0
  263. /package/esm/typings/src/{utils/files/$listAllFiles.test.d.ts → storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts} +0 -0
@@ -0,0 +1,15 @@
1
+ import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
2
+ import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
3
+ /**
4
+ * Returns LLM tools for CLI
5
+ *
6
+ * @private within the repository - for CLI utils
7
+ */
8
+ export declare function $provideLlmToolsForCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): LlmExecutionToolsWithTotalUsage;
9
+ /**
10
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
11
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
12
+ * TODO: [🥃] Allow `ptbk make` without llm tools
13
+ * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
14
+ * TODO: [®] DRY Register logic
15
+ */
@@ -1,6 +1,6 @@
1
- import '../../_packages/cli.index';
1
+ import '../../../_packages/cli.index';
2
+ import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
2
3
  import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
3
- import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
4
4
  type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromConfigurationOptions & {
5
5
  /**
6
6
  * @@@
@@ -14,10 +14,11 @@ type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromCon
14
14
  *
15
15
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
16
16
  */
17
- export declare function getLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
17
+ export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
18
18
  export {};
19
19
  /**
20
20
  * Note: [⚪] This should never be in any released package
21
21
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
22
22
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
23
+ * TODO: [®] DRY Register logic
23
24
  */
@@ -1,4 +1,4 @@
1
- import { MultipleLlmExecutionTools } from '../multiple/MultipleLlmExecutionTools';
1
+ import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
2
2
  import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
3
3
  /**
4
4
  * @@@
@@ -14,12 +14,13 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
14
14
  * @returns @@@
15
15
  * @public exported from `@promptbook/node`
16
16
  */
17
- export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
17
+ export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
18
18
  /**
19
- * TODO: @@@ write `createLlmToolsFromEnv` vs `createLlmToolsFromConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
20
- * TODO: [🧠][🍛] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
19
+ * TODO: @@@ write `$provideLlmToolsFromEnv` vs `$provideLlmToolsConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
20
+ * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?
21
21
  * TODO: [🧠] Is there some meaningfull way how to test this util
22
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
22
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
23
23
  * TODO: [🥃] Allow `ptbk make` without llm tools
24
24
  * TODO: This should be maybe not under `_common` but under `utils`
25
+ * TODO: [®] DRY Register logic
25
26
  */
@@ -1,9 +1,12 @@
1
- import type { string_markdown } from '../../types/typeAliases';
1
+ import type { string_markdown } from '../../../types/typeAliases';
2
2
  /**
3
3
  * Creates a message with all registered LLM tools
4
4
  *
5
5
  * Note: This function is used to create a (error) message when there is no constructor for some LLM provider
6
6
  *
7
- * @private internal function of `createLlmToolsFromConfiguration` and `createLlmToolsFromEnv`
7
+ * @private internal function of `createLlmToolsFromConfiguration` and `$provideLlmToolsFromEnv`
8
8
  */
9
9
  export declare function $registeredLlmToolsMessage(): string_markdown;
10
+ /**
11
+ * TODO: [®] DRY Register logic
12
+ */
@@ -1,22 +1,23 @@
1
- import type { string_title } from '../../types/typeAliases';
2
- import type { Registered } from '../../utils/$Register';
1
+ import type { string_title } from '../../../types/typeAliases';
2
+ import type { Registered } from '../../../utils/$Register';
3
3
  import type { LlmToolsOptions } from './LlmToolsOptions';
4
4
  /**
5
5
  * @@@
6
6
  *
7
7
  * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
8
8
  */
9
- export type LlmToolsConfiguration = Array<Registered & {
9
+ export type LlmToolsConfiguration = ReadonlyArray<Registered & {
10
10
  /**
11
11
  * @@@
12
12
  */
13
- title: string_title;
13
+ readonly title: string_title;
14
14
  /**
15
15
  * @@@
16
16
  */
17
- options: LlmToolsOptions;
17
+ readonly options: LlmToolsOptions;
18
18
  }>;
19
19
  /**
20
20
  * TODO: [🧠][🌰] `title` is redundant BUT maybe allow each provider pass it's own title for tracking purposes
21
21
  * TODO: Maybe instead of `LlmToolsConfiguration[number]` make `LlmToolsConfigurationItem`
22
+ * TODO: [®] DRY Register logic
22
23
  */
@@ -1,6 +1,6 @@
1
- import type { string_name } from '../../types/typeAliases';
2
- import type { string_title } from '../../types/typeAliases';
3
- import type { Registered } from '../../utils/$Register';
1
+ import type { string_name } from '../../../types/typeAliases';
2
+ import type { string_title } from '../../../types/typeAliases';
3
+ import type { Registered } from '../../../utils/$Register';
4
4
  import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
5
5
  /**
6
6
  * @@@
@@ -11,7 +11,7 @@ export type LlmToolsMetadata = Registered & {
11
11
  /**
12
12
  * @@@
13
13
  */
14
- title: string_title;
14
+ readonly title: string_title;
15
15
  /**
16
16
  * @@@
17
17
  */
@@ -24,4 +24,5 @@ export type LlmToolsMetadata = Registered & {
24
24
  /**
25
25
  * TODO: Add configuration schema and maybe some documentation link
26
26
  * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
27
+ * TODO: [®] DRY Register logic
27
28
  */
@@ -1,7 +1,10 @@
1
- import type { TODO_object } from '../../utils/organization/TODO_object';
1
+ import type { TODO_object } from '../../../utils/organization/TODO_object';
2
2
  /**
3
3
  * @@@
4
4
  *
5
5
  * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
6
6
  */
7
7
  export type LlmToolsOptions = TODO_object;
8
+ /**
9
+ * TODO: [®] DRY Register logic
10
+ */
@@ -1,9 +1,10 @@
1
- import { MultipleLlmExecutionTools } from '../multiple/MultipleLlmExecutionTools';
1
+ import type { string_user_id } from '../../../types/typeAliases';
2
+ import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
2
3
  import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
3
4
  /**
4
- * Options for `createLlmToolsFromEnv`
5
+ * Options for `$provideLlmToolsFromEnv`
5
6
  *
6
- * @private internal type for `createLlmToolsFromEnv` and `getLlmToolsForTestingAndScriptsAndPlayground`
7
+ * @private internal type for `$provideLlmToolsFromEnv` and `$provideLlmToolsForTestingAndScriptsAndPlayground`
7
8
  */
8
9
  export type CreateLlmToolsFromConfigurationOptions = {
9
10
  /**
@@ -12,6 +13,12 @@ export type CreateLlmToolsFromConfigurationOptions = {
12
13
  * @default false
13
14
  */
14
15
  isVerbose?: boolean;
16
+ /**
17
+ * Identifier of the end user
18
+ *
19
+ * Note: This is passed to the LLM tools providers to identify misuse
20
+ */
21
+ readonly userId?: string_user_id | null;
15
22
  };
16
23
  /**
17
24
  * @@@
@@ -23,10 +30,11 @@ export type CreateLlmToolsFromConfigurationOptions = {
23
30
  */
24
31
  export declare function createLlmToolsFromConfiguration(configuration: LlmToolsConfiguration, options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
25
32
  /**
26
- * TODO: [🎌] Togethere with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
33
+ * TODO: [🎌] Together with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
27
34
  * TODO: [🧠][🎌] Dynamically install required providers
28
35
  * TODO: @@@ write discussion about this - wizzard
29
36
  * TODO: [🧠][🍛] Which name is better `createLlmToolsFromConfig` or `createLlmToolsFromConfiguration`?
30
37
  * TODO: [🧠] Is there some meaningfull way how to test this util
31
38
  * TODO: This should be maybe not under `_common` but under `utils`
39
+ * TODO: [®] DRY Register logic
32
40
  */
@@ -1,5 +1,8 @@
1
1
  import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
2
2
  import type { CacheItem } from './CacheItem';
3
+ /**
4
+ * @@@
5
+ */
3
6
  export type CacheLlmToolsOptions = {
4
7
  /**
5
8
  * @@@
@@ -12,5 +15,5 @@ export type CacheLlmToolsOptions = {
12
15
  *
13
16
  * @default false
14
17
  */
15
- isReloaded?: boolean;
18
+ isCacheReloaded?: boolean;
16
19
  };
@@ -35,7 +35,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
35
35
  /**
36
36
  * List all available Anthropic Claude models that can be used
37
37
  */
38
- listModels(): Array<AvailableModel>;
38
+ listModels(): ReadonlyArray<AvailableModel>;
39
39
  /**
40
40
  * Calls Anthropic Claude API to use a chat model.
41
41
  */
@@ -1,5 +1,5 @@
1
1
  import type { ClientOptions } from '@anthropic-ai/sdk';
2
- import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
3
  import type { RemoteLlmExecutionToolsOptions } from '../remote/interfaces/RemoteLlmExecutionToolsOptions';
4
4
  /**
5
5
  * Options for `AnthropicClaudeExecutionTools`
@@ -14,7 +14,7 @@ export type AnthropicClaudeExecutionToolsOptions = AnthropicClaudeExecutionTools
14
14
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
15
15
  * @public exported from `@promptbook/anthropic-claude`
16
16
  */
17
- export type AnthropicClaudeExecutionToolsDirectOptions = CommonExecutionToolsOptions & ClientOptions & {
17
+ export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & ClientOptions & {
18
18
  isProxied?: false;
19
19
  };
20
20
  /**
@@ -23,9 +23,9 @@ export type AnthropicClaudeExecutionToolsDirectOptions = CommonExecutionToolsOpt
23
23
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
24
24
  * @public exported from `@promptbook/anthropic-claude`
25
25
  */
26
- export type AnthropicClaudeExecutionToolsProxiedOptions = CommonExecutionToolsOptions & ClientOptions & {
26
+ export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
27
27
  isProxied: true;
28
- } & Pick<RemoteLlmExecutionToolsOptions, 'remoteUrl' | 'path'>;
28
+ } & Pick<RemoteLlmExecutionToolsOptions<undefined>, 'remoteUrl' | 'path'>;
29
29
  /**
30
- * TODO: [🧠][🤺] Detecting `user`
30
+ * TODO: [🧠][🤺] Pass `userId`
31
31
  */
@@ -8,7 +8,7 @@ import type { number_usd } from '../../types/typeAliases';
8
8
  * @see https://docs.anthropic.com/en/docs/models-overview
9
9
  * @public exported from `@promptbook/anthropic-claude`
10
10
  */
11
- export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
11
+ export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
12
12
  pricing?: {
13
13
  readonly prompt: number_usd;
14
14
  readonly output: number_usd;
@@ -1,6 +1,7 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
3
  /**
4
- * TODO:[main] !!! Playground with WebGPT / Promptbook.studio anonymous server
5
- * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
4
+ * TODO: [main] !!! Playground with WebGPT / Promptbook.studio anonymous server
5
+ * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
6
+ * Note: [⚫] Code in this file should never be published in any package
6
7
  */
@@ -1,9 +1,10 @@
1
+ import type { Registration } from '../../utils/$Register';
1
2
  /**
2
- * @@@ registration1 of default configuration for Anthropic Claude
3
+ * Registration of LLM provider metadata
3
4
  *
4
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
5
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
5
6
  *
6
7
  * @public exported from `@promptbook/core`
7
8
  * @public exported from `@promptbook/cli`
8
9
  */
9
- export declare const _AnthropicClaudeMetadataRegistration: void;
10
+ export declare const _AnthropicClaudeMetadataRegistration: Registration;
@@ -1,12 +1,13 @@
1
+ import type { Registration } from '../../utils/$Register';
1
2
  /**
2
- * @@@ registration2
3
+ * Registration of LLM provider
3
4
  *
4
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
5
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
5
6
  *
6
7
  * @public exported from `@promptbook/anthropic-claude`
7
8
  * @public exported from `@promptbook/cli`
8
9
  */
9
- export declare const _AnthropicClaudeRegistration: void;
10
+ export declare const _AnthropicClaudeRegistration: Registration;
10
11
  /**
11
12
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
12
13
  */
@@ -35,7 +35,7 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
35
35
  /**
36
36
  * List all available Azure OpenAI models that can be used
37
37
  */
38
- listModels(): Promise<Array<AvailableModel>>;
38
+ listModels(): Promise<ReadonlyArray<AvailableModel>>;
39
39
  /**
40
40
  * Calls OpenAI API to use a chat model.
41
41
  */
@@ -44,6 +44,12 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
44
44
  * Calls Azure OpenAI API to use a complete model.
45
45
  */
46
46
  callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
47
+ /**
48
+ * Library `@azure/openai` has bug/weird behavior that it does not throw error but hangs forever
49
+ *
50
+ * This method wraps the promise with timeout
51
+ */
52
+ private withTimeout;
47
53
  /**
48
54
  * Changes Azure error (which is not propper Error but object) to propper Error
49
55
  */
@@ -1,13 +1,14 @@
1
- import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
1
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
2
2
  import type { string_name } from '../../types/typeAliases';
3
3
  import type { string_token } from '../../types/typeAliases';
4
+ import type { string_user_id } from '../../types/typeAliases';
4
5
  /**
5
6
  * Options for `AzureOpenAiExecutionTools`
6
7
  *
7
8
  * @see https://oai.azure.com/portal/
8
9
  * @public exported from `@promptbook/azure-openai`
9
10
  */
10
- export type AzureOpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
11
+ export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
11
12
  /**
12
13
  * The resource name of the Azure OpenAI resource
13
14
  *
@@ -32,5 +33,5 @@ export type AzureOpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
32
33
  *
33
34
  * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids (document from OpenAI not Azure, but same concept)
34
35
  */
35
- readonly user?: string_token;
36
+ readonly userId: string_user_id | null;
36
37
  };
@@ -2,4 +2,5 @@
2
2
  export {};
3
3
  /**
4
4
  * TODO: Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
+ * Note: [⚫] Code in this file should never be published in any package
5
6
  */
@@ -1,9 +1,10 @@
1
+ import type { Registration } from '../../utils/$Register';
1
2
  /**
2
- * @@@ registration1 of default configuration for Azure Open AI
3
+ * Registration of LLM provider metadata
3
4
  *
4
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
5
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
5
6
  *
6
7
  * @public exported from `@promptbook/core`
7
8
  * @public exported from `@promptbook/cli`
8
9
  */
9
- export declare const _AzureOpenAiMetadataRegistration: void;
10
+ export declare const _AzureOpenAiMetadataRegistration: Registration;
@@ -1,12 +1,13 @@
1
+ import type { Registration } from '../../utils/$Register';
1
2
  /**
2
- * @@@ registration2
3
+ * Registration of LLM provider
3
4
  *
4
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
5
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
5
6
  *
6
7
  * @public exported from `@promptbook/azure-openai`
7
8
  * @public exported from `@promptbook/cli`
8
9
  */
9
- export declare const _AzureOpenAiRegistration: void;
10
+ export declare const _AzureOpenAiRegistration: Registration;
10
11
  /**
11
12
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
12
13
  */
@@ -14,4 +14,4 @@ export declare class LangtailExecutionTools extends OpenAiExecutionTools impleme
14
14
  }
15
15
  /**
16
16
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
17
- */
17
+ */
@@ -1,2 +1,5 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
+ /**
4
+ * Note: [⚫] Code in this file should never be published in any package
5
+ */
@@ -9,7 +9,7 @@ import type { string_postprocessing_function_name } from '../../types/typeAliase
9
9
  *
10
10
  * @private internal utility for MockedFackedLlmExecutionTools
11
11
  */
12
- export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: Array<string_postprocessing_function_name>): Promise<string>;
12
+ export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>): Promise<string>;
13
13
  /**
14
14
  * TODO: [💝] Unite object for expecting amount and format - use here also a format
15
15
  */
@@ -1,5 +1,5 @@
1
1
  import type { AvailableModel } from '../../execution/AvailableModel';
2
- import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
3
  import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
4
4
  import type { ChatPromptResult } from '../../execution/PromptResult';
5
5
  import type { CompletionPromptResult } from '../../execution/PromptResult';
@@ -13,8 +13,8 @@ import type { string_title } from '../../types/typeAliases';
13
13
  * @public exported from `@promptbook/fake-llm`
14
14
  */
15
15
  export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
16
- protected readonly options: CommonExecutionToolsOptions;
17
- constructor(options?: CommonExecutionToolsOptions);
16
+ protected readonly options: CommonToolsOptions;
17
+ constructor(options?: CommonToolsOptions);
18
18
  get title(): string_title & string_markdown_text;
19
19
  get description(): string_markdown;
20
20
  /**
@@ -24,7 +24,7 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
24
24
  /**
25
25
  * List all available mocked-models that can be used
26
26
  */
27
- listModels(): Array<AvailableModel>;
27
+ listModels(): ReadonlyArray<AvailableModel>;
28
28
  /**
29
29
  * Mocks chat model
30
30
  */
@@ -1,5 +1,5 @@
1
1
  import type { AvailableModel } from '../../execution/AvailableModel';
2
- import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
3
  import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
4
4
  import type { ChatPromptResult } from '../../execution/PromptResult';
5
5
  import type { CompletionPromptResult } from '../../execution/PromptResult';
@@ -14,8 +14,8 @@ import type { string_title } from '../../types/typeAliases';
14
14
  * @public exported from `@promptbook/fake-llm`
15
15
  */
16
16
  export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
17
- protected readonly options: CommonExecutionToolsOptions;
18
- constructor(options?: CommonExecutionToolsOptions);
17
+ protected readonly options: CommonToolsOptions;
18
+ constructor(options?: CommonToolsOptions);
19
19
  get title(): string_title & string_markdown_text;
20
20
  get description(): string_markdown;
21
21
  /**
@@ -25,7 +25,7 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
25
25
  /**
26
26
  * List all available fake-models that can be used
27
27
  */
28
- listModels(): Array<AvailableModel>;
28
+ listModels(): ReadonlyArray<AvailableModel>;
29
29
  /**
30
30
  * Fakes chat model
31
31
  */
@@ -15,17 +15,17 @@ import type { string_title } from '../../types/typeAliases';
15
15
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
16
16
  *
17
17
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
18
- * @public exported from `@promptbook/types`
18
+ * @public exported from `@promptbook/core`
19
19
  */
20
20
  export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
21
21
  /**
22
22
  * Array of execution tools in order of priority
23
23
  */
24
- readonly llmExecutionTools: Array<LlmExecutionTools>;
24
+ readonly llmExecutionTools: ReadonlyArray<LlmExecutionTools>;
25
25
  /**
26
26
  * Gets array of execution tools in order of priority
27
27
  */
28
- constructor(...llmExecutionTools: Array<LlmExecutionTools>);
28
+ constructor(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>);
29
29
  get title(): string_title & string_markdown_text;
30
30
  get description(): string_markdown;
31
31
  /**
@@ -36,7 +36,7 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
36
36
  * List all available models that can be used
37
37
  * This lists is a combination of all available models from all execution tools
38
38
  */
39
- listModels(): Promise<Array<AvailableModel>>;
39
+ listModels(): Promise<ReadonlyArray<AvailableModel>>;
40
40
  /**
41
41
  * Calls the best available chat model
42
42
  */
@@ -15,7 +15,7 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
15
15
  *
16
16
  * @public exported from `@promptbook/core`
17
17
  */
18
- export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;
18
+ export declare function joinLlmExecutionTools(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
19
19
  /**
20
20
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
21
21
  */
@@ -1,2 +1,5 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
+ /**
4
+ * Note: [⚫] Code in this file should never be published in any package
5
+ */
@@ -14,7 +14,7 @@ import { OpenAiExecutionTools } from './OpenAiExecutionTools';
14
14
  * @public exported from `@promptbook/openai`
15
15
  */
16
16
  export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
17
- private readonly assistantId?;
17
+ private readonly assistantId;
18
18
  /**
19
19
  * Creates OpenAI Execution Tools.
20
20
  *
@@ -29,7 +29,6 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
29
29
  callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
30
30
  }
31
31
  /**
32
- * TODO: !!!!!! DO not use colors - can be used in browser
33
32
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
34
33
  * TODO: Maybe make custom OpenAiError
35
34
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
@@ -27,7 +27,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
27
27
  *
28
28
  * @param options which are relevant are directly passed to the OpenAI client
29
29
  */
30
- constructor(options?: OpenAiExecutionToolsOptions);
30
+ constructor(options: OpenAiExecutionToolsOptions);
31
31
  get title(): string_title & string_markdown_text;
32
32
  get description(): string_markdown;
33
33
  getClient(): Promise<OpenAI>;
@@ -45,7 +45,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
45
45
  /**
46
46
  * List all available OpenAI models that can be used
47
47
  */
48
- listModels(): Array<AvailableModel>;
48
+ listModels(): ReadonlyArray<AvailableModel>;
49
49
  /**
50
50
  * Calls OpenAI API to use a chat model.
51
51
  */
@@ -1,6 +1,6 @@
1
1
  import type { ClientOptions } from 'openai';
2
- import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
3
- import type { string_token } from '../../types/typeAliases';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
+ import type { string_user_id } from '../../types/typeAliases';
4
4
  /**
5
5
  * Options for `OpenAiExecutionTools`
6
6
  *
@@ -9,12 +9,12 @@ import type { string_token } from '../../types/typeAliases';
9
9
  *
10
10
  * @public exported from `@promptbook/openai`
11
11
  */
12
- export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions & {
12
+ export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions & {
13
13
  /**
14
14
  * A unique identifier representing your end-user, which can help OpenAI to monitor
15
15
  * and detect abuse.
16
16
  *
17
17
  * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
18
18
  */
19
- user?: string_token;
19
+ userId: string_user_id | null;
20
20
  };
@@ -9,7 +9,7 @@ import type { number_usd } from '../../types/typeAliases';
9
9
  * @see https://openai.com/api/pricing/
10
10
  * @public exported from `@promptbook/openai`
11
11
  */
12
- export declare const OPENAI_MODELS: Array<AvailableModel & {
12
+ export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
13
13
  pricing?: {
14
14
  readonly prompt: number_usd;
15
15
  readonly output: number_usd;
@@ -1,5 +1,6 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
3
  /**
4
- * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
4
+ * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
+ * Note: [⚫] Code in this file should never be published in any package
5
6
  */
@@ -1,12 +1,13 @@
1
+ import type { Registration } from '../../utils/$Register';
1
2
  /**
2
- * @@@ registration1 of default configuration for Open AI
3
+ * Registration of LLM provider metadata
3
4
  *
4
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
5
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
5
6
  *
6
7
  * @public exported from `@promptbook/core`
7
8
  * @public exported from `@promptbook/cli`
8
9
  */
9
- export declare const _OpenAiMetadataRegistration: void;
10
+ export declare const _OpenAiMetadataRegistration: Registration;
10
11
  /**
11
12
  * @@@ registration1 of default configuration for Open AI
12
13
  *
@@ -15,4 +16,4 @@ export declare const _OpenAiMetadataRegistration: void;
15
16
  * @public exported from `@promptbook/core`
16
17
  * @public exported from `@promptbook/cli`
17
18
  */
18
- export declare const _OpenAiAssistantMetadataRegistration: void;
19
+ export declare const _OpenAiAssistantMetadataRegistration: Registration;