@promptbook/remote-server 0.72.0-0 → 0.72.0-10

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 (247) hide show
  1. package/README.md +15 -6
  2. package/esm/index.es.js +154 -40
  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 +24 -0
  6. package/esm/typings/src/_packages/core.index.d.ts +47 -15
  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 +16 -6
  11. package/esm/typings/src/_packages/openai.index.d.ts +4 -0
  12. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  13. package/esm/typings/src/_packages/types.index.d.ts +61 -27
  14. package/esm/typings/src/_packages/utils.index.d.ts +4 -4
  15. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  16. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  17. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  18. package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
  19. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  20. package/esm/typings/src/cli/cli-commands/test-command.d.ts +13 -0
  21. package/esm/typings/src/cli/main.d.ts +1 -1
  22. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  23. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +11 -6
  24. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  25. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  26. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +3 -2
  27. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  28. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +2 -2
  29. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  30. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  31. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  32. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  33. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  34. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  35. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  36. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  37. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  38. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  39. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  40. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  41. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  42. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  43. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  44. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +16 -1
  45. package/esm/typings/src/config.d.ts +30 -1
  46. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +4 -15
  47. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  48. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -0
  49. package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts +2 -1
  50. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  51. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +10 -5
  52. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
  53. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +3 -3
  54. package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +6 -6
  55. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  56. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  57. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  58. package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
  59. package/esm/typings/src/execution/ExecutionTools.d.ts +29 -9
  60. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  61. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  62. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +9 -8
  63. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTemplateResult.d.ts +45 -0
  64. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +23 -0
  65. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +29 -0
  66. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  67. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +58 -0
  68. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +60 -0
  69. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  70. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +69 -0
  71. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  72. package/esm/typings/src/execution/createPipelineExecutor/getContextForTemplate.d.ts +10 -0
  73. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTemplate.d.ts +27 -0
  74. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTemplate.d.ts +30 -0
  75. package/esm/typings/src/execution/createPipelineExecutor/getSamplesForTemplate.d.ts +10 -0
  76. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  77. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +4 -0
  78. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  79. package/esm/typings/src/execution/utils/checkExpectations.d.ts +2 -0
  80. package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -0
  81. package/esm/typings/src/execution/utils/usageToHuman.d.ts +3 -4
  82. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +14 -15
  83. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  84. package/esm/typings/src/formats/csv/{ListFormatDefinition.d.ts → CsvFormatDefinition.d.ts} +6 -3
  85. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  86. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  87. package/esm/typings/src/formats/index.d.ts +1 -1
  88. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +4 -3
  89. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  90. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +4 -3
  91. package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
  92. package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
  93. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
  94. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  95. package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
  96. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromEnv.d.ts → register/$provideLlmToolsFromEnv.d.ts} +6 -5
  97. package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
  98. package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +5 -4
  99. package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
  100. package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
  101. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +5 -4
  102. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +5 -5
  103. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  104. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
  105. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
  106. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +6 -0
  107. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +4 -3
  108. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  109. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
  110. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
  111. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
  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 +3 -3
  114. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +3 -3
  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/OpenAiAssistantExecutionTools.d.ts +2 -2
  118. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +1 -1
  119. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +10 -1
  120. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +4 -4
  121. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  122. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  123. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +11 -1
  124. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +11 -1
  125. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +3 -3
  126. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +16 -7
  127. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +2 -2
  128. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +7 -13
  129. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +1 -1
  130. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +11 -16
  131. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +23 -9
  132. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  133. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
  134. package/esm/typings/src/personas/preparePersona.d.ts +3 -2
  135. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +68 -0
  136. package/esm/typings/src/prepare/preparePipeline.d.ts +3 -2
  137. package/esm/typings/src/prepare/prepareTemplates.d.ts +3 -2
  138. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  139. package/esm/typings/src/scrapers/_common/Scraper.d.ts +66 -0
  140. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  141. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +5 -4
  142. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  143. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  144. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  145. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
  146. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  147. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  148. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  149. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  150. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  151. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  152. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  153. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  154. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  155. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  156. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  157. package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
  158. package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
  159. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  160. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  161. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  162. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  163. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
  164. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
  165. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  166. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  167. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  168. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
  169. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
  170. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  171. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  172. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  173. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
  174. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
  175. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +47 -0
  176. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  177. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  178. package/esm/typings/src/scrapers/website/register-constructor.d.ts +13 -0
  179. package/esm/typings/src/scrapers/website/register-metadata.d.ts +24 -0
  180. package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +12 -0
  181. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  182. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +3 -3
  183. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +3 -3
  184. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +7 -5
  185. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  186. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +1 -1
  187. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  188. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  189. package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
  190. package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
  191. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +9 -2
  192. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -0
  193. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
  194. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +5 -0
  195. package/esm/typings/src/types/Prompt.d.ts +1 -0
  196. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  197. package/esm/typings/src/types/typeAliases.d.ts +27 -20
  198. package/esm/typings/src/utils/$Register.d.ts +19 -6
  199. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  200. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  201. package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts +23 -0
  202. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  203. package/esm/typings/src/utils/expectation-counters/index.d.ts +3 -0
  204. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  205. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  206. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  207. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  208. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  209. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  210. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  211. package/esm/typings/src/utils/organization/{f.d.ts → empty_object.d.ts} +5 -1
  212. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  213. package/esm/typings/src/utils/{extractParameterNames.d.ts → parameters/extractParameterNames.d.ts} +2 -2
  214. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  215. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  216. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  217. package/esm/typings/src/utils/{replaceParameters.d.ts → parameters/replaceParameters.d.ts} +2 -2
  218. package/esm/typings/src/utils/parameters/replaceParameters.test.d.ts +1 -0
  219. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  220. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  221. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  222. package/package.json +17 -13
  223. package/umd/index.umd.js +154 -40
  224. package/umd/index.umd.js.map +1 -1
  225. package/esm/typings/src/execution/createPipelineExecutor.d.ts +0 -72
  226. package/esm/typings/src/formats/list/ListFormatDefinition.d.ts +0 -16
  227. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  228. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  229. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  230. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  231. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +0 -22
  232. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  233. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  234. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +0 -15
  235. package/esm/typings/src/utils/files/$isFileExisting.d.ts +0 -14
  236. package/esm/typings/src/utils/files/$listAllFiles.d.ts +0 -17
  237. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  238. /package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.test.d.ts +0 -0
  239. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/MarkdownScraper.test.d.ts} +0 -0
  240. /package/esm/typings/src/{execution/utils/usageToHuman.test.d.ts → scrapers/website/WebsiteScraper.test.d.ts} +0 -0
  241. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → scrapers/website/utils/markdownConverter.test.d.ts} +0 -0
  242. /package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.test.d.ts +0 -0
  243. /package/esm/typings/src/utils/{extractParameterNames.test.d.ts → execCommand/execCommand.test.d.ts} +0 -0
  244. /package/esm/typings/src/utils/{files/$isDirectoryExisting.test.d.ts → execCommand/execCommandNormalizeOptions.test.d.ts} +0 -0
  245. /package/esm/typings/src/utils/files/{$isFileExisting.test.d.ts → extensionToMimeType.test.d.ts} +0 -0
  246. /package/esm/typings/src/utils/files/{$listAllFiles.test.d.ts → getFileExtension.test.d.ts} +0 -0
  247. /package/esm/typings/src/utils/{replaceParameters.test.d.ts → files/isDirectoryExisting.test.d.ts} +0 -0
@@ -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,5 +1,5 @@
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
  * @@@
@@ -10,13 +10,14 @@ export type LlmToolsConfiguration = Array<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,9 @@
1
- import { MultipleLlmExecutionTools } from '../multiple/MultipleLlmExecutionTools';
1
+ import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
2
2
  import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
3
3
  /**
4
- * Options for `createLlmToolsFromEnv`
4
+ * Options for `$provideLlmToolsFromEnv`
5
5
  *
6
- * @private internal type for `createLlmToolsFromEnv` and `getLlmToolsForTestingAndScriptsAndPlayground`
6
+ * @private internal type for `$provideLlmToolsFromEnv` and `$provideLlmToolsForTestingAndScriptsAndPlayground`
7
7
  */
8
8
  export type CreateLlmToolsFromConfigurationOptions = {
9
9
  /**
@@ -23,10 +23,11 @@ export type CreateLlmToolsFromConfigurationOptions = {
23
23
  */
24
24
  export declare function createLlmToolsFromConfiguration(configuration: LlmToolsConfiguration, options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
25
25
  /**
26
- * TODO: [🎌] Togethere with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
26
+ * TODO: [🎌] Together with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
27
27
  * TODO: [🧠][🎌] Dynamically install required providers
28
28
  * TODO: @@@ write discussion about this - wizzard
29
29
  * TODO: [🧠][🍛] Which name is better `createLlmToolsFromConfig` or `createLlmToolsFromConfiguration`?
30
30
  * TODO: [🧠] Is there some meaningfull way how to test this util
31
31
  * TODO: This should be maybe not under `_common` but under `utils`
32
+ * TODO: [®] DRY Register logic
32
33
  */
@@ -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
  */
@@ -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
  */
@@ -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
+ */
@@ -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
  /**
@@ -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
  /**
@@ -16,6 +16,7 @@ import type { string_title } from '../../types/typeAliases';
16
16
  *
17
17
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
18
18
  * @public exported from `@promptbook/types`
19
+ * TODO: !!!!!! Export as runtime class not just type
19
20
  */
20
21
  export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
21
22
  /**
@@ -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,13 +14,13 @@ 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
  *
21
21
  * @param options which are relevant are directly passed to the OpenAI client
22
22
  */
23
- constructor(options?: OpenAiAssistantExecutionToolsOptions);
23
+ constructor(options: OpenAiAssistantExecutionToolsOptions);
24
24
  get title(): string_title & string_markdown_text;
25
25
  get description(): string_markdown;
26
26
  /**
@@ -10,5 +10,5 @@ export type OpenAiAssistantExecutionToolsOptions = OpenAiExecutionToolsOptions &
10
10
  /**
11
11
  * Which assistant to use
12
12
  */
13
- assistantId?: string_token;
13
+ assistantId: string_token;
14
14
  };
@@ -8,6 +8,8 @@ import type { Prompt } from '../../types/Prompt';
8
8
  import type { string_markdown } from '../../types/typeAliases';
9
9
  import type { string_markdown_text } from '../../types/typeAliases';
10
10
  import type { string_title } from '../../types/typeAliases';
11
+ import type { string_token } from '../../types/typeAliases';
12
+ import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
11
13
  import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
12
14
  /**
13
15
  * Execution Tools for calling OpenAI API
@@ -25,10 +27,17 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
25
27
  *
26
28
  * @param options which are relevant are directly passed to the OpenAI client
27
29
  */
28
- constructor(options?: OpenAiExecutionToolsOptions);
30
+ constructor(options: OpenAiExecutionToolsOptions);
29
31
  get title(): string_title & string_markdown_text;
30
32
  get description(): string_markdown;
31
33
  getClient(): Promise<OpenAI>;
34
+ /**
35
+ * Create (sub)tools for calling OpenAI API Assistants
36
+ *
37
+ * @param assistantId Which assistant to use
38
+ * @returns Tools for calling OpenAI API Assistants with same token
39
+ */
40
+ createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools;
32
41
  /**
33
42
  * Check the `options` passed to `constructor`
34
43
  */
@@ -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
  };
@@ -0,0 +1,15 @@
1
+ import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
2
+ import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
3
+ /**
4
+ * Execution Tools for calling OpenAI API
5
+ *
6
+ * @public exported from `@promptbook/openai`
7
+ */
8
+ export declare const createOpenAiAssistantExecutionTools: ((options: OpenAiAssistantExecutionToolsOptions) => OpenAiAssistantExecutionTools) & {
9
+ packageName: string;
10
+ className: string;
11
+ };
12
+ /**
13
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
14
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
15
+ */
@@ -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,3 +1,13 @@
1
+ import type { Registration } from '../../utils/$Register';
2
+ /**
3
+ * Registration of LLM provider metadata
4
+ *
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
6
+ *
7
+ * @public exported from `@promptbook/core`
8
+ * @public exported from `@promptbook/cli`
9
+ */
10
+ export declare const _OpenAiMetadataRegistration: Registration;
1
11
  /**
2
12
  * @@@ registration1 of default configuration for Open AI
3
13
  *
@@ -6,4 +16,4 @@
6
16
  * @public exported from `@promptbook/core`
7
17
  * @public exported from `@promptbook/cli`
8
18
  */
9
- export declare const _OpenAiMetadataRegistration: void;
19
+ export declare const _OpenAiAssistantMetadataRegistration: Registration;
@@ -1,3 +1,13 @@
1
+ import type { Registration } from '../../utils/$Register';
2
+ /**
3
+ * Registration of LLM provider
4
+ *
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
6
+ *
7
+ * @public exported from `@promptbook/openai`
8
+ * @public exported from `@promptbook/cli`
9
+ */
10
+ export declare const _OpenAiRegistration: Registration;
1
11
  /**
2
12
  * @@@ registration2
3
13
  *
@@ -6,7 +16,7 @@
6
16
  * @public exported from `@promptbook/openai`
7
17
  * @public exported from `@promptbook/cli`
8
18
  */
9
- export declare const _OpenAiRegistration: void;
19
+ export declare const _OpenAiAssistantRegistration: Registration;
10
20
  /**
11
21
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
12
22
  */
@@ -19,9 +19,9 @@ import type { RemoteLlmExecutionToolsOptions } from './interfaces/RemoteLlmExecu
19
19
  * @see https://github.com/webgptorg/promptbook#remote-server
20
20
  * @public exported from `@promptbook/remote-client`
21
21
  */
22
- export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
23
- protected readonly options: RemoteLlmExecutionToolsOptions;
24
- constructor(options: RemoteLlmExecutionToolsOptions);
22
+ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> implements LlmExecutionTools {
23
+ protected readonly options: RemoteLlmExecutionToolsOptions<TCustomOptions>;
24
+ constructor(options: RemoteLlmExecutionToolsOptions<TCustomOptions>);
25
25
  get title(): string_title & string_markdown_text;
26
26
  get description(): string_markdown;
27
27
  /**
@@ -1,21 +1,30 @@
1
- import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
1
+ import type { string_user_id } from '../../../types/typeAliases';
2
+ import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
3
+ import type { CollectionRemoteServerClientOptions } from './RemoteServerOptions';
2
4
  /**
3
5
  * Socket.io progress for remote text generation
4
6
  *
5
7
  * This is a request from client to server
6
8
  */
7
- export type PromptbookServer_ListModels_Request = PromptbookServer_ListModels_CollectionRequest | PromptbookServer_ListModels_AnonymousRequest;
8
- export type PromptbookServer_ListModels_CollectionRequest = {
9
+ export type PromptbookServer_ListModels_Request<TCustomOptions> = PromptbookServer_ListModels_CollectionRequest<TCustomOptions> | PromptbookServer_ListModels_AnonymousRequest;
10
+ export type PromptbookServer_ListModels_CollectionRequest<TCustomOptions> = CollectionRemoteServerClientOptions<TCustomOptions> & {
9
11
  /**
10
- * Collection mode
12
+ * Application mode
11
13
  */
12
- isAnonymous: false;
14
+ readonly isAnonymous: false;
13
15
  };
14
16
  export type PromptbookServer_ListModels_AnonymousRequest = {
15
17
  /**
16
18
  * Anonymous mode
17
19
  */
18
- isAnonymous: true;
20
+ readonly isAnonymous: true;
21
+ /**
22
+ * Identifier of the end user
23
+ *
24
+ * Note: this is passed to the certain model providers to identify misuse
25
+ * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
26
+ */
27
+ readonly userId: string_user_id | null;
19
28
  /**
20
29
  * Configuration for the LLM tools
21
30
  */
@@ -24,6 +33,6 @@ export type PromptbookServer_ListModels_AnonymousRequest = {
24
33
  /**
25
34
  * TODO: [👡] DRY `PromptbookServer_Prompt_Request` and `PromptbookServer_ListModels_Request`
26
35
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
27
- * TODO: [🧠][🤺] Pass `userId` in `PromptbookServer_ListModels_Request`
36
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt - Pass `userId` in `PromptbookServer_ListModels_Request`
28
37
  * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
29
38
  */
@@ -8,8 +8,8 @@ export interface PromptbookServer_ListModels_Response {
8
8
  /**
9
9
  * Available models that can be used
10
10
  */
11
- models: Array<AvailableModel>;
11
+ readonly models: Array<AvailableModel>;
12
12
  }
13
13
  /**
14
14
  * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
15
- */
15
+ */
@@ -1,24 +1,18 @@
1
1
  import type { Prompt } from '../../../types/Prompt';
2
2
  import type { string_user_id } from '../../../types/typeAliases';
3
- import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
3
+ import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
4
+ import type { CollectionRemoteServerClientOptions } from './RemoteServerOptions';
4
5
  /**
5
6
  * Socket.io progress for remote text generation
6
7
  *
7
8
  * This is a request from client to server
8
9
  */
9
- export type PromptbookServer_Prompt_Request = PromptbookServer_Prompt_CollectionRequest | PromptbookServer_Prompt_AnonymousRequest;
10
- export type PromptbookServer_Prompt_CollectionRequest = {
10
+ export type PromptbookServer_Prompt_Request<TCustomOptions> = PromptbookServer_Prompt_CollectionRequest<TCustomOptions> | PromptbookServer_Prompt_AnonymousRequest;
11
+ export type PromptbookServer_Prompt_CollectionRequest<TCustomOptions> = CollectionRemoteServerClientOptions<TCustomOptions> & {
11
12
  /**
12
- * Collection mode
13
+ * Application mode
13
14
  */
14
15
  readonly isAnonymous: false;
15
- /**
16
- * Identifier of the end user
17
- *
18
- * Note: this is passed to the certain model providers to identify misuse
19
- * Note: In anonymous mode it is not required to identify
20
- */
21
- readonly userId: string_user_id;
22
16
  /**
23
17
  * The Prompt to execute
24
18
  */
@@ -33,9 +27,9 @@ export type PromptbookServer_Prompt_AnonymousRequest = {
33
27
  * Identifier of the end user
34
28
  *
35
29
  * Note: this is passed to the certain model providers to identify misuse
36
- * Note: In anonymous mode it is not required to identify
30
+ * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
37
31
  */
38
- readonly userId?: string_user_id;
32
+ readonly userId: string_user_id | null;
39
33
  /**
40
34
  * Configuration for the LLM tools
41
35
  */
@@ -8,5 +8,5 @@ export interface PromptbookServer_Prompt_Response {
8
8
  /**
9
9
  * The result of the prompt
10
10
  */
11
- promptResult: PromptResult;
11
+ readonly promptResult: PromptResult;
12
12
  }