@promptbook/openai 0.70.0-1 → 0.71.0-7

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 (175) hide show
  1. package/README.md +28 -59
  2. package/esm/index.es.js +89 -10
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/promptbook-collection/index.d.ts +0 -3
  5. package/esm/typings/src/_packages/browser.index.d.ts +1 -1
  6. package/esm/typings/src/_packages/core.index.d.ts +37 -11
  7. package/esm/typings/src/_packages/node.index.d.ts +6 -2
  8. package/esm/typings/src/_packages/types.index.d.ts +40 -20
  9. package/esm/typings/src/_packages/utils.index.d.ts +4 -4
  10. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  11. package/esm/typings/src/cli/cli-commands/hello.d.ts +1 -1
  12. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -2
  13. package/esm/typings/src/cli/cli-commands/prettify.d.ts +1 -1
  14. package/esm/typings/src/cli/main.d.ts +1 -1
  15. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  16. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +8 -5
  17. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  18. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  19. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +3 -7
  20. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  21. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +2 -3
  22. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  23. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  24. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  25. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  26. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  27. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  28. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  29. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  30. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  31. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  32. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  33. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  34. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  35. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  36. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  37. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -4
  38. package/esm/typings/src/config.d.ts +26 -3
  39. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +2 -15
  40. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  41. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -0
  42. package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts +2 -1
  43. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  44. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +10 -5
  45. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
  46. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +2 -2
  47. package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +4 -4
  48. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  49. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  50. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  51. package/esm/typings/src/execution/ExecutionTools.d.ts +3 -3
  52. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  53. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +9 -8
  54. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTemplateResult.d.ts +45 -0
  55. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +23 -0
  56. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +29 -0
  57. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  58. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +58 -0
  59. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +65 -0
  60. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  61. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +74 -0
  62. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  63. package/esm/typings/src/execution/createPipelineExecutor/getContextForTemplate.d.ts +10 -0
  64. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTemplate.d.ts +27 -0
  65. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTemplate.d.ts +30 -0
  66. package/esm/typings/src/execution/createPipelineExecutor/getSamplesForTemplate.d.ts +10 -0
  67. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  68. package/esm/typings/src/execution/utils/checkExpectations.d.ts +2 -0
  69. package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -0
  70. package/esm/typings/src/execution/utils/usageToHuman.d.ts +3 -4
  71. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +14 -15
  72. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  73. package/esm/typings/src/formats/csv/{ListFormatDefinition.d.ts → CsvFormatDefinition.d.ts} +6 -3
  74. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  75. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  76. package/esm/typings/src/formats/index.d.ts +1 -1
  77. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +4 -3
  78. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  79. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +4 -3
  80. package/esm/typings/src/llm-providers/_common/createLlmToolsFromConfigurationFromEnv.d.ts +1 -1
  81. package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts +1 -1
  82. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +1 -1
  83. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +1 -1
  84. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -1
  85. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  86. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +2 -2
  87. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  88. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +8 -1
  89. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  90. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
  91. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
  92. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -1
  93. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  94. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  95. package/esm/typings/src/personas/preparePersona.d.ts +3 -3
  96. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +67 -0
  97. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +1 -1
  98. package/esm/typings/src/prepare/preparePipeline.d.ts +2 -2
  99. package/esm/typings/src/prepare/prepareTemplates.d.ts +3 -3
  100. package/esm/typings/src/scrapers/_common/Converter.d.ts +28 -0
  101. package/esm/typings/src/scrapers/_common/Scraper.d.ts +71 -0
  102. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  103. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +4 -4
  104. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +33 -0
  105. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  106. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +10 -0
  107. package/esm/typings/src/scrapers/document/documentScraper.d.ts +37 -0
  108. package/esm/typings/src/scrapers/document/documentScraper.test.d.ts +4 -0
  109. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  110. package/esm/typings/src/scrapers/document-legacy/legacyDocumentScraper.d.ts +37 -0
  111. package/esm/typings/src/scrapers/document-legacy/legacyDocumentScraper.test.d.ts +4 -0
  112. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  113. package/esm/typings/src/scrapers/index.d.ts +7 -0
  114. package/esm/typings/src/scrapers/markdown/markdownScraper.d.ts +29 -0
  115. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  116. package/esm/typings/src/scrapers/pdf/pdfScraper.d.ts +35 -0
  117. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  118. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  119. package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +12 -0
  120. package/esm/typings/src/scrapers/website/websiteScraper.d.ts +43 -0
  121. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +4 -4
  122. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  123. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +1 -1
  124. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  125. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  126. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +9 -2
  127. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -0
  128. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +3 -3
  129. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +5 -0
  130. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  131. package/esm/typings/src/types/typeAliases.d.ts +9 -12
  132. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  133. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  134. package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts +23 -0
  135. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  136. package/esm/typings/src/utils/expectation-counters/index.d.ts +3 -0
  137. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +3 -3
  138. package/esm/typings/src/utils/files/$isFileExisting.d.ts +3 -3
  139. package/esm/typings/src/utils/files/$listAllFiles.d.ts +4 -4
  140. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  141. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  142. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  143. package/esm/typings/src/utils/organization/{f.d.ts → empty_object.d.ts} +5 -1
  144. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  145. package/esm/typings/src/utils/{extractParameterNames.d.ts → parameters/extractParameterNames.d.ts} +2 -2
  146. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  147. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  148. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  149. package/esm/typings/src/utils/{replaceParameters.d.ts → parameters/replaceParameters.d.ts} +2 -2
  150. package/esm/typings/src/utils/parameters/replaceParameters.test.d.ts +1 -0
  151. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +1 -1
  152. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +1 -1
  153. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  154. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  155. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  156. package/package.json +17 -13
  157. package/umd/index.umd.js +89 -10
  158. package/umd/index.umd.js.map +1 -1
  159. package/esm/typings/src/execution/createPipelineExecutor.d.ts +0 -72
  160. package/esm/typings/src/formats/list/ListFormatDefinition.d.ts +0 -16
  161. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  162. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  163. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  164. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  165. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  166. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  167. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  168. /package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.test.d.ts +0 -0
  169. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/markdownScraper.test.d.ts} +0 -0
  170. /package/esm/typings/src/{execution/utils/usageToHuman.test.d.ts → scrapers/website/utils/markdownConverter.test.d.ts} +0 -0
  171. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → scrapers/website/websiteScraper.test.d.ts} +0 -0
  172. /package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.test.d.ts +0 -0
  173. /package/esm/typings/src/{personas/preparePersona.test.d.ts → utils/execCommand/execCommand.test.d.ts} +0 -0
  174. /package/esm/typings/src/utils/{extractParameterNames.test.d.ts → execCommand/execCommandNormalizeOptions.test.d.ts} +0 -0
  175. /package/esm/typings/src/utils/{replaceParameters.test.d.ts → files/extensionToMimeType.test.d.ts} +0 -0
package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts DELETED
@@ -1,10 +0,0 @@
1
- import type { string_folder_path } from '../../types/typeAliases';
2
- /**
3
- * @@@
4
- */
5
- export type FilesStorageOptions = {
6
- /**
7
- * @@@
8
- */
9
- cacheFolderPath: string_folder_path;
10
- };