@promptbook/wizard 0.95.0
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.
- package/README.md +482 -0
- package/esm/index.es.js +16649 -0
- package/esm/index.es.js.map +1 -0
- package/esm/typings/books/index.d.ts +131 -0
- package/esm/typings/servers.d.ts +40 -0
- package/esm/typings/src/_packages/anthropic-claude.index.d.ts +16 -0
- package/esm/typings/src/_packages/azure-openai.index.d.ts +10 -0
- package/esm/typings/src/_packages/browser.index.d.ts +12 -0
- package/esm/typings/src/_packages/cli.index.d.ts +60 -0
- package/esm/typings/src/_packages/core.index.d.ts +296 -0
- package/esm/typings/src/_packages/deepseek.index.d.ts +10 -0
- package/esm/typings/src/_packages/documents.index.d.ts +8 -0
- package/esm/typings/src/_packages/editable.index.d.ts +90 -0
- package/esm/typings/src/_packages/fake-llm.index.d.ts +6 -0
- package/esm/typings/src/_packages/google.index.d.ts +12 -0
- package/esm/typings/src/_packages/javascript.index.d.ts +10 -0
- package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
- package/esm/typings/src/_packages/markdown-utils.index.d.ts +48 -0
- package/esm/typings/src/_packages/markitdown.index.d.ts +8 -0
- package/esm/typings/src/_packages/node.index.d.ts +24 -0
- package/esm/typings/src/_packages/ollama.index.d.ts +14 -0
- package/esm/typings/src/_packages/openai.index.d.ts +22 -0
- package/esm/typings/src/_packages/pdf.index.d.ts +14 -0
- package/esm/typings/src/_packages/remote-client.index.d.ts +16 -0
- package/esm/typings/src/_packages/remote-server.index.d.ts +12 -0
- package/esm/typings/src/_packages/templates.index.d.ts +4 -0
- package/esm/typings/src/_packages/types.index.d.ts +598 -0
- package/esm/typings/src/_packages/utils.index.d.ts +170 -0
- package/esm/typings/src/_packages/vercel.index.d.ts +6 -0
- package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
- package/esm/typings/src/_packages/wizard.index.d.ts +60 -0
- package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +13 -0
- package/esm/typings/src/cli/cli-commands/about.d.ts +14 -0
- package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts +11 -0
- package/esm/typings/src/cli/cli-commands/hello.d.ts +14 -0
- package/esm/typings/src/cli/cli-commands/list-models.d.ts +13 -0
- package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +13 -0
- package/esm/typings/src/cli/cli-commands/login.d.ts +14 -0
- package/esm/typings/src/cli/cli-commands/make.d.ts +16 -0
- package/esm/typings/src/cli/cli-commands/prettify.d.ts +15 -0
- package/esm/typings/src/cli/cli-commands/run.d.ts +17 -0
- package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
- package/esm/typings/src/cli/cli-commands/start-server.d.ts +13 -0
- package/esm/typings/src/cli/cli-commands/test-command.d.ts +16 -0
- package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +7 -0
- package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +28 -0
- package/esm/typings/src/cli/main.d.ts +16 -0
- package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
- package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
- package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
- package/esm/typings/src/collection/PipelineCollection.d.ts +25 -0
- package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
- package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
- package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
- package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +65 -0
- package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
- package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
- package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
- package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
- package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
- package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
- package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
- package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
- package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
- package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
- package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +11 -0
- package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
- package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
- package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +12 -0
- package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
- package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
- package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
- package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
- package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
- package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
- package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
- package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
- package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +11 -0
- package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +4 -0
- package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +14 -0
- package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +10 -0
- package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
- package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
- package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
- package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
- package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
- package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
- package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
- package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
- package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
- package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
- package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
- package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
- package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
- package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
- package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
- package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
- package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
- package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
- package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/_common/stringifyCommand.d.ts +12 -0
- package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
- package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +205 -0
- package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
- package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +13 -0
- package/esm/typings/src/commands/index.d.ts +9 -0
- package/esm/typings/src/config.d.ts +313 -0
- package/esm/typings/src/config.test.d.ts +4 -0
- package/esm/typings/src/constants.d.ts +76 -0
- package/esm/typings/src/conversion/archive/loadArchive.d.ts +16 -0
- package/esm/typings/src/conversion/archive/saveArchive.d.ts +18 -0
- package/esm/typings/src/conversion/compilePipeline.d.ts +25 -0
- package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
- package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +21 -0
- package/esm/typings/src/conversion/parsePipeline.d.ts +30 -0
- package/esm/typings/src/conversion/parsePipeline.test.d.ts +1 -0
- package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
- package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
- package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
- package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
- package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
- package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +23 -0
- package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
- package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
- package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
- package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
- package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
- package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
- package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
- package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
- package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
- package/esm/typings/src/errors/0-index.d.ts +94 -0
- package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
- package/esm/typings/src/errors/AuthenticationError.d.ts +9 -0
- package/esm/typings/src/errors/CollectionError.d.ts +9 -0
- package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
- package/esm/typings/src/errors/ExpectError.d.ts +12 -0
- package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
- package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
- package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
- package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
- package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
- package/esm/typings/src/errors/ParseError.d.ts +12 -0
- package/esm/typings/src/errors/PipelineExecutionError.d.ts +14 -0
- package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
- package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
- package/esm/typings/src/errors/PromptbookFetchError.d.ts +9 -0
- package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
- package/esm/typings/src/errors/WrappedError.d.ts +10 -0
- package/esm/typings/src/errors/assertsError.d.ts +11 -0
- package/esm/typings/src/errors/utils/ErrorJson.d.ts +25 -0
- package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
- package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
- package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
- package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
- package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
- package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
- package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +12 -0
- package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
- package/esm/typings/src/executables/apps/locatePandoc.d.ts +12 -0
- package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
- package/esm/typings/src/executables/locateApp.d.ts +33 -0
- package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
- package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +13 -0
- package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +13 -0
- package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +13 -0
- package/esm/typings/src/execution/AbstractTaskResult.d.ts +25 -0
- package/esm/typings/src/execution/AvailableModel.d.ts +46 -0
- package/esm/typings/src/execution/CommonToolsOptions.d.ts +28 -0
- package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
- package/esm/typings/src/execution/Executables.d.ts +18 -0
- package/esm/typings/src/execution/ExecutionTask.d.ts +119 -0
- package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
- package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
- package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
- package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +11 -0
- package/esm/typings/src/execution/PipelineExecutor.d.ts +16 -0
- package/esm/typings/src/execution/PipelineExecutorResult.d.ts +39 -0
- package/esm/typings/src/execution/PromptResult.d.ts +101 -0
- package/esm/typings/src/execution/PromptbookFetch.d.ts +12 -0
- package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
- package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
- package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
- package/esm/typings/src/execution/Usage.d.ts +33 -0
- package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
- package/esm/typings/src/execution/assertsTaskSuccessful.d.ts +14 -0
- package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +48 -0
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
- package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +10 -0
- package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +48 -0
- package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
- package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +27 -0
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +70 -0
- package/esm/typings/src/execution/createPipelineExecutor/computeCosineSimilarity.d.ts +13 -0
- package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +35 -0
- package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +14 -0
- package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
- package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +42 -0
- package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +48 -0
- package/esm/typings/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +9 -0
- package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
- package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
- package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
- package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
- package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
- package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
- package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
- package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
- package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
- package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
- package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
- package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
- package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
- package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
- package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
- package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
- package/esm/typings/src/execution/utils/uncertainNumber.d.ts +10 -0
- package/esm/typings/src/execution/utils/usage-constants.d.ts +147 -0
- package/esm/typings/src/execution/utils/usageToHuman.d.ts +26 -0
- package/esm/typings/src/execution/utils/usageToWorktime.d.ts +20 -0
- package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
- package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
- package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
- package/esm/typings/src/formats/_common/FormatParser.d.ts +72 -0
- package/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts +66 -0
- package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
- package/esm/typings/src/formats/csv/CsvFormatParser.d.ts +17 -0
- package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
- package/esm/typings/src/formats/csv/utils/csvParse.d.ts +12 -0
- package/esm/typings/src/formats/csv/utils/isValidCsvString.d.ts +9 -0
- package/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts +1 -0
- package/esm/typings/src/formats/index.d.ts +9 -0
- package/esm/typings/src/formats/json/JsonFormatParser.d.ts +19 -0
- package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +9 -0
- package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
- package/esm/typings/src/formats/json/utils/jsonParse.d.ts +8 -0
- package/esm/typings/src/formats/text/TextFormatParser.d.ts +19 -0
- package/esm/typings/src/formats/xml/XmlFormatParser.d.ts +19 -0
- package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts +9 -0
- package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts +1 -0
- package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +15 -0
- package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +49 -0
- package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +10 -0
- package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +6 -0
- package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
- package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts +29 -0
- package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +25 -0
- package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
- package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts +24 -0
- package/esm/typings/src/formfactors/index.d.ts +170 -0
- package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +21 -0
- package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +26 -0
- package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +25 -0
- package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
- package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
- package/esm/typings/src/high-level-abstractions/index.d.ts +54 -0
- package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +13 -0
- package/esm/typings/src/llm-providers/_common/filterModels.d.ts +15 -0
- package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
- package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
- package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts +12 -0
- package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +19 -0
- package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +27 -0
- package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +59 -0
- package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +41 -0
- package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +22 -0
- package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +30 -0
- package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +58 -0
- package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +17 -0
- package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +49 -0
- package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
- package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +33 -0
- package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +27 -0
- package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
- package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +22 -0
- package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +17 -0
- package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
- package/esm/typings/src/llm-providers/_common/utils/pricing.d.ts +16 -0
- package/esm/typings/src/llm-providers/_common/utils/pricing.test.d.ts +1 -0
- package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +63 -0
- package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +21 -0
- package/esm/typings/src/llm-providers/_multiple/playground/playground.d.ts +5 -0
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +66 -0
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
- package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
- package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
- package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
- package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
- package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
- package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +14 -0
- package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +16 -0
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +67 -0
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
- package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
- package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
- package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +14 -0
- package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +15 -0
- package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +9 -0
- package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +14 -0
- package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +23 -0
- package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +14 -0
- package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +15 -0
- package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
- package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
- package/esm/typings/src/llm-providers/google/google-models.d.ts +23 -0
- package/esm/typings/src/llm-providers/google/register-configuration.d.ts +14 -0
- package/esm/typings/src/llm-providers/google/register-constructor.d.ts +15 -0
- package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
- package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
- package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
- package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
- package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
- package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
- package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
- package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
- package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts +44 -0
- package/esm/typings/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +23 -0
- package/esm/typings/src/llm-providers/ollama/createOllamaExecutionTools.d.ts +11 -0
- package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +14 -0
- package/esm/typings/src/llm-providers/ollama/playground/playground.d.ts +6 -0
- package/esm/typings/src/llm-providers/ollama/register-configuration.d.ts +14 -0
- package/esm/typings/src/llm-providers/ollama/register-constructor.d.ts +15 -0
- package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
- package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
- package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +91 -0
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +38 -0
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +11 -0
- package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
- package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
- package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
- package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +17 -0
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +25 -0
- package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
- package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +24 -0
- package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +25 -0
- package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +59 -0
- package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
- package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
- package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
- package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
- package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
- package/esm/typings/src/migrations/migratePipeline.d.ts +9 -0
- package/esm/typings/src/other/templates/getBookTemplates.d.ts +24 -0
- package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
- package/esm/typings/src/personas/preparePersona.d.ts +17 -0
- package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
- package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
- package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
- package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +27 -0
- package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
- package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +103 -0
- package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
- package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
- package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
- package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
- package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
- package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +47 -0
- package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +113 -0
- package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
- package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
- package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
- package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
- package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
- package/esm/typings/src/pipeline/PipelineString.d.ts +11 -0
- package/esm/typings/src/pipeline/book-notation.d.ts +19 -0
- package/esm/typings/src/pipeline/isValidPipelineString.d.ts +13 -0
- package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts +4 -0
- package/esm/typings/src/pipeline/prompt-notation.d.ts +31 -0
- package/esm/typings/src/pipeline/prompt-notation.test.d.ts +4 -0
- package/esm/typings/src/pipeline/validatePipelineString.d.ts +14 -0
- package/esm/typings/src/playground/playground.d.ts +5 -0
- package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
- package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
- package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
- package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
- package/esm/typings/src/prepare/isPipelinePrepared.d.ts +18 -0
- package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
- package/esm/typings/src/prepare/preparePipeline.d.ts +22 -0
- package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +17 -0
- package/esm/typings/src/prepare/prepareTasks.d.ts +36 -0
- package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
- package/esm/typings/src/remote-server/RemoteServer.d.ts +23 -0
- package/esm/typings/src/remote-server/createRemoteClient.d.ts +10 -0
- package/esm/typings/src/remote-server/openapi-types.d.ts +626 -0
- package/esm/typings/src/remote-server/openapi.d.ts +581 -0
- package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Error.d.ts +7 -0
- package/esm/typings/src/remote-server/socket-types/_subtypes/Identification.d.ts +59 -0
- package/esm/typings/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts +11 -0
- package/esm/typings/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts +10 -0
- package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +17 -0
- package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +17 -0
- package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +17 -0
- package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts +12 -0
- package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +17 -0
- package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Response.d.ts +12 -0
- package/esm/typings/src/remote-server/startRemoteServer.d.ts +25 -0
- package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +24 -0
- package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +164 -0
- package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +43 -0
- package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts +15 -0
- package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +28 -0
- package/esm/typings/src/scrapers/_common/Converter.d.ts +25 -0
- package/esm/typings/src/scrapers/_common/Scraper.d.ts +60 -0
- package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +16 -0
- package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
- package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
- package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +12 -0
- package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +15 -0
- package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts +11 -0
- package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +14 -0
- package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +46 -0
- package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +35 -0
- package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
- package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/utils/promptbookFetch.d.ts +10 -0
- package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
- package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
- package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/document/register-constructor.d.ts +15 -0
- package/esm/typings/src/scrapers/document/register-metadata.d.ts +28 -0
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
- package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +21 -0
- package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +15 -0
- package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +28 -0
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
- package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +15 -0
- package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +28 -0
- package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts +50 -0
- package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +22 -0
- package/esm/typings/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/markitdown/register-constructor.d.ts +17 -0
- package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +28 -0
- package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +41 -0
- package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +21 -0
- package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +15 -0
- package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +28 -0
- package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
- package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +21 -0
- package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/website/register-constructor.d.ts +15 -0
- package/esm/typings/src/scrapers/website/register-metadata.d.ts +28 -0
- package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
- package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
- package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
- package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
- package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
- package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
- package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
- package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
- package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
- package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
- package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
- package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
- package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
- package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +56 -0
- package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +14 -0
- package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.test.d.ts +1 -0
- package/esm/typings/src/scripting/javascript/utils/extractVariablesFromScript.test.d.ts +1 -0
- package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +14 -0
- package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
- package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
- package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
- package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
- package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
- package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +40 -0
- package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +40 -0
- package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +12 -0
- package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +8 -0
- package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
- package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts +11 -0
- package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
- package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
- package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts +14 -0
- package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +8 -0
- package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +12 -0
- package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
- package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
- package/esm/typings/src/types/Arrayable.d.ts +11 -0
- package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +8 -0
- package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
- package/esm/typings/src/types/ModelVariant.d.ts +15 -0
- package/esm/typings/src/types/NonEmptyArray.d.ts +8 -0
- package/esm/typings/src/types/Prompt.d.ts +111 -0
- package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
- package/esm/typings/src/types/SectionType.d.ts +21 -0
- package/esm/typings/src/types/TaskType.d.ts +15 -0
- package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
- package/esm/typings/src/types/typeAliases.d.ts +679 -0
- package/esm/typings/src/utils/$Register.d.ts +40 -0
- package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
- package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
- package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
- package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
- package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +17 -0
- package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.test.d.ts +1 -0
- package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +13 -0
- package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +1 -0
- package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.d.ts +22 -0
- package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts +1 -0
- package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
- package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts +8 -0
- package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +1 -0
- package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +29 -0
- package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
- package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
- package/esm/typings/src/utils/emojis.d.ts +24 -0
- package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +10 -0
- package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +11 -0
- package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +11 -0
- package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +11 -0
- package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +11 -0
- package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
- package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
- package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
- package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
- package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
- package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
- package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +10 -0
- package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/countLines.d.ts +12 -0
- package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/countPages.d.ts +12 -0
- package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +10 -0
- package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +16 -0
- package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/countWords.d.ts +10 -0
- package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
- package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
- package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
- package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
- package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
- package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
- package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
- package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
- package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
- package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
- package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
- package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
- package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +10 -0
- package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
- package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
- package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
- package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
- package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
- package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
- package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
- package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
- package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
- package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
- package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/removeMarkdownComments.d.ts +10 -0
- package/esm/typings/src/utils/markdown/removeMarkdownComments.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
- package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
- package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
- package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
- package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
- package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
- package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
- package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
- package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
- package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
- package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
- package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
- package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
- package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
- package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
- package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
- package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
- package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
- package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
- package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
- package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/searchKeywords.d.ts +13 -0
- package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/suffixUrl.d.ts +7 -0
- package/esm/typings/src/utils/normalization/suffixUrl.test.d.ts +1 -0
- package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
- package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
- package/esm/typings/src/utils/organization/$sideEffect.d.ts +9 -0
- package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
- package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
- package/esm/typings/src/utils/organization/TODO_narrow.d.ts +6 -0
- package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
- package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
- package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
- package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
- package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
- package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
- package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
- package/esm/typings/src/utils/organization/just.d.ts +14 -0
- package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
- package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
- package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
- package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
- package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
- package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
- package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
- package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
- package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
- package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
- package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
- package/esm/typings/src/utils/parameters/numberToString.test.d.ts +1 -0
- package/esm/typings/src/utils/parameters/templateParameters.d.ts +16 -0
- package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
- package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
- package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
- package/esm/typings/src/utils/parseNumber.d.ts +16 -0
- package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
- package/esm/typings/src/utils/random/$randomSeed.d.ts +10 -0
- package/esm/typings/src/utils/random/$randomToken.d.ts +13 -0
- package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
- package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
- package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
- package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
- package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
- package/esm/typings/src/utils/serialization/asSerializable.d.ts +15 -0
- package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
- package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
- package/esm/typings/src/utils/serialization/clonePipeline.d.ts +14 -0
- package/esm/typings/src/utils/serialization/deepClone.d.ts +14 -0
- package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
- package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
- package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
- package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
- package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts +9 -0
- package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts +1 -0
- package/esm/typings/src/utils/sets/difference.d.ts +10 -0
- package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
- package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
- package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
- package/esm/typings/src/utils/sets/union.d.ts +7 -0
- package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
- package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
- package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
- package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
- package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
- package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
- package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
- package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts +12 -0
- package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts +4 -0
- package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +12 -0
- package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
- package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +11 -0
- package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
- package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
- package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
- package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
- package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
- package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
- package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
- package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
- package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
- package/esm/typings/src/version.d.ts +26 -0
- package/esm/typings/src/wizard/$getCompiledBook.d.ts +16 -0
- package/esm/typings/src/wizard/wizard.d.ts +68 -0
- package/package.json +104 -0
- package/umd/index.umd.js +16694 -0
- package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,61 @@
|
|
1
|
+
import type { Promisable } from 'type-fest';
|
2
|
+
import type { Prompt } from '../types/Prompt';
|
3
|
+
import type { string_markdown } from '../types/typeAliases';
|
4
|
+
import type { string_markdown_text } from '../types/typeAliases';
|
5
|
+
import type { string_title } from '../types/typeAliases';
|
6
|
+
import type { AvailableModel } from './AvailableModel';
|
7
|
+
import type { ChatPromptResult } from './PromptResult';
|
8
|
+
import type { CompletionPromptResult } from './PromptResult';
|
9
|
+
import type { EmbeddingPromptResult } from './PromptResult';
|
10
|
+
/**
|
11
|
+
* Container for all the tools needed to execute prompts to large language models like GPT-4
|
12
|
+
* On its interface it exposes common methods for prompt execution.
|
13
|
+
* Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
|
14
|
+
*
|
15
|
+
* @see https://github.com/webgptorg/promptbook#llm-execution-tools
|
16
|
+
*/
|
17
|
+
export type LlmExecutionTools = {
|
18
|
+
/**
|
19
|
+
* Title of the model provider
|
20
|
+
*
|
21
|
+
* @example "OpenAI"
|
22
|
+
*/
|
23
|
+
readonly title: string_title & string_markdown_text;
|
24
|
+
/**
|
25
|
+
* Description of the provider
|
26
|
+
*
|
27
|
+
* @example "Use all models from OpenAI"
|
28
|
+
*/
|
29
|
+
readonly description?: string_markdown;
|
30
|
+
/**
|
31
|
+
* Check comfiguration
|
32
|
+
*
|
33
|
+
* @returns nothing if configuration is correct
|
34
|
+
* @throws {Error} if configuration is incorrect
|
35
|
+
*/
|
36
|
+
checkConfiguration(): Promisable<void>;
|
37
|
+
/**
|
38
|
+
* List all available models that can be used
|
39
|
+
*/
|
40
|
+
listModels(): Promisable<ReadonlyArray<AvailableModel>>;
|
41
|
+
/**
|
42
|
+
* Calls a chat model
|
43
|
+
*/
|
44
|
+
callChatModel?(prompt: Prompt): Promise<ChatPromptResult>;
|
45
|
+
/**
|
46
|
+
* Calls a completion model
|
47
|
+
*/
|
48
|
+
callCompletionModel?(prompt: Prompt): Promise<CompletionPromptResult>;
|
49
|
+
/**
|
50
|
+
* Calls an embedding model
|
51
|
+
*/
|
52
|
+
callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
|
53
|
+
};
|
54
|
+
/**
|
55
|
+
* TODO: [🍚] Implement destroyable pattern to free resources
|
56
|
+
* TODO: [🏳] Add `callTranslationModel`
|
57
|
+
* TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
|
58
|
+
* TODO: [🍓][♐] Some heuristic to pick the best model in listed models
|
59
|
+
* TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
|
60
|
+
* TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
|
61
|
+
*/
|
@@ -0,0 +1,11 @@
|
|
1
|
+
import type { Registered } from '../utils/$Register';
|
2
|
+
import type { TODO_any } from '../utils/organization/TODO_any';
|
3
|
+
import type { LlmExecutionTools } from './LlmExecutionTools';
|
4
|
+
/**
|
5
|
+
* Type representing a constructor for LLM execution tools, which are used to interact with language models.
|
6
|
+
* Combines registration metadata with a factory function for creating LLM tool instances.
|
7
|
+
*/
|
8
|
+
export type LlmExecutionToolsConstructor = Registered & ((options: TODO_any) => LlmExecutionTools);
|
9
|
+
/**
|
10
|
+
* TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
|
11
|
+
*/
|
@@ -0,0 +1,16 @@
|
|
1
|
+
import type { InputParameters } from '../types/typeAliases';
|
2
|
+
import type { ExecutionTask } from './ExecutionTask';
|
3
|
+
/**
|
4
|
+
* Executor is a simple async function that takes INPUT PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT PARAMETERs = it extends input object)_.
|
5
|
+
* Executor is made by combining execution tools and pipeline collection.
|
6
|
+
*
|
7
|
+
* It can be created with `createPipelineExecutor` function.
|
8
|
+
*
|
9
|
+
* @see https://github.com/webgptorg/promptbook#executor
|
10
|
+
*/
|
11
|
+
export type PipelineExecutor = {
|
12
|
+
(inputParameters: InputParameters): ExecutionTask;
|
13
|
+
};
|
14
|
+
/**
|
15
|
+
* TODO: [🧠] Should this file be in /execution or /types folder?
|
16
|
+
*/
|
@@ -0,0 +1,39 @@
|
|
1
|
+
import { ReadonlyDeep } from 'type-fest';
|
2
|
+
import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
|
3
|
+
import type { Parameters } from '../types/typeAliases';
|
4
|
+
import type { AbstractTaskResult } from './AbstractTaskResult';
|
5
|
+
import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
|
6
|
+
import type { Usage } from './Usage';
|
7
|
+
/**
|
8
|
+
* The result of executing a pipeline
|
9
|
+
*
|
10
|
+
* Note: [🚉] This is fully serializable as JSON
|
11
|
+
*/
|
12
|
+
export type PipelineExecutorResult = AbstractTaskResult & {
|
13
|
+
/**
|
14
|
+
* Result parameters of the execution
|
15
|
+
*
|
16
|
+
* Note: If the execution was not successful, there are only some of the result parameters
|
17
|
+
*/
|
18
|
+
readonly outputParameters: Readonly<Parameters>;
|
19
|
+
/**
|
20
|
+
* Added usage of whole execution, detailed usage is available in `executionReport`
|
21
|
+
*/
|
22
|
+
readonly usage: ReadonlyDeep<Usage>;
|
23
|
+
/**
|
24
|
+
* The report of the execution with all details
|
25
|
+
*
|
26
|
+
* Note: If the execution fails unexpectedly, this will be `null`
|
27
|
+
*/
|
28
|
+
readonly executionReport: ReadonlyDeep<ExecutionReportJson> | null;
|
29
|
+
/**
|
30
|
+
* The prepared pipeline that was used for the execution
|
31
|
+
*
|
32
|
+
* Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
|
33
|
+
* If you passed not fully prepared pipeline, this is same pipeline but fully prepared
|
34
|
+
*/
|
35
|
+
readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
|
36
|
+
};
|
37
|
+
/**
|
38
|
+
* TODO: [🧠] Should this file be in /execution or /types folder?
|
39
|
+
*/
|
@@ -0,0 +1,101 @@
|
|
1
|
+
import type { string_date_iso8601 } from '../types/typeAliases';
|
2
|
+
import type { string_model_name } from '../types/typeAliases';
|
3
|
+
import type { string_prompt } from '../types/typeAliases';
|
4
|
+
import type { TODO_object } from '../utils/organization/TODO_object';
|
5
|
+
import type { EmbeddingVector } from './EmbeddingVector';
|
6
|
+
import type { Usage } from './Usage';
|
7
|
+
/**
|
8
|
+
* Prompt result is the simplest concept of execution.
|
9
|
+
* It is the result of executing one prompt _(NOT a template)_.
|
10
|
+
*
|
11
|
+
* @see https://github.com/webgptorg/promptbook#prompt-result
|
12
|
+
*/
|
13
|
+
export type PromptResult = CompletionPromptResult | ChatPromptResult | EmbeddingPromptResult;
|
14
|
+
/**
|
15
|
+
* Completion prompt result
|
16
|
+
*
|
17
|
+
* Note:It contains only the newly generated text NOT the whole completion
|
18
|
+
* Note: [🚉] This is fully serializable as JSON
|
19
|
+
*/
|
20
|
+
export type CompletionPromptResult = CommonPromptResult;
|
21
|
+
/**
|
22
|
+
*Chat prompt result
|
23
|
+
*
|
24
|
+
* Note: [🚉] This is fully serializable as JSON
|
25
|
+
*/
|
26
|
+
export type ChatPromptResult = CommonPromptResult & {};
|
27
|
+
/**
|
28
|
+
* Embedding prompt result
|
29
|
+
*
|
30
|
+
* Note: [🚉] This is fully serializable as JSON
|
31
|
+
*/
|
32
|
+
export type EmbeddingPromptResult = Omit<CommonPromptResult, 'content'> & {
|
33
|
+
/**
|
34
|
+
* The response from the model
|
35
|
+
*/
|
36
|
+
content: EmbeddingVector;
|
37
|
+
};
|
38
|
+
/**
|
39
|
+
* Common properties for all prompt results
|
40
|
+
*
|
41
|
+
* Note: [🚉] This is fully serializable as JSON
|
42
|
+
*
|
43
|
+
* @private just abstract the common properties of the prompt results
|
44
|
+
*/
|
45
|
+
export type CommonPromptResult = {
|
46
|
+
/**
|
47
|
+
* Exact text response from the model
|
48
|
+
*/
|
49
|
+
readonly content: string;
|
50
|
+
/**
|
51
|
+
* Name of the model used to generate the response
|
52
|
+
*/
|
53
|
+
readonly modelName: string_model_name;
|
54
|
+
/**
|
55
|
+
* Timing
|
56
|
+
*/
|
57
|
+
readonly timing: {
|
58
|
+
/**
|
59
|
+
* Start of the execution
|
60
|
+
*/
|
61
|
+
readonly start: string_date_iso8601;
|
62
|
+
/**
|
63
|
+
* First token generated
|
64
|
+
*/
|
65
|
+
readonly firstToken?: string_date_iso8601;
|
66
|
+
/**
|
67
|
+
* End of the execution
|
68
|
+
*/
|
69
|
+
readonly complete: string_date_iso8601;
|
70
|
+
};
|
71
|
+
/**
|
72
|
+
* Usage of the prompt execution
|
73
|
+
*/
|
74
|
+
readonly usage: Usage;
|
75
|
+
/**
|
76
|
+
* Exact text of the prompt (with all replacements)
|
77
|
+
*
|
78
|
+
* Note: This contains redundant information
|
79
|
+
*/
|
80
|
+
readonly rawPromptContent: string_prompt;
|
81
|
+
/**
|
82
|
+
* Raw request to the model
|
83
|
+
*
|
84
|
+
* Note: This contains redundant information
|
85
|
+
*/
|
86
|
+
readonly rawRequest: TODO_object | null;
|
87
|
+
/**
|
88
|
+
* Raw response from the model
|
89
|
+
*
|
90
|
+
* Note: This contains redundant information
|
91
|
+
*/
|
92
|
+
readonly rawResponse: TODO_object;
|
93
|
+
};
|
94
|
+
/**
|
95
|
+
* TODO: [🧠] Maybe timing more accurate then seconds?
|
96
|
+
* TODO: [🧠] Should here be link to the prompt?
|
97
|
+
* TODO: [🧠] Maybe type `rawResponse` properly - not onject but OpenAI.result.whatever
|
98
|
+
* TODO: [🧠] Maybe remove redundant raw.choices.text
|
99
|
+
* TODO: Log raw even if prompt failed - log the raw error
|
100
|
+
* TODO: [🏳] Add `TranslationPromptResult`
|
101
|
+
*/
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import type { string_url } from '../types/typeAliases';
|
2
|
+
/**
|
3
|
+
* Fetch function used in Promptbook engine
|
4
|
+
*
|
5
|
+
* In most cases it is just native `fetch` function with a lightweight error handling wrapper
|
6
|
+
* But it can be replaced with any other fetch function, polyfill, custom implementation, security layer, etc.
|
7
|
+
*
|
8
|
+
* It is used in these places:
|
9
|
+
* - Fetching knowledge sources
|
10
|
+
* - Callbacks from remote server
|
11
|
+
*/
|
12
|
+
export type PromptbookFetch = (url: string_url, init?: RequestInit) => Promise<Response>;
|
@@ -0,0 +1,39 @@
|
|
1
|
+
import type { ScriptLanguage } from '../types/ScriptLanguage';
|
2
|
+
import type { Parameters } from '../types/typeAliases';
|
3
|
+
import type { string_script } from '../types/typeAliases';
|
4
|
+
/**
|
5
|
+
* Represents all the tools needed to execute `SCRIPT` tasks
|
6
|
+
*
|
7
|
+
* @see https://github.com/webgptorg/promptbook#script-execution-tools
|
8
|
+
*/
|
9
|
+
export type ScriptExecutionTools = {
|
10
|
+
execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
|
11
|
+
};
|
12
|
+
/**
|
13
|
+
* Input for the script execution
|
14
|
+
*/
|
15
|
+
export type ScriptExecutionToolsExecuteOptions = {
|
16
|
+
/**
|
17
|
+
* Language of the script
|
18
|
+
*/
|
19
|
+
readonly scriptLanguage: ScriptLanguage;
|
20
|
+
/**
|
21
|
+
* Parameters for the script
|
22
|
+
* These parameters are passed to the script as variables
|
23
|
+
* For example: { "name": "John" } => const name = "John";
|
24
|
+
*/
|
25
|
+
readonly parameters: Parameters;
|
26
|
+
/**
|
27
|
+
* The content of the script to execute
|
28
|
+
* - It can be a single statement
|
29
|
+
* - It can be multiple statements separated by semicolon and return
|
30
|
+
* - It can be a function (but you need to call it)
|
31
|
+
* - It can be IIFE (immediately invoked function expression)
|
32
|
+
* - It can use the parameters as variables and functions from global scope
|
33
|
+
*/
|
34
|
+
readonly script: string_script;
|
35
|
+
};
|
36
|
+
/**
|
37
|
+
* TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
|
38
|
+
* TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
|
39
|
+
*/
|
@@ -0,0 +1,19 @@
|
|
1
|
+
import type { number_positive } from '../types/typeAliases';
|
2
|
+
import type { number_usd } from '../types/typeAliases';
|
3
|
+
/**
|
4
|
+
* Number which can be uncertain
|
5
|
+
*
|
6
|
+
* Note: [🚉] This is fully serializable as JSON
|
7
|
+
* Note: If the value is completelly unknown, the value 0 and isUncertain is true
|
8
|
+
* Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
|
9
|
+
*/
|
10
|
+
export type UncertainNumber = {
|
11
|
+
/**
|
12
|
+
* The numeric value
|
13
|
+
*/
|
14
|
+
readonly value: number_usd & (number_positive | 0);
|
15
|
+
/**
|
16
|
+
* Is the value uncertain
|
17
|
+
*/
|
18
|
+
readonly isUncertain?: true;
|
19
|
+
};
|
@@ -0,0 +1,33 @@
|
|
1
|
+
import type { KebabCase } from 'type-fest';
|
2
|
+
import type { ExpectationUnit } from '../pipeline/PipelineJson/Expectations';
|
3
|
+
import type { UncertainNumber } from './UncertainNumber';
|
4
|
+
/**
|
5
|
+
* Usage statistics for one or more prompt results
|
6
|
+
*
|
7
|
+
* Note: [🚉] This is fully serializable as JSON
|
8
|
+
*/
|
9
|
+
export type Usage = {
|
10
|
+
/**
|
11
|
+
* Cost of the execution in USD
|
12
|
+
*
|
13
|
+
* Note: If the cost is unknown, the value 0 and isUncertain is true
|
14
|
+
*/
|
15
|
+
readonly price: UncertainNumber;
|
16
|
+
/**
|
17
|
+
* Number of whatever used in the input aka. `prompt_tokens`
|
18
|
+
*/
|
19
|
+
readonly input: UsageCounts;
|
20
|
+
/**
|
21
|
+
* Number of tokens used in the output aka. `completion_tokens`
|
22
|
+
*/
|
23
|
+
readonly output: UsageCounts;
|
24
|
+
};
|
25
|
+
/**
|
26
|
+
* Record of all possible measurable units
|
27
|
+
*
|
28
|
+
* Note: [🚉] This is fully serializable as JSON
|
29
|
+
*/
|
30
|
+
export type UsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
|
31
|
+
/**
|
32
|
+
* TODO: [🍙] Make some standard order of json properties
|
33
|
+
*/
|
@@ -0,0 +1,46 @@
|
|
1
|
+
import type { number_integer } from '../types/typeAliases';
|
2
|
+
import type { number_positive } from '../types/typeAliases';
|
3
|
+
/**
|
4
|
+
* Represents all the tools needed to interact with the user.
|
5
|
+
*
|
6
|
+
* @see https://github.com/webgptorg/promptbook#user-interface-tools
|
7
|
+
*/
|
8
|
+
export type UserInterfaceTools = {
|
9
|
+
/**
|
10
|
+
* Asks the user to answer a free-text (multi-line) question
|
11
|
+
*
|
12
|
+
* @param options the question to ask
|
13
|
+
* @returns the answer from the user
|
14
|
+
*/
|
15
|
+
promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
|
16
|
+
};
|
17
|
+
export type UserInterfaceToolsPromptDialogOptions = {
|
18
|
+
/**
|
19
|
+
* Prompt title
|
20
|
+
*
|
21
|
+
* Note: This is not a prompt to language model but a prompt to the user
|
22
|
+
* @example "Your name"
|
23
|
+
*/
|
24
|
+
readonly promptTitle: string;
|
25
|
+
/**
|
26
|
+
* Prompt message
|
27
|
+
*
|
28
|
+
* Note: This is not a prompt to language model but a prompt to the user
|
29
|
+
* @example "Please enter your name, including your last name, title, etc."
|
30
|
+
*/
|
31
|
+
readonly promptMessage: string;
|
32
|
+
/**
|
33
|
+
* Default value for the input/textarea
|
34
|
+
*/
|
35
|
+
readonly defaultValue: string | null;
|
36
|
+
/**
|
37
|
+
* Placeholder for the input/textarea
|
38
|
+
*/
|
39
|
+
readonly placeholder?: string;
|
40
|
+
/**
|
41
|
+
* Priority of the prompt
|
42
|
+
*
|
43
|
+
* Note: This would be reflected for example into the UI z-index of the prompt modal
|
44
|
+
*/
|
45
|
+
readonly priority: number_integer & number_positive;
|
46
|
+
};
|
@@ -0,0 +1,14 @@
|
|
1
|
+
import type { PipelineExecutorResult } from './PipelineExecutorResult';
|
2
|
+
/**
|
3
|
+
* Asserts that the execution of a Promptbook is successful
|
4
|
+
*
|
5
|
+
* Note: If there are only warnings, the execution is still successful but the warnings are logged in the console
|
6
|
+
*
|
7
|
+
* @param executionResult - The partial result of the Promptbook execution
|
8
|
+
* @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
|
9
|
+
* @private internal helper function of `asPromise` method of `ExecutionTask`
|
10
|
+
*/
|
11
|
+
export declare function assertsTaskSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors' | 'warnings'>): void;
|
12
|
+
/**
|
13
|
+
* TODO: [🧠] Can this return type be better typed than void
|
14
|
+
*/
|
@@ -0,0 +1,48 @@
|
|
1
|
+
import { ExpectError } from '../../errors/ExpectError';
|
2
|
+
import type { Prompt } from '../../types/Prompt';
|
3
|
+
import type { ChatPromptResult } from '../PromptResult';
|
4
|
+
import type { CompletionPromptResult } from '../PromptResult';
|
5
|
+
import type { EmbeddingPromptResult } from '../PromptResult';
|
6
|
+
import type { PromptResult } from '../PromptResult';
|
7
|
+
/**
|
8
|
+
* Represents the ongoing result of a pipeline task execution
|
9
|
+
*
|
10
|
+
* Used internally by the pipeline executor to track state during execution attempts
|
11
|
+
*
|
12
|
+
* @private internal utility of `createPipelineExecutor`
|
13
|
+
*/
|
14
|
+
export type $OngoingTaskResult = {
|
15
|
+
/**
|
16
|
+
* The prompt object used for the current execution attempt, if applicable.
|
17
|
+
*/
|
18
|
+
$prompt?: Prompt;
|
19
|
+
/**
|
20
|
+
* The result of a chat model execution, if applicable.
|
21
|
+
*/
|
22
|
+
$chatResult?: ChatPromptResult;
|
23
|
+
/**
|
24
|
+
* The result of a completion model execution, if applicable.
|
25
|
+
*/
|
26
|
+
$completionResult?: CompletionPromptResult;
|
27
|
+
/**
|
28
|
+
* The result of an embedding model execution, if applicable.
|
29
|
+
* Note: [🤖] Embedding results are less common in standard pipelines.
|
30
|
+
*/
|
31
|
+
$embeddingResult?: EmbeddingPromptResult;
|
32
|
+
/**
|
33
|
+
* The final result object for the task, or null if not yet available.
|
34
|
+
*/
|
35
|
+
$result: PromptResult | null;
|
36
|
+
/**
|
37
|
+
* The result string produced by the task, or null if not yet available.
|
38
|
+
*/
|
39
|
+
$resultString: string | null;
|
40
|
+
/**
|
41
|
+
* The last expectation error encountered, or null if none.
|
42
|
+
*/
|
43
|
+
$expectError: ExpectError | null;
|
44
|
+
/**
|
45
|
+
* List of errors encountered during script postprocessing or execution.
|
46
|
+
*/
|
47
|
+
$scriptPipelineExecutionErrors: Array<Error>;
|
48
|
+
};
|
package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
import type { CsvSettings } from '../../formats/csv/CsvSettings';
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
3
|
+
import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
|
4
|
+
import type { ExecutionTools } from '../ExecutionTools';
|
5
|
+
/**
|
6
|
+
* Options for `createPipelineExecutor`
|
7
|
+
*/
|
8
|
+
export type CreatePipelineExecutorOptions = PrepareAndScrapeOptions & {
|
9
|
+
/**
|
10
|
+
* The pipeline to be executed
|
11
|
+
*/
|
12
|
+
readonly pipeline: PipelineJson;
|
13
|
+
/**
|
14
|
+
* The execution tools to be used during the execution of the pipeline
|
15
|
+
*/
|
16
|
+
readonly tools: ExecutionTools;
|
17
|
+
/**
|
18
|
+
* When executor does not satisfy expectations it will be retried this amount of times
|
19
|
+
*
|
20
|
+
* @default MAX_EXECUTION_ATTEMPTS
|
21
|
+
*/
|
22
|
+
readonly maxExecutionAttempts?: number;
|
23
|
+
/**
|
24
|
+
* Settings for CSV format
|
25
|
+
*
|
26
|
+
* @default DEFAULT_CSV_SETTINGS
|
27
|
+
*/
|
28
|
+
readonly csvSettings?: CsvSettings;
|
29
|
+
/**
|
30
|
+
* If you pass fully prepared pipeline, this does not matter
|
31
|
+
*
|
32
|
+
* Otherwise:
|
33
|
+
* If false or not set, warning is shown when pipeline is not prepared
|
34
|
+
* If true, warning is suppressed
|
35
|
+
*
|
36
|
+
* @default false
|
37
|
+
*/
|
38
|
+
readonly isNotPreparedWarningSuppressed?: boolean;
|
39
|
+
};
|
40
|
+
/**
|
41
|
+
* TODO: [🧎][🧠] Move `csvSettings` to some better place
|
42
|
+
* 1) either to some dependency in `ExecutionTools`
|
43
|
+
* 2) or make here container for multiple formats
|
44
|
+
* 3) or make the setting more universal and which just sets things like `delimiter` and `quote` without specifying the format
|
45
|
+
* TODO: [🤹♂️] More granular setting for limits of execution + better waiting for queue
|
46
|
+
*/
|
@@ -0,0 +1,10 @@
|
|
1
|
+
import type { PipelineExecutor } from '../PipelineExecutor';
|
2
|
+
import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
|
3
|
+
/**
|
4
|
+
* Creates executor function from pipeline and execution tools.
|
5
|
+
*
|
6
|
+
* @returns The executor function
|
7
|
+
* @throws {PipelineLogicError} on logical error in the pipeline
|
8
|
+
* @public exported from `@promptbook/core`
|
9
|
+
*/
|
10
|
+
export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
|
@@ -0,0 +1,48 @@
|
|
1
|
+
import type { PartialDeep, Promisable, ReadonlyDeep } from 'type-fest';
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
3
|
+
import type { InputParameters } from '../../types/typeAliases';
|
4
|
+
import type { PipelineExecutorResult } from '../PipelineExecutorResult';
|
5
|
+
import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
|
6
|
+
/**
|
7
|
+
* Options for executing an entire pipeline, including input parameters, pipeline context, and progress callbacks.
|
8
|
+
*
|
9
|
+
* @private internal type of `executePipeline`
|
10
|
+
*/
|
11
|
+
type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
|
12
|
+
/**
|
13
|
+
* The input parameters provided by the user for pipeline execution.
|
14
|
+
*/
|
15
|
+
readonly inputParameters: Readonly<InputParameters>;
|
16
|
+
/**
|
17
|
+
* Optional callback invoked with partial results as the pipeline execution progresses.
|
18
|
+
*/
|
19
|
+
onProgress?(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
|
20
|
+
/**
|
21
|
+
* The pipeline definition to execute.
|
22
|
+
*/
|
23
|
+
readonly pipeline: PipelineJson;
|
24
|
+
/**
|
25
|
+
* The prepared and validated pipeline, ready for execution.
|
26
|
+
*/
|
27
|
+
readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
|
28
|
+
/**
|
29
|
+
* Callback to update the prepared pipeline reference after preparation.
|
30
|
+
*/
|
31
|
+
setPreparedPipeline(preparedPipeline: ReadonlyDeep<PipelineJson>): void;
|
32
|
+
/**
|
33
|
+
* String identifier for the pipeline, used in error messages and reporting.
|
34
|
+
*/
|
35
|
+
readonly pipelineIdentification: string;
|
36
|
+
};
|
37
|
+
/**
|
38
|
+
* Executes an entire pipeline, resolving tasks in dependency order, handling errors, and reporting progress.
|
39
|
+
*
|
40
|
+
* Note: This is not a `PipelineExecutor` (which is bound to a single pipeline), but a utility function used by `createPipelineExecutor` to create a `PipelineExecutor`.
|
41
|
+
*
|
42
|
+
* @param options - Options for execution, including input parameters, pipeline, and callbacks.
|
43
|
+
* @returns The result of the pipeline execution, including output parameters, errors, and usage statistics.
|
44
|
+
*
|
45
|
+
* @private internal utility of `createPipelineExecutor`
|
46
|
+
*/
|
47
|
+
export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
|
48
|
+
export {};
|
@@ -0,0 +1,51 @@
|
|
1
|
+
import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
3
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
4
|
+
import type { Parameters } from '../../types/typeAliases';
|
5
|
+
import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
|
6
|
+
import type { PipelineExecutorResult } from '../PipelineExecutorResult';
|
7
|
+
import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
|
8
|
+
/**
|
9
|
+
* Options for executing a single pipeline task, including task details, pipeline context, parameters, and callbacks.
|
10
|
+
*
|
11
|
+
* @private internal type of `executeTask`
|
12
|
+
*/
|
13
|
+
type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
|
14
|
+
/**
|
15
|
+
* The task to be executed.
|
16
|
+
*/
|
17
|
+
readonly currentTask: ReadonlyDeep<TaskJson>;
|
18
|
+
/**
|
19
|
+
* The pipeline in which the task resides, fully prepared and validated.
|
20
|
+
*/
|
21
|
+
readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
|
22
|
+
/**
|
23
|
+
* The parameters to pass to the task execution.
|
24
|
+
*/
|
25
|
+
readonly parametersToPass: Readonly<Parameters>;
|
26
|
+
/**
|
27
|
+
* Callback invoked with partial results as the execution progresses.
|
28
|
+
*/
|
29
|
+
onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
|
30
|
+
/**
|
31
|
+
* Mutable execution report object for tracking execution details.
|
32
|
+
*/
|
33
|
+
readonly $executionReport: WritableDeep<ExecutionReportJson>;
|
34
|
+
/**
|
35
|
+
* String identifier for the pipeline, used in error messages and reporting.
|
36
|
+
*/
|
37
|
+
readonly pipelineIdentification: string;
|
38
|
+
};
|
39
|
+
/**
|
40
|
+
* Executes a single task within a pipeline, handling parameter validation, error checking, and progress reporting.
|
41
|
+
*
|
42
|
+
* @param options - Options for execution, including the task, pipeline, parameters, and callbacks.
|
43
|
+
* @returns The output parameters produced by the task.
|
44
|
+
*
|
45
|
+
* @private internal utility of `createPipelineExecutor`
|
46
|
+
*/
|
47
|
+
export declare function executeTask(options: executeSingleTaskOptions): Promise<Readonly<Parameters>>;
|
48
|
+
export {};
|
49
|
+
/**
|
50
|
+
* TODO: [🤹♂️]
|
51
|
+
*/
|
@@ -0,0 +1,27 @@
|
|
1
|
+
import type { PartialDeep, Promisable } from 'type-fest';
|
2
|
+
import type { TODO_any } from '../../utils/organization/TODO_any';
|
3
|
+
import type { PipelineExecutorResult } from '../PipelineExecutorResult';
|
4
|
+
import type { ExecuteAttemptsOptions } from './40-executeAttempts';
|
5
|
+
/**
|
6
|
+
* Options for executing a pipeline task that involves formatting subvalues (e.g., iterating over CSV rows).
|
7
|
+
* Extends ExecuteAttemptsOptions with a progress callback.
|
8
|
+
*
|
9
|
+
* @private internal type of `executeFormatSubvalues`
|
10
|
+
*/
|
11
|
+
type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
|
12
|
+
/**
|
13
|
+
* Callback invoked with partial results as the execution progresses.
|
14
|
+
*/
|
15
|
+
onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
|
16
|
+
};
|
17
|
+
/**
|
18
|
+
* Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).
|
19
|
+
* Handles format and subformat resolution, error handling, and progress reporting.
|
20
|
+
*
|
21
|
+
* @param options - Options for execution, including task details and progress callback.
|
22
|
+
* @returns The result of the subvalue mapping or execution attempts.
|
23
|
+
*
|
24
|
+
* @private internal utility of `createPipelineExecutor`
|
25
|
+
*/
|
26
|
+
export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
|
27
|
+
export {};
|