@promptbook/utils 0.41.4 → 0.41.102

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 (360) hide show
  1. package/bin/promptbook-cli.js +6 -0
  2. package/esm/index.es.js +1719 -1681
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/_packages/core.index.d.ts +20 -20
  5. package/esm/typings/_packages/execute-javascript.index.d.ts +3 -3
  6. package/esm/typings/_packages/openai.index.d.ts +3 -3
  7. package/esm/typings/_packages/remote-client.index.d.ts +4 -4
  8. package/esm/typings/_packages/remote-server.index.d.ts +3 -3
  9. package/esm/typings/_packages/types.index.d.ts +27 -27
  10. package/esm/typings/_packages/utils.index.d.ts +38 -38
  11. package/esm/typings/_packages/wizzard.index.d.ts +5 -5
  12. package/esm/typings/config.d.ts +4 -4
  13. package/esm/typings/conversion/prettify/PrettifyOptions.d.ts +7 -7
  14. package/esm/typings/conversion/prettify/prettifyPromptbookString.d.ts +11 -10
  15. package/esm/typings/conversion/prettify/prettifyPromptbookStringCli.d.ts +9 -9
  16. package/esm/typings/conversion/promptbookStringToJson.d.ts +13 -13
  17. package/esm/typings/conversion/test/_importPromptbook.d.ts +12 -12
  18. package/esm/typings/conversion/test/promptbookStringToJson-syntaxErrors.test.d.ts +1 -1
  19. package/esm/typings/conversion/test/promptbookStringToJson.test.d.ts +1 -1
  20. package/esm/typings/conversion/test/validatePromptbookJson-logicErrors.test.d.ts +1 -1
  21. package/esm/typings/conversion/test/validatePromptbookJson.d.ts +26 -26
  22. package/esm/typings/conversion/test/validatePromptbookJson.test.d.ts +1 -1
  23. package/esm/typings/conversion/utils/extractVariables.d.ts +10 -10
  24. package/esm/typings/conversion/utils/extractVariables.test.d.ts +1 -1
  25. package/esm/typings/conversion/utils/parseCommand.d.ts +8 -8
  26. package/esm/typings/conversion/utils/parseCommand.test.d.ts +4 -4
  27. package/esm/typings/conversion/utils/parseNumber.d.ts +12 -12
  28. package/esm/typings/conversion/utils/parseNumber.test.d.ts +1 -1
  29. package/esm/typings/errors/ExpectError.d.ts +9 -9
  30. package/esm/typings/errors/NotFoundError.d.ts +7 -7
  31. package/esm/typings/errors/PromptbookExecutionError.d.ts +7 -7
  32. package/esm/typings/errors/PromptbookLogicError.d.ts +7 -7
  33. package/esm/typings/errors/PromptbookReferenceError.d.ts +7 -7
  34. package/esm/typings/errors/PromptbookSyntaxError.d.ts +7 -7
  35. package/esm/typings/errors/UnexpectedError.d.ts +7 -7
  36. package/esm/typings/execution/CommonExecutionToolsOptions.d.ts +9 -9
  37. package/esm/typings/execution/ExecutionTools.d.ts +25 -25
  38. package/esm/typings/execution/NaturalExecutionTools.d.ts +23 -23
  39. package/esm/typings/execution/PromptResult.d.ts +74 -74
  40. package/esm/typings/execution/PromptbookExecutor.d.ts +39 -39
  41. package/esm/typings/execution/ScriptExecutionTools.d.ts +37 -37
  42. package/esm/typings/execution/UserInterfaceTools.d.ts +45 -45
  43. package/esm/typings/execution/assertsExecutionSuccessful.d.ts +11 -11
  44. package/esm/typings/execution/createPromptbookExecutor.d.ts +41 -41
  45. package/esm/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts +22 -22
  46. package/esm/typings/execution/plugins/natural-execution-tools/mocked/joker.test.d.ts +4 -4
  47. package/esm/typings/execution/plugins/natural-execution-tools/mocked/mocked-chat.test.d.ts +4 -4
  48. package/esm/typings/execution/plugins/natural-execution-tools/mocked/mocked-completion.test.d.ts +4 -4
  49. package/esm/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionTools.d.ts +28 -28
  50. package/esm/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts +16 -16
  51. package/esm/typings/execution/plugins/natural-execution-tools/openai/computeOpenaiUsage.d.ts +3 -3
  52. package/esm/typings/execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionTools.d.ts +35 -35
  53. package/esm/typings/execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts +23 -23
  54. package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Promptbook_Server_Error.d.ts +11 -11
  55. package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Promptbook_Server_Progress.d.ts +12 -12
  56. package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Promptbook_Server_Request.d.ts +17 -17
  57. package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Promptbook_Server_Response.d.ts +12 -12
  58. package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions.d.ts +27 -27
  59. package/esm/typings/execution/plugins/natural-execution-tools/remote/startRemoteServer.d.ts +17 -17
  60. package/esm/typings/execution/plugins/script-execution-tools/custom-function-async.test.ts.test.d.ts +1 -1
  61. package/esm/typings/execution/plugins/script-execution-tools/custom-function-missing.test.d.ts +1 -1
  62. package/esm/typings/execution/plugins/script-execution-tools/custom-function-with-dependencies.test.d.ts +1 -1
  63. package/esm/typings/execution/plugins/script-execution-tools/custom-function.test.d.ts +1 -1
  64. package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts +20 -20
  65. package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -4
  66. package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts +20 -20
  67. package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions.d.ts +22 -22
  68. package/esm/typings/execution/plugins/script-execution-tools/javascript/utils/preserve.d.ts +11 -11
  69. package/esm/typings/execution/plugins/script-execution-tools/postprocessing.test.d.ts +1 -1
  70. package/esm/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts +15 -15
  71. package/esm/typings/execution/plugins/script-execution-tools/script-execution-errors.test.d.ts +1 -1
  72. package/esm/typings/execution/plugins/script-execution-tools/script-execution-tools.test.d.ts +1 -1
  73. package/esm/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts +15 -15
  74. package/esm/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools.d.ts +14 -14
  75. package/esm/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions.d.ts +12 -12
  76. package/esm/typings/execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools.d.ts +16 -16
  77. package/esm/typings/execution/plugins/user-interface-execution-tools/user-interface-execution-tools.test.d.ts +1 -1
  78. package/esm/typings/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +4 -4
  79. package/esm/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +9 -9
  80. package/esm/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +5 -5
  81. package/esm/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -11
  82. package/esm/typings/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +4 -4
  83. package/esm/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +1 -1
  84. package/esm/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -1
  85. package/esm/typings/execution/translation/automatic-translate/translateMessages.d.ts +5 -5
  86. package/esm/typings/execution/utils/replaceParameters.d.ts +12 -12
  87. package/esm/typings/execution/utils/replaceParameters.test.d.ts +1 -1
  88. package/esm/typings/library/PromptbookLibrary.d.ts +25 -25
  89. package/esm/typings/library/SimplePromptbookLibrary.d.ts +35 -35
  90. package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts +5 -5
  91. package/esm/typings/library/constructors/createPromptbookLibraryFromList.d.ts +5 -5
  92. package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts +7 -7
  93. package/esm/typings/library/constructors/createPromptbookLibraryFromSources.d.ts +16 -16
  94. package/esm/typings/library/constructors/createPromptbookSublibrary.d.ts +6 -6
  95. package/esm/typings/types/Command.d.ts +98 -98
  96. package/esm/typings/types/ExecutionTypes.d.ts +13 -13
  97. package/esm/typings/types/ModelRequirements.d.ts +41 -41
  98. package/esm/typings/types/Parameters.d.ts +14 -14
  99. package/esm/typings/types/Prompt.d.ts +41 -41
  100. package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts +126 -126
  101. package/esm/typings/types/PromptbookJson/PromptTemplateParameterJson.d.ts +25 -25
  102. package/esm/typings/types/PromptbookJson/PromptbookJson.d.ts +51 -51
  103. package/esm/typings/types/PromptbookString.d.ts +12 -12
  104. package/esm/typings/types/ScriptLanguage.d.ts +9 -9
  105. package/esm/typings/types/TaskProgress.d.ts +42 -42
  106. package/esm/typings/types/execution-report/ExecutionReportJson.d.ts +56 -56
  107. package/esm/typings/types/execution-report/ExecutionReportString.d.ts +16 -16
  108. package/esm/typings/types/execution-report/ExecutionReportStringOptions.d.ts +21 -21
  109. package/esm/typings/types/execution-report/config.d.ts +8 -8
  110. package/esm/typings/types/execution-report/countWorkingDuration.d.ts +7 -7
  111. package/esm/typings/types/execution-report/countWorkingDuration.test.d.ts +1 -1
  112. package/esm/typings/types/execution-report/executionReportJsonToString.d.ts +11 -11
  113. package/esm/typings/types/execution-report/executionReportJsonToString.test.d.ts +1 -1
  114. package/esm/typings/types/typeAliasEmoji.d.ts +9 -9
  115. package/esm/typings/types/typeAliases.d.ts +432 -432
  116. package/esm/typings/utils/FromtoItems.d.ts +19 -19
  117. package/esm/typings/utils/emojis.d.ts +22 -22
  118. package/esm/typings/utils/expectation-counters/countCharacters.d.ts +5 -5
  119. package/esm/typings/utils/expectation-counters/countCharacters.test.d.ts +1 -1
  120. package/esm/typings/utils/expectation-counters/countLines.d.ts +5 -5
  121. package/esm/typings/utils/expectation-counters/countLines.test.d.ts +1 -1
  122. package/esm/typings/utils/expectation-counters/countPages.d.ts +5 -5
  123. package/esm/typings/utils/expectation-counters/countPages.test.d.ts +1 -1
  124. package/esm/typings/utils/expectation-counters/countParagraphs.d.ts +5 -5
  125. package/esm/typings/utils/expectation-counters/countParagraphs.test.d.ts +1 -1
  126. package/esm/typings/utils/expectation-counters/countSentences.d.ts +5 -5
  127. package/esm/typings/utils/expectation-counters/countSentences.test.d.ts +1 -1
  128. package/esm/typings/utils/expectation-counters/countWords.d.ts +5 -5
  129. package/esm/typings/utils/expectation-counters/countWords.test.d.ts +1 -1
  130. package/esm/typings/utils/expectation-counters/index.d.ts +5 -5
  131. package/esm/typings/utils/extractParameters.d.ts +10 -10
  132. package/esm/typings/utils/extractParameters.test.d.ts +1 -1
  133. package/esm/typings/utils/formatNumber.d.ts +6 -6
  134. package/esm/typings/utils/formatNumber.test.d.ts +1 -1
  135. package/esm/typings/utils/getCurrentIsoDate.d.ts +7 -7
  136. package/esm/typings/utils/isRunningInWhatever.d.ts +12 -12
  137. package/esm/typings/utils/isValidJsonString.d.ts +4 -4
  138. package/esm/typings/utils/isValidJsonString.test.d.ts +1 -1
  139. package/esm/typings/utils/just.d.ts +10 -10
  140. package/esm/typings/utils/markdown/addAutoGeneratedSection.d.ts +10 -10
  141. package/esm/typings/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -1
  142. package/esm/typings/utils/markdown/createMarkdownChart.d.ts +41 -41
  143. package/esm/typings/utils/markdown/createMarkdownChart.test.d.ts +1 -1
  144. package/esm/typings/utils/markdown/createMarkdownTable.d.ts +7 -7
  145. package/esm/typings/utils/markdown/createMarkdownTable.test.d.ts +1 -1
  146. package/esm/typings/utils/markdown/escapeMarkdownBlock.d.ts +6 -6
  147. package/esm/typings/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -1
  148. package/esm/typings/utils/markdown/extractAllBlocksFromMarkdown.d.ts +27 -27
  149. package/esm/typings/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -1
  150. package/esm/typings/utils/markdown/extractAllListItemsFromMarkdown.d.ts +13 -13
  151. package/esm/typings/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -1
  152. package/esm/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts +19 -19
  153. package/esm/typings/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -1
  154. package/esm/typings/utils/markdown/prettifyMarkdown.d.ts +8 -8
  155. package/esm/typings/utils/markdown/prettifyMarkdown.test.d.ts +1 -1
  156. package/esm/typings/utils/markdown/removeContentComments.d.ts +8 -8
  157. package/esm/typings/utils/markdown/removeContentComments.test.d.ts +1 -1
  158. package/esm/typings/utils/markdown/removeMarkdownFormatting.d.ts +8 -8
  159. package/esm/typings/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -1
  160. package/esm/typings/utils/markdown-json/MarkdownStructure.d.ts +25 -25
  161. package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts +7 -7
  162. package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.test.d.ts +1 -1
  163. package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts +13 -13
  164. package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.test.d.ts +1 -1
  165. package/esm/typings/utils/postprocessing/extractBlock.d.ts +12 -12
  166. package/esm/typings/utils/removeEmojis.d.ts +7 -7
  167. package/esm/typings/utils/removeEmojis.test.d.ts +1 -1
  168. package/esm/typings/utils/removeQuotes.d.ts +13 -13
  169. package/esm/typings/utils/removeQuotes.test.d.ts +1 -1
  170. package/esm/typings/utils/trimCodeBlock.d.ts +8 -8
  171. package/esm/typings/utils/trimCodeBlock.test.d.ts +1 -1
  172. package/esm/typings/utils/trimEndOfCodeBlock.d.ts +7 -7
  173. package/esm/typings/utils/trimEndOfCodeBlock.test.d.ts +1 -1
  174. package/esm/typings/utils/unwrapResult.d.ts +36 -36
  175. package/esm/typings/utils/unwrapResult.test.d.ts +1 -1
  176. package/esm/typings/utils/validators/url/isValidUrl.d.ts +7 -7
  177. package/esm/typings/utils/validators/url/isValidUrl.test.d.ts +1 -1
  178. package/esm/typings/version.d.ts +5 -5
  179. package/esm/typings/wizzard/Wizzard.d.ts +4 -4
  180. package/esm/typings/wizzard/sample.d.ts +6 -6
  181. package/package.json +9 -7
  182. package/umd/index.umd.js +1722 -1685
  183. package/umd/index.umd.js.map +1 -1
  184. package/umd/typings/_packages/core.index.d.ts +20 -20
  185. package/umd/typings/_packages/execute-javascript.index.d.ts +3 -3
  186. package/umd/typings/_packages/openai.index.d.ts +3 -3
  187. package/umd/typings/_packages/remote-client.index.d.ts +4 -4
  188. package/umd/typings/_packages/remote-server.index.d.ts +3 -3
  189. package/umd/typings/_packages/types.index.d.ts +27 -27
  190. package/umd/typings/_packages/utils.index.d.ts +38 -38
  191. package/umd/typings/_packages/wizzard.index.d.ts +5 -5
  192. package/umd/typings/config.d.ts +4 -4
  193. package/umd/typings/conversion/prettify/PrettifyOptions.d.ts +7 -7
  194. package/umd/typings/conversion/prettify/prettifyPromptbookString.d.ts +11 -10
  195. package/umd/typings/conversion/prettify/prettifyPromptbookStringCli.d.ts +9 -9
  196. package/umd/typings/conversion/promptbookStringToJson.d.ts +13 -13
  197. package/umd/typings/conversion/test/_importPromptbook.d.ts +12 -12
  198. package/umd/typings/conversion/test/promptbookStringToJson-syntaxErrors.test.d.ts +1 -1
  199. package/umd/typings/conversion/test/promptbookStringToJson.test.d.ts +1 -1
  200. package/umd/typings/conversion/test/validatePromptbookJson-logicErrors.test.d.ts +1 -1
  201. package/umd/typings/conversion/test/validatePromptbookJson.d.ts +26 -26
  202. package/umd/typings/conversion/test/validatePromptbookJson.test.d.ts +1 -1
  203. package/umd/typings/conversion/utils/extractVariables.d.ts +10 -10
  204. package/umd/typings/conversion/utils/extractVariables.test.d.ts +1 -1
  205. package/umd/typings/conversion/utils/parseCommand.d.ts +8 -8
  206. package/umd/typings/conversion/utils/parseCommand.test.d.ts +4 -4
  207. package/umd/typings/conversion/utils/parseNumber.d.ts +12 -12
  208. package/umd/typings/conversion/utils/parseNumber.test.d.ts +1 -1
  209. package/umd/typings/errors/ExpectError.d.ts +9 -9
  210. package/umd/typings/errors/NotFoundError.d.ts +7 -7
  211. package/umd/typings/errors/PromptbookExecutionError.d.ts +7 -7
  212. package/umd/typings/errors/PromptbookLogicError.d.ts +7 -7
  213. package/umd/typings/errors/PromptbookReferenceError.d.ts +7 -7
  214. package/umd/typings/errors/PromptbookSyntaxError.d.ts +7 -7
  215. package/umd/typings/errors/UnexpectedError.d.ts +7 -7
  216. package/umd/typings/execution/CommonExecutionToolsOptions.d.ts +9 -9
  217. package/umd/typings/execution/ExecutionTools.d.ts +25 -25
  218. package/umd/typings/execution/NaturalExecutionTools.d.ts +23 -23
  219. package/umd/typings/execution/PromptResult.d.ts +74 -74
  220. package/umd/typings/execution/PromptbookExecutor.d.ts +39 -39
  221. package/umd/typings/execution/ScriptExecutionTools.d.ts +37 -37
  222. package/umd/typings/execution/UserInterfaceTools.d.ts +45 -45
  223. package/umd/typings/execution/assertsExecutionSuccessful.d.ts +11 -11
  224. package/umd/typings/execution/createPromptbookExecutor.d.ts +41 -41
  225. package/umd/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts +22 -22
  226. package/umd/typings/execution/plugins/natural-execution-tools/mocked/joker.test.d.ts +4 -4
  227. package/umd/typings/execution/plugins/natural-execution-tools/mocked/mocked-chat.test.d.ts +4 -4
  228. package/umd/typings/execution/plugins/natural-execution-tools/mocked/mocked-completion.test.d.ts +4 -4
  229. package/umd/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionTools.d.ts +28 -28
  230. package/umd/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts +16 -16
  231. package/umd/typings/execution/plugins/natural-execution-tools/openai/computeOpenaiUsage.d.ts +3 -3
  232. package/umd/typings/execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionTools.d.ts +35 -35
  233. package/umd/typings/execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts +23 -23
  234. package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Promptbook_Server_Error.d.ts +11 -11
  235. package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Promptbook_Server_Progress.d.ts +12 -12
  236. package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Promptbook_Server_Request.d.ts +17 -17
  237. package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Promptbook_Server_Response.d.ts +12 -12
  238. package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions.d.ts +27 -27
  239. package/umd/typings/execution/plugins/natural-execution-tools/remote/startRemoteServer.d.ts +17 -17
  240. package/umd/typings/execution/plugins/script-execution-tools/custom-function-async.test.ts.test.d.ts +1 -1
  241. package/umd/typings/execution/plugins/script-execution-tools/custom-function-missing.test.d.ts +1 -1
  242. package/umd/typings/execution/plugins/script-execution-tools/custom-function-with-dependencies.test.d.ts +1 -1
  243. package/umd/typings/execution/plugins/script-execution-tools/custom-function.test.d.ts +1 -1
  244. package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts +20 -20
  245. package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -4
  246. package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts +20 -20
  247. package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions.d.ts +22 -22
  248. package/umd/typings/execution/plugins/script-execution-tools/javascript/utils/preserve.d.ts +11 -11
  249. package/umd/typings/execution/plugins/script-execution-tools/postprocessing.test.d.ts +1 -1
  250. package/umd/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts +15 -15
  251. package/umd/typings/execution/plugins/script-execution-tools/script-execution-errors.test.d.ts +1 -1
  252. package/umd/typings/execution/plugins/script-execution-tools/script-execution-tools.test.d.ts +1 -1
  253. package/umd/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts +15 -15
  254. package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools.d.ts +14 -14
  255. package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions.d.ts +12 -12
  256. package/umd/typings/execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools.d.ts +16 -16
  257. package/umd/typings/execution/plugins/user-interface-execution-tools/user-interface-execution-tools.test.d.ts +1 -1
  258. package/umd/typings/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +4 -4
  259. package/umd/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +9 -9
  260. package/umd/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +5 -5
  261. package/umd/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -11
  262. package/umd/typings/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +4 -4
  263. package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +1 -1
  264. package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -1
  265. package/umd/typings/execution/translation/automatic-translate/translateMessages.d.ts +5 -5
  266. package/umd/typings/execution/utils/replaceParameters.d.ts +12 -12
  267. package/umd/typings/execution/utils/replaceParameters.test.d.ts +1 -1
  268. package/umd/typings/library/PromptbookLibrary.d.ts +25 -25
  269. package/umd/typings/library/SimplePromptbookLibrary.d.ts +35 -35
  270. package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts +5 -5
  271. package/umd/typings/library/constructors/createPromptbookLibraryFromList.d.ts +5 -5
  272. package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts +7 -7
  273. package/umd/typings/library/constructors/createPromptbookLibraryFromSources.d.ts +16 -16
  274. package/umd/typings/library/constructors/createPromptbookSublibrary.d.ts +6 -6
  275. package/umd/typings/types/Command.d.ts +98 -98
  276. package/umd/typings/types/ExecutionTypes.d.ts +13 -13
  277. package/umd/typings/types/ModelRequirements.d.ts +41 -41
  278. package/umd/typings/types/Parameters.d.ts +14 -14
  279. package/umd/typings/types/Prompt.d.ts +41 -41
  280. package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts +126 -126
  281. package/umd/typings/types/PromptbookJson/PromptTemplateParameterJson.d.ts +25 -25
  282. package/umd/typings/types/PromptbookJson/PromptbookJson.d.ts +51 -51
  283. package/umd/typings/types/PromptbookString.d.ts +12 -12
  284. package/umd/typings/types/ScriptLanguage.d.ts +9 -9
  285. package/umd/typings/types/TaskProgress.d.ts +42 -42
  286. package/umd/typings/types/execution-report/ExecutionReportJson.d.ts +56 -56
  287. package/umd/typings/types/execution-report/ExecutionReportString.d.ts +16 -16
  288. package/umd/typings/types/execution-report/ExecutionReportStringOptions.d.ts +21 -21
  289. package/umd/typings/types/execution-report/config.d.ts +8 -8
  290. package/umd/typings/types/execution-report/countWorkingDuration.d.ts +7 -7
  291. package/umd/typings/types/execution-report/countWorkingDuration.test.d.ts +1 -1
  292. package/umd/typings/types/execution-report/executionReportJsonToString.d.ts +11 -11
  293. package/umd/typings/types/execution-report/executionReportJsonToString.test.d.ts +1 -1
  294. package/umd/typings/types/typeAliasEmoji.d.ts +9 -9
  295. package/umd/typings/types/typeAliases.d.ts +432 -432
  296. package/umd/typings/utils/FromtoItems.d.ts +19 -19
  297. package/umd/typings/utils/emojis.d.ts +22 -22
  298. package/umd/typings/utils/expectation-counters/countCharacters.d.ts +5 -5
  299. package/umd/typings/utils/expectation-counters/countCharacters.test.d.ts +1 -1
  300. package/umd/typings/utils/expectation-counters/countLines.d.ts +5 -5
  301. package/umd/typings/utils/expectation-counters/countLines.test.d.ts +1 -1
  302. package/umd/typings/utils/expectation-counters/countPages.d.ts +5 -5
  303. package/umd/typings/utils/expectation-counters/countPages.test.d.ts +1 -1
  304. package/umd/typings/utils/expectation-counters/countParagraphs.d.ts +5 -5
  305. package/umd/typings/utils/expectation-counters/countParagraphs.test.d.ts +1 -1
  306. package/umd/typings/utils/expectation-counters/countSentences.d.ts +5 -5
  307. package/umd/typings/utils/expectation-counters/countSentences.test.d.ts +1 -1
  308. package/umd/typings/utils/expectation-counters/countWords.d.ts +5 -5
  309. package/umd/typings/utils/expectation-counters/countWords.test.d.ts +1 -1
  310. package/umd/typings/utils/expectation-counters/index.d.ts +5 -5
  311. package/umd/typings/utils/extractParameters.d.ts +10 -10
  312. package/umd/typings/utils/extractParameters.test.d.ts +1 -1
  313. package/umd/typings/utils/formatNumber.d.ts +6 -6
  314. package/umd/typings/utils/formatNumber.test.d.ts +1 -1
  315. package/umd/typings/utils/getCurrentIsoDate.d.ts +7 -7
  316. package/umd/typings/utils/isRunningInWhatever.d.ts +12 -12
  317. package/umd/typings/utils/isValidJsonString.d.ts +4 -4
  318. package/umd/typings/utils/isValidJsonString.test.d.ts +1 -1
  319. package/umd/typings/utils/just.d.ts +10 -10
  320. package/umd/typings/utils/markdown/addAutoGeneratedSection.d.ts +10 -10
  321. package/umd/typings/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -1
  322. package/umd/typings/utils/markdown/createMarkdownChart.d.ts +41 -41
  323. package/umd/typings/utils/markdown/createMarkdownChart.test.d.ts +1 -1
  324. package/umd/typings/utils/markdown/createMarkdownTable.d.ts +7 -7
  325. package/umd/typings/utils/markdown/createMarkdownTable.test.d.ts +1 -1
  326. package/umd/typings/utils/markdown/escapeMarkdownBlock.d.ts +6 -6
  327. package/umd/typings/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -1
  328. package/umd/typings/utils/markdown/extractAllBlocksFromMarkdown.d.ts +27 -27
  329. package/umd/typings/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -1
  330. package/umd/typings/utils/markdown/extractAllListItemsFromMarkdown.d.ts +13 -13
  331. package/umd/typings/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -1
  332. package/umd/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts +19 -19
  333. package/umd/typings/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -1
  334. package/umd/typings/utils/markdown/prettifyMarkdown.d.ts +8 -8
  335. package/umd/typings/utils/markdown/prettifyMarkdown.test.d.ts +1 -1
  336. package/umd/typings/utils/markdown/removeContentComments.d.ts +8 -8
  337. package/umd/typings/utils/markdown/removeContentComments.test.d.ts +1 -1
  338. package/umd/typings/utils/markdown/removeMarkdownFormatting.d.ts +8 -8
  339. package/umd/typings/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -1
  340. package/umd/typings/utils/markdown-json/MarkdownStructure.d.ts +25 -25
  341. package/umd/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts +7 -7
  342. package/umd/typings/utils/markdown-json/countMarkdownStructureDeepness.test.d.ts +1 -1
  343. package/umd/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts +13 -13
  344. package/umd/typings/utils/markdown-json/markdownToMarkdownStructure.test.d.ts +1 -1
  345. package/umd/typings/utils/postprocessing/extractBlock.d.ts +12 -12
  346. package/umd/typings/utils/removeEmojis.d.ts +7 -7
  347. package/umd/typings/utils/removeEmojis.test.d.ts +1 -1
  348. package/umd/typings/utils/removeQuotes.d.ts +13 -13
  349. package/umd/typings/utils/removeQuotes.test.d.ts +1 -1
  350. package/umd/typings/utils/trimCodeBlock.d.ts +8 -8
  351. package/umd/typings/utils/trimCodeBlock.test.d.ts +1 -1
  352. package/umd/typings/utils/trimEndOfCodeBlock.d.ts +7 -7
  353. package/umd/typings/utils/trimEndOfCodeBlock.test.d.ts +1 -1
  354. package/umd/typings/utils/unwrapResult.d.ts +36 -36
  355. package/umd/typings/utils/unwrapResult.test.d.ts +1 -1
  356. package/umd/typings/utils/validators/url/isValidUrl.d.ts +7 -7
  357. package/umd/typings/utils/validators/url/isValidUrl.test.d.ts +1 -1
  358. package/umd/typings/version.d.ts +5 -5
  359. package/umd/typings/wizzard/Wizzard.d.ts +4 -4
  360. package/umd/typings/wizzard/sample.d.ts +6 -6
@@ -1,5 +1,5 @@
1
- import { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
2
- import { TranslatorOptions } from './automatic-translators/TranslatorOptions';
3
- export declare function translateMessages({ automaticTranslator, from, to, }: {
4
- automaticTranslator: AutomaticTranslator;
5
- } & TranslatorOptions): Promise<void>;
1
+ import { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
2
+ import { TranslatorOptions } from './automatic-translators/TranslatorOptions';
3
+ export declare function translateMessages({ automaticTranslator, from, to, }: {
4
+ automaticTranslator: AutomaticTranslator;
5
+ } & TranslatorOptions): Promise<void>;
@@ -1,12 +1,12 @@
1
- import { Parameters } from '../../types/Parameters';
2
- import { string_template } from '../../types/typeAliases';
3
- /**
4
- * Replaces parameters in template with values from parameters object
5
- *
6
- * @param template the template with parameters in {curly} braces
7
- * @param parameters the object with parameters
8
- * @returns the template with replaced parameters
9
- *
10
- * @private within the createPromptbookExecutor
11
- */
12
- export declare function replaceParameters(template: string_template, parameters: Parameters): string;
1
+ import { Parameters } from '../../types/Parameters';
2
+ import { string_template } from '../../types/typeAliases';
3
+ /**
4
+ * Replaces parameters in template with values from parameters object
5
+ *
6
+ * @param template the template with parameters in {curly} braces
7
+ * @param parameters the object with parameters
8
+ * @returns the template with replaced parameters
9
+ *
10
+ * @private within the createPromptbookExecutor
11
+ */
12
+ export declare function replaceParameters(template: string_template, parameters: Parameters): string;
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,25 +1,25 @@
1
- import { Promisable } from 'type-fest';
2
- import type { Prompt } from '../types/Prompt';
3
- import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
4
- import type { string_promptbook_url } from '../types/typeAliases';
5
- /**
6
- * Library of promptbooks that groups together promptbooks for an application.
7
- *
8
- * @see https://github.com/webgptorg/promptbook#promptbook-library
9
- */
10
- export type PromptbookLibrary = {
11
- /**
12
- * Gets all promptbooks in the library
13
- */
14
- listPromptbooks(): Promisable<Array<string_promptbook_url>>;
15
- /**
16
- * Gets promptbook by its URL
17
- *
18
- * Note: This is not a direct fetching from the URL, but a lookup in the library
19
- */
20
- getPromptbookByUrl(url: string_promptbook_url): Promisable<PromptbookJson>;
21
- /**
22
- * Checks whether given prompt was defined in any promptbook in the library
23
- */
24
- isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
25
- };
1
+ import { Promisable } from 'type-fest';
2
+ import type { Prompt } from '../types/Prompt';
3
+ import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
4
+ import type { string_promptbook_url } from '../types/typeAliases';
5
+ /**
6
+ * Library of promptbooks that groups together promptbooks for an application.
7
+ *
8
+ * @see https://github.com/webgptorg/promptbook#promptbook-library
9
+ */
10
+ export type PromptbookLibrary = {
11
+ /**
12
+ * Gets all promptbooks in the library
13
+ */
14
+ listPromptbooks(): Promisable<Array<string_promptbook_url>>;
15
+ /**
16
+ * Gets promptbook by its URL
17
+ *
18
+ * Note: This is not a direct fetching from the URL, but a lookup in the library
19
+ */
20
+ getPromptbookByUrl(url: string_promptbook_url): Promisable<PromptbookJson>;
21
+ /**
22
+ * Checks whether given prompt was defined in any promptbook in the library
23
+ */
24
+ isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
25
+ };
@@ -1,35 +1,35 @@
1
- import type { Prompt } from '../types/Prompt';
2
- import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
3
- import type { string_promptbook_url } from '../types/typeAliases';
4
- import { PromptbookLibrary } from './PromptbookLibrary';
5
- /**
6
- * Library of promptbooks that groups together promptbooks for an application.
7
- * This implementation is a very thin wrapper around the Array / Map of promptbooks.
8
- *
9
- * @see https://github.com/webgptorg/promptbook#promptbook-library
10
- */
11
- export declare class SimplePromptbookLibrary implements PromptbookLibrary {
12
- private library;
13
- /**!!!
14
- *
15
- * @param promptbooks !!!
16
- *
17
- * Note: During the construction logic of all promptbooks are validated
18
- * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
19
- */
20
- constructor(...promptbooks: Array<PromptbookJson>);
21
- /**
22
- * Gets all promptbooks in the library
23
- */
24
- listPromptbooks(): Array<string_promptbook_url>;
25
- /**
26
- * Gets promptbook by its URL
27
- *
28
- * Note: This is not a direct fetching from the URL, but a lookup in the library
29
- */
30
- getPromptbookByUrl(url: string_promptbook_url): PromptbookJson;
31
- /**
32
- * Checks whether given prompt was defined in any promptbook in the library
33
- */
34
- isResponsibleForPrompt(prompt: Prompt): boolean;
35
- }
1
+ import type { Prompt } from '../types/Prompt';
2
+ import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
3
+ import type { string_promptbook_url } from '../types/typeAliases';
4
+ import { PromptbookLibrary } from './PromptbookLibrary';
5
+ /**
6
+ * Library of promptbooks that groups together promptbooks for an application.
7
+ * This implementation is a very thin wrapper around the Array / Map of promptbooks.
8
+ *
9
+ * @see https://github.com/webgptorg/promptbook#promptbook-library
10
+ */
11
+ export declare class SimplePromptbookLibrary implements PromptbookLibrary {
12
+ private library;
13
+ /**!!!
14
+ *
15
+ * @param promptbooks !!!
16
+ *
17
+ * Note: During the construction logic of all promptbooks are validated
18
+ * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
19
+ */
20
+ constructor(...promptbooks: Array<PromptbookJson>);
21
+ /**
22
+ * Gets all promptbooks in the library
23
+ */
24
+ listPromptbooks(): Array<string_promptbook_url>;
25
+ /**
26
+ * Gets promptbook by its URL
27
+ *
28
+ * Note: This is not a direct fetching from the URL, but a lookup in the library
29
+ */
30
+ getPromptbookByUrl(url: string_promptbook_url): PromptbookJson;
31
+ /**
32
+ * Checks whether given prompt was defined in any promptbook in the library
33
+ */
34
+ isResponsibleForPrompt(prompt: Prompt): boolean;
35
+ }
@@ -1,5 +1,5 @@
1
- import { PromptbookLibrary } from '../PromptbookLibrary';
2
- export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
3
- /***
4
- * TODO: !!! Annotate all + all to README and samples
5
- */
1
+ import { PromptbookLibrary } from '../PromptbookLibrary';
2
+ export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
3
+ /***
4
+ * TODO: !!! Annotate all + all to README and samples
5
+ */
@@ -1,5 +1,5 @@
1
- import { PromptbookLibrary } from '../PromptbookLibrary';
2
- export declare function createPromptbookLibraryFromList(): PromptbookLibrary;
3
- /***
4
- * TODO: !!! Annotate all + all to README and samples
5
- */
1
+ import { PromptbookLibrary } from '../PromptbookLibrary';
2
+ export declare function createPromptbookLibraryFromList(): PromptbookLibrary;
3
+ /***
4
+ * TODO: !!! Annotate all + all to README and samples
5
+ */
@@ -1,7 +1,7 @@
1
- import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
2
- import { PromptbookString } from '../../types/PromptbookString';
3
- import { PromptbookLibrary } from '../PromptbookLibrary';
4
- export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
5
- /***
6
- * TODO: !!! Annotate all + all to README and samples
7
- */
1
+ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
2
+ import { PromptbookString } from '../../types/PromptbookString';
3
+ import { PromptbookLibrary } from '../PromptbookLibrary';
4
+ export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
5
+ /***
6
+ * TODO: !!! Annotate all + all to README and samples
7
+ */
@@ -1,16 +1,16 @@
1
- import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
2
- import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
3
- export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
4
- /**
5
- * Constructs Promptbook from any sources
6
- *
7
- * Note: During the construction syntax and logic of all sources are validated
8
- * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
9
- *
10
- * @param promptbookSources contents of .ptbk.md or .ptbk.json files
11
- * @param settings settings for creating executor functions
12
- * @returns PromptbookLibrary
13
- */
14
- /***
15
- * TODO: !!! Annotate all + all to README and samples
16
- */
1
+ import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
2
+ import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
3
+ export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
4
+ /**
5
+ * Constructs Promptbook from any sources
6
+ *
7
+ * Note: During the construction syntax and logic of all sources are validated
8
+ * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
9
+ *
10
+ * @param promptbookSources contents of .ptbk.md or .ptbk.json files
11
+ * @param settings settings for creating executor functions
12
+ * @returns PromptbookLibrary
13
+ */
14
+ /***
15
+ * TODO: !!! Annotate all + all to README and samples
16
+ */
@@ -1,6 +1,6 @@
1
- import type { string_promptbook_url } from '../../types/typeAliases';
2
- import { PromptbookLibrary } from '../PromptbookLibrary';
3
- export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
4
- /***
5
- * TODO: !!! Annotate all + all to README and samples
6
- */
1
+ import type { string_promptbook_url } from '../../types/typeAliases';
2
+ import { PromptbookLibrary } from '../PromptbookLibrary';
3
+ export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
4
+ /***
5
+ * TODO: !!! Annotate all + all to README and samples
6
+ */
@@ -1,98 +1,98 @@
1
- import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
2
- import type { ExecutionType } from './ExecutionTypes';
3
- import type { ModelRequirements } from './ModelRequirements';
4
- import type { ExpectationAmount, ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
5
- /**
6
- * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
7
- * It is parsed from the markdown from ul/ol items - one command per one item.
8
- */
9
- export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
10
- /**
11
- * PromptbookVersion command tells which version is .promptbook file using
12
- *
13
- * - It is used for backward compatibility
14
- * - It is defined per whole .promptbook file in the header
15
- */
16
- export type PromptbookUrlCommand = {
17
- readonly type: 'PROMPTBOOK_URL';
18
- readonly promptbookUrl: URL;
19
- };
20
- /**
21
- * PromptbookVersion command tells which version is .promptbook file using
22
- *
23
- * - It is used for backward compatibility
24
- * - It is defined per whole .promptbook file in the header
25
- */
26
- export type PromptbookVersionCommand = {
27
- readonly type: 'PROMPTBOOK_VERSION';
28
- readonly promptbookVersion: string_version;
29
- };
30
- /**
31
- * Execute command tells how to execute the section
32
- * It can be either prompt template, script or SIMPLE TEMPLATE etc.
33
- */
34
- export type ExecuteCommand = {
35
- readonly type: 'EXECUTE';
36
- readonly executionType: ExecutionType;
37
- };
38
- /**
39
- * Model command tells which model and modelRequirements to use for the prompt template. execution
40
- */
41
- export type ModelCommand = {
42
- readonly type: 'MODEL';
43
- readonly key: keyof ModelRequirements;
44
- readonly value: any;
45
- };
46
- /**
47
- * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
48
- */
49
- export type JokerCommand = {
50
- readonly type: 'JOKER';
51
- readonly parameterName: string_name;
52
- };
53
- /**
54
- * Parameter command describes one parameter of the prompt template
55
- *
56
- * - It can tell if it is input or OUTPUT PARAMETER
57
- * - It can have description
58
- * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
59
- */
60
- export type ParameterCommand = {
61
- readonly type: 'PARAMETER';
62
- readonly isInput: boolean;
63
- readonly isOutput: boolean;
64
- readonly parameterName: string_name;
65
- readonly parameterDescription: string_markdown_text | null;
66
- };
67
- /**
68
- * Postprocess command describes which function to use for postprocessing
69
- * This will be created as separate EXECUTE SCRIPT block bellow
70
- */
71
- export type PostprocessCommand = {
72
- readonly type: 'POSTPROCESS';
73
- readonly functionName: string_name;
74
- };
75
- /**
76
- * Expect command describes the desired output of the prompt template (after post-processing)
77
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
78
- */
79
- export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
80
- /**
81
- * Expect amount command describes the desired output of the prompt template (after post-processing)
82
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
83
- *
84
- * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
85
- */
86
- export type ExpectAmountCommand = {
87
- readonly type: 'EXPECT_AMOUNT';
88
- readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
89
- readonly unit: ExpectationUnit;
90
- readonly amount: ExpectationAmount;
91
- };
92
- /**
93
- * Represents a command that expects a specific format.
94
- */
95
- export type ExpectFormatCommand = {
96
- readonly type: 'EXPECT_FORMAT';
97
- readonly format: 'JSON';
98
- };
1
+ import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
2
+ import type { ExecutionType } from './ExecutionTypes';
3
+ import type { ModelRequirements } from './ModelRequirements';
4
+ import type { ExpectationAmount, ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
5
+ /**
6
+ * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
7
+ * It is parsed from the markdown from ul/ol items - one command per one item.
8
+ */
9
+ export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
10
+ /**
11
+ * PromptbookVersion command tells which version is .promptbook file using
12
+ *
13
+ * - It is used for backward compatibility
14
+ * - It is defined per whole .promptbook file in the header
15
+ */
16
+ export type PromptbookUrlCommand = {
17
+ readonly type: 'PROMPTBOOK_URL';
18
+ readonly promptbookUrl: URL;
19
+ };
20
+ /**
21
+ * PromptbookVersion command tells which version is .promptbook file using
22
+ *
23
+ * - It is used for backward compatibility
24
+ * - It is defined per whole .promptbook file in the header
25
+ */
26
+ export type PromptbookVersionCommand = {
27
+ readonly type: 'PROMPTBOOK_VERSION';
28
+ readonly promptbookVersion: string_version;
29
+ };
30
+ /**
31
+ * Execute command tells how to execute the section
32
+ * It can be either prompt template, script or SIMPLE TEMPLATE etc.
33
+ */
34
+ export type ExecuteCommand = {
35
+ readonly type: 'EXECUTE';
36
+ readonly executionType: ExecutionType;
37
+ };
38
+ /**
39
+ * Model command tells which model and modelRequirements to use for the prompt template. execution
40
+ */
41
+ export type ModelCommand = {
42
+ readonly type: 'MODEL';
43
+ readonly key: keyof ModelRequirements;
44
+ readonly value: any;
45
+ };
46
+ /**
47
+ * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
48
+ */
49
+ export type JokerCommand = {
50
+ readonly type: 'JOKER';
51
+ readonly parameterName: string_name;
52
+ };
53
+ /**
54
+ * Parameter command describes one parameter of the prompt template
55
+ *
56
+ * - It can tell if it is input or OUTPUT PARAMETER
57
+ * - It can have description
58
+ * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
59
+ */
60
+ export type ParameterCommand = {
61
+ readonly type: 'PARAMETER';
62
+ readonly isInput: boolean;
63
+ readonly isOutput: boolean;
64
+ readonly parameterName: string_name;
65
+ readonly parameterDescription: string_markdown_text | null;
66
+ };
67
+ /**
68
+ * Postprocess command describes which function to use for postprocessing
69
+ * This will be created as separate EXECUTE SCRIPT block bellow
70
+ */
71
+ export type PostprocessCommand = {
72
+ readonly type: 'POSTPROCESS';
73
+ readonly functionName: string_name;
74
+ };
75
+ /**
76
+ * Expect command describes the desired output of the prompt template (after post-processing)
77
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
78
+ */
79
+ export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
80
+ /**
81
+ * Expect amount command describes the desired output of the prompt template (after post-processing)
82
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
83
+ *
84
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
85
+ */
86
+ export type ExpectAmountCommand = {
87
+ readonly type: 'EXPECT_AMOUNT';
88
+ readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
89
+ readonly unit: ExpectationUnit;
90
+ readonly amount: ExpectationAmount;
91
+ };
92
+ /**
93
+ * Represents a command that expects a specific format.
94
+ */
95
+ export type ExpectFormatCommand = {
96
+ readonly type: 'EXPECT_FORMAT';
97
+ readonly format: 'JSON';
98
+ };
@@ -1,13 +1,13 @@
1
- import { TupleToUnion } from 'type-fest';
2
- /**
3
- * Execution type describes the way how the block is executed
4
- *
5
- * @see https://github.com/webgptorg/promptbook#execution-type
6
- */
7
- export type ExecutionType = TupleToUnion<typeof ExecutionTypes>;
8
- /**
9
- * Execution type describes the way how the block is executed
10
- *
11
- * @see https://github.com/webgptorg/promptbook#execution-type
12
- */
13
- export declare const ExecutionTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG"];
1
+ import { TupleToUnion } from 'type-fest';
2
+ /**
3
+ * Execution type describes the way how the block is executed
4
+ *
5
+ * @see https://github.com/webgptorg/promptbook#execution-type
6
+ */
7
+ export type ExecutionType = TupleToUnion<typeof ExecutionTypes>;
8
+ /**
9
+ * Execution type describes the way how the block is executed
10
+ *
11
+ * @see https://github.com/webgptorg/promptbook#execution-type
12
+ */
13
+ export declare const ExecutionTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG"];
@@ -1,41 +1,41 @@
1
- import { string_model_name } from './typeAliases';
2
- export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
3
- /**
4
- * Model variant describes the very general type of the model
5
- *
6
- * There are two variants:
7
- * - **COMPLETION** - model that takes prompt and writes the rest of the text
8
- * - **CHAT** - model that takes prompt and previous messages and returns response
9
- */
10
- export type ModelVariant = typeof MODEL_VARIANTS[number];
11
- /**
12
- * Abstract way to specify the LLM. It does not specify the LLM with concrete version itself, only the requirements for the LLM.
13
- *
14
- * @see https://github.com/webgptorg/promptbook#model-requirements
15
- */
16
- export type ModelRequirements = {
17
- /**
18
- * Model variant describes the very general type of the model
19
- *
20
- * There are two variants:
21
- * - **COMPLETION** - model that takes prompt and writes the rest of the text
22
- * - **CHAT** - model that takes prompt and previous messages and returns response
23
- */
24
- readonly modelVariant: ModelVariant;
25
- /**
26
- * The model for text prompt
27
- *
28
- * Note: Model must be compatible with the model variant
29
- *
30
- * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
31
- */
32
- readonly modelName: string_model_name;
33
- /**
34
- * Maximum number of tokens that can be generated by the model
35
- */
36
- readonly maxTokens?: number;
37
- };
38
- /**
39
- * TODO: Maybe figure out better word than "variant"
40
- * TODO: Add here more requirement options like max context size, max tokens, etc.
41
- */
1
+ import { string_model_name } from './typeAliases';
2
+ export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
3
+ /**
4
+ * Model variant describes the very general type of the model
5
+ *
6
+ * There are two variants:
7
+ * - **COMPLETION** - model that takes prompt and writes the rest of the text
8
+ * - **CHAT** - model that takes prompt and previous messages and returns response
9
+ */
10
+ export type ModelVariant = typeof MODEL_VARIANTS[number];
11
+ /**
12
+ * Abstract way to specify the LLM. It does not specify the LLM with concrete version itself, only the requirements for the LLM.
13
+ *
14
+ * @see https://github.com/webgptorg/promptbook#model-requirements
15
+ */
16
+ export type ModelRequirements = {
17
+ /**
18
+ * Model variant describes the very general type of the model
19
+ *
20
+ * There are two variants:
21
+ * - **COMPLETION** - model that takes prompt and writes the rest of the text
22
+ * - **CHAT** - model that takes prompt and previous messages and returns response
23
+ */
24
+ readonly modelVariant: ModelVariant;
25
+ /**
26
+ * The model for text prompt
27
+ *
28
+ * Note: Model must be compatible with the model variant
29
+ *
30
+ * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
31
+ */
32
+ readonly modelName: string_model_name;
33
+ /**
34
+ * Maximum number of tokens that can be generated by the model
35
+ */
36
+ readonly maxTokens?: number;
37
+ };
38
+ /**
39
+ * TODO: Maybe figure out better word than "variant"
40
+ * TODO: Add here more requirement options like max context size, max tokens, etc.
41
+ */
@@ -1,14 +1,14 @@
1
- /**
2
- * Parameters of the prompt template (pipeline)
3
- *
4
- * There are three types of parameters:
5
- * - **INPUT PARAMETERs** are required to execute the pipeline.
6
- * - **Intermediate parameters** are used internally in the pipeline.
7
- * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
8
- *
9
- * @see https://github.com/webgptorg/promptbook#parameters
10
- */
11
- export type Parameters = object;
12
- /**
13
- * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
14
- */
1
+ /**
2
+ * Parameters of the prompt template (pipeline)
3
+ *
4
+ * There are three types of parameters:
5
+ * - **INPUT PARAMETERs** are required to execute the pipeline.
6
+ * - **Intermediate parameters** are used internally in the pipeline.
7
+ * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
8
+ *
9
+ * @see https://github.com/webgptorg/promptbook#parameters
10
+ */
11
+ export type Parameters = object;
12
+ /**
13
+ * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
14
+ */