@promptbook/remote-server 0.72.0-8 → 0.72.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 +8 -8
- package/esm/index.es.js +183 -78
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/browser.index.d.ts +2 -0
- package/esm/typings/src/_packages/cli.index.d.ts +20 -0
- package/esm/typings/src/_packages/core.index.d.ts +42 -30
- package/esm/typings/src/_packages/documents.index.d.ts +8 -0
- package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
- package/esm/typings/src/_packages/markdown-utils.index.d.ts +6 -0
- package/esm/typings/src/_packages/node.index.d.ts +12 -4
- package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
- package/esm/typings/src/_packages/types.index.d.ts +33 -17
- package/esm/typings/src/_packages/utils.index.d.ts +2 -2
- package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
- package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
- package/esm/typings/src/collection/SimplePipelineCollection.d.ts +2 -2
- package/esm/typings/src/collection/collectionToJson.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +5 -3
- package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +1 -1
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +5 -5
- package/esm/typings/src/config.d.ts +26 -13
- package/esm/typings/src/conversion/pipelineStringToJson.d.ts +3 -1
- package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +2 -2
- package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +3 -3
- package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
- package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
- package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
- package/esm/typings/src/executables/locateApp.d.ts +33 -0
- package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
- package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
- package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
- package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
- package/esm/typings/src/execution/EmbeddingVector.d.ts +1 -1
- package/esm/typings/src/execution/Executables.d.ts +18 -0
- package/esm/typings/src/execution/ExecutionTools.d.ts +32 -6
- package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
- package/esm/typings/src/execution/LlmExecutionTools.d.ts +2 -2
- package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
- package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +3 -2
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +29 -6
- package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +3 -12
- package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +4 -18
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +9 -19
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -3
- package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +1 -0
- package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
- package/esm/typings/src/execution/utils/addUsage.d.ts +1 -1
- package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -1
- package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
- package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +2 -2
- package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
- package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
- package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
- package/esm/typings/src/llm-providers/_common/{getLlmToolsForCli.d.ts → register/$provideLlmToolsForCli.d.ts} +4 -11
- package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
- package/esm/typings/src/llm-providers/_common/{createLlmToolsFromEnv.d.ts → register/$provideLlmToolsFromEnv.d.ts} +6 -5
- package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
- package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +6 -5
- package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
- package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
- package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +12 -4
- package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +4 -1
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +5 -5
- package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
- package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +4 -3
- package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
- package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
- package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
- package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +0 -1
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -2
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +4 -4
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +5 -4
- package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +5 -4
- package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +16 -7
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +4 -4
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +7 -13
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +3 -3
- package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +11 -16
- package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +24 -9
- package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
- package/esm/typings/src/personas/preparePersona.d.ts +2 -1
- package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +10 -28
- package/esm/typings/src/prepare/preparePipeline.d.ts +2 -1
- package/esm/typings/src/prepare/prepareTemplates.d.ts +3 -2
- package/esm/typings/src/scrapers/_common/Converter.d.ts +4 -10
- package/esm/typings/src/scrapers/_common/Scraper.d.ts +5 -17
- package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +2 -1
- package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
- package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
- package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
- package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
- package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
- package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
- package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +3 -2
- package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +3 -2
- package/esm/typings/src/scrapers/document/{documentScraper.d.ts → DocumentScraper.d.ts} +18 -12
- package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
- package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
- package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
- package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
- package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/website/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/website/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
- package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
- package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -1
- package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +3 -3
- package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +3 -3
- package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +5 -3
- package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +1 -1
- package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
- package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
- package/esm/typings/src/types/Arrayable.d.ts +1 -1
- package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
- package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +4 -4
- package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +2 -2
- package/esm/typings/src/types/Prompt.d.ts +2 -1
- package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -1
- package/esm/typings/src/types/typeAliases.d.ts +18 -8
- package/esm/typings/src/utils/$Register.d.ts +20 -7
- package/esm/typings/src/utils/FromtoItems.d.ts +1 -1
- package/esm/typings/src/utils/arrayableToArray.d.ts +1 -1
- package/esm/typings/src/utils/emojis.d.ts +1 -1
- package/esm/typings/src/utils/execCommand/$execCommand.d.ts +5 -3
- package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
- package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
- package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
- package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
- package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -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 → listAllFiles.d.ts} +3 -4
- package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
- package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
- package/esm/typings/src/utils/normalization/IKeywords.d.ts +2 -2
- package/esm/typings/src/utils/normalization/parseKeywords.d.ts +2 -2
- package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +2 -2
- package/esm/typings/src/utils/normalization/searchKeywords.d.ts +2 -2
- package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -1
- package/esm/typings/src/utils/organization/keepUnused.d.ts +1 -1
- package/esm/typings/src/utils/random/$randomSeed.d.ts +1 -1
- package/esm/typings/src/utils/sets/intersection.d.ts +1 -1
- package/esm/typings/src/utils/sets/union.d.ts +1 -1
- package/esm/typings/src/utils/unwrapResult.d.ts +4 -4
- package/package.json +4 -3
- package/umd/index.umd.js +183 -78
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +0 -29
- package/esm/typings/src/scrapers/document-legacy/legacyDocumentScraper.d.ts +0 -37
- package/esm/typings/src/scrapers/index.d.ts +0 -8
- package/esm/typings/src/scrapers/markdown/markdownScraper.d.ts +0 -29
- package/esm/typings/src/scrapers/pdf/pdfScraper.d.ts +0 -35
- package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +0 -12
- package/esm/typings/src/scrapers/website/websiteScraper.d.ts +0 -43
- package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts +0 -23
- package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +0 -10
- package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +0 -15
- package/esm/typings/src/utils/files/$isFileExisting.d.ts +0 -14
- /package/esm/typings/src/{scrapers/website/utils/markdownConverter.test.d.ts → executables/apps/locateLibreoffice.test.d.ts} +0 -0
- /package/esm/typings/src/{scrapers/website/websiteScraper.test.d.ts → executables/apps/locatePandoc.test.d.ts} +0 -0
- /package/esm/typings/src/{utils/files/$isDirectoryExisting.test.d.ts → executables/locateApp.test.d.ts} +0 -0
- /package/esm/typings/src/scrapers/document/{documentScraper.test.d.ts → DocumentScraper.test.d.ts} +0 -0
- /package/esm/typings/src/scrapers/document-legacy/{legacyDocumentScraper.test.d.ts → LegacyDocumentScraper.test.d.ts} +0 -0
- /package/esm/typings/src/scrapers/markdown/{markdownScraper.test.d.ts → MarkdownScraper.test.d.ts} +0 -0
- /package/esm/typings/src/{utils/files/$isFileExisting.test.d.ts → scrapers/website/utils/createShowdownConverter.test.d.ts} +0 -0
- /package/esm/typings/src/utils/files/{$listAllFiles.test.d.ts → isDirectoryExisting.test.d.ts} +0 -0
|
@@ -14,12 +14,14 @@ import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
|
|
|
14
14
|
import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
|
|
15
15
|
import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
|
|
16
16
|
import type { ErrorJson } from '../errors/utils/ErrorJson';
|
|
17
|
+
import type { LocateAppOptions } from '../executables/locateApp';
|
|
17
18
|
import type { AvailableModel } from '../execution/AvailableModel';
|
|
18
|
-
import type {
|
|
19
|
+
import type { CommonToolsOptions } from '../execution/CommonToolsOptions';
|
|
19
20
|
import type { CreatePipelineExecutorOptions } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorOptions';
|
|
20
|
-
import type { CreatePipelineExecutorSettings } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorSettings';
|
|
21
21
|
import type { EmbeddingVector } from '../execution/EmbeddingVector';
|
|
22
|
+
import type { Executables } from '../execution/Executables';
|
|
22
23
|
import type { ExecutionTools } from '../execution/ExecutionTools';
|
|
24
|
+
import type { FilesystemTools } from '../execution/FilesystemTools';
|
|
23
25
|
import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
|
|
24
26
|
import type { LlmExecutionToolsConstructor } from '../execution/LlmExecutionToolsConstructor';
|
|
25
27
|
import type { PipelineExecutor } from '../execution/PipelineExecutor';
|
|
@@ -37,9 +39,9 @@ import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
|
|
|
37
39
|
import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
|
|
38
40
|
import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
|
|
39
41
|
import type { CsvSettings } from '../formats/csv/CsvSettings';
|
|
40
|
-
import type { LlmToolsConfiguration } from '../llm-providers/_common/LlmToolsConfiguration';
|
|
41
|
-
import type { LlmToolsMetadata } from '../llm-providers/_common/LlmToolsMetadata';
|
|
42
|
-
import type { LlmToolsOptions } from '../llm-providers/_common/LlmToolsOptions';
|
|
42
|
+
import type { LlmToolsConfiguration } from '../llm-providers/_common/register/LlmToolsConfiguration';
|
|
43
|
+
import type { LlmToolsMetadata } from '../llm-providers/_common/register/LlmToolsMetadata';
|
|
44
|
+
import type { LlmToolsOptions } from '../llm-providers/_common/register/LlmToolsOptions';
|
|
43
45
|
import type { CacheItem } from '../llm-providers/_common/utils/cache/CacheItem';
|
|
44
46
|
import type { CacheLlmToolsOptions } from '../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
|
|
45
47
|
import type { LlmExecutionToolsWithTotalUsage } from '../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
|
|
@@ -48,7 +50,6 @@ import type { AnthropicClaudeExecutionToolsDirectOptions } from '../llm-provider
|
|
|
48
50
|
import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
|
|
49
51
|
import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions';
|
|
50
52
|
import type { LangtailExecutionToolsOptions } from '../llm-providers/langtail/LangtailExecutionToolsOptions';
|
|
51
|
-
import type { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
|
|
52
53
|
import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
|
|
53
54
|
import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
|
|
54
55
|
import type { PromptbookServer_Error } from '../llm-providers/remote/interfaces/PromptbookServer_Error';
|
|
@@ -65,8 +66,11 @@ import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/int
|
|
|
65
66
|
import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
66
67
|
import type { AnonymousRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
67
68
|
import type { CollectionRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
69
|
+
import type { CollectionRemoteServerClientOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
68
70
|
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
69
71
|
import type { Converter } from '../scrapers/_common/Converter';
|
|
72
|
+
import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
|
|
73
|
+
import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
|
|
70
74
|
import type { Scraper } from '../scrapers/_common/Scraper';
|
|
71
75
|
import type { ScraperSourceHandler } from '../scrapers/_common/Scraper';
|
|
72
76
|
import type { ScraperIntermediateSource } from '../scrapers/_common/ScraperIntermediateSource';
|
|
@@ -78,6 +82,7 @@ import type { ExecutionPromptReportJson } from '../types/execution-report/Execut
|
|
|
78
82
|
import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
|
|
79
83
|
import type { ExecutionReportString } from '../types/execution-report/ExecutionReportString';
|
|
80
84
|
import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
|
|
85
|
+
import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
|
|
81
86
|
import type { ModelRequirements } from '../types/ModelRequirements';
|
|
82
87
|
import type { CompletionModelRequirements } from '../types/ModelRequirements';
|
|
83
88
|
import type { ChatModelRequirements } from '../types/ModelRequirements';
|
|
@@ -156,15 +161,16 @@ import type { string_data_url } from '../types/typeAliases';
|
|
|
156
161
|
import type { string_base64 } from '../types/typeAliases';
|
|
157
162
|
import type { string_href } from '../types/typeAliases';
|
|
158
163
|
import type { string_url_image } from '../types/typeAliases';
|
|
164
|
+
import type { string_executable_path } from '../types/typeAliases';
|
|
159
165
|
import type { string_uri } from '../types/typeAliases';
|
|
160
166
|
import type { string_uri_part } from '../types/typeAliases';
|
|
161
|
-
import type { string_uriid } from '../types/typeAliases';
|
|
162
167
|
import type { string_hostname } from '../types/typeAliases';
|
|
163
168
|
import type { string_host } from '../types/typeAliases';
|
|
164
169
|
import type { string_protocol } from '../types/typeAliases';
|
|
165
170
|
import type { string_email } from '../types/typeAliases';
|
|
166
171
|
import type { string_emails } from '../types/typeAliases';
|
|
167
172
|
import type { string_uuid } from '../types/typeAliases';
|
|
173
|
+
import type { string_app_id } from '../types/typeAliases';
|
|
168
174
|
import type { string_user_id } from '../types/typeAliases';
|
|
169
175
|
import type { string_sha256 } from '../types/typeAliases';
|
|
170
176
|
import type { string_semantic_version } from '../types/typeAliases';
|
|
@@ -187,6 +193,7 @@ import type { string_translate_name_not_normalized } from '../types/typeAliases'
|
|
|
187
193
|
import type { string_translate_language } from '../types/typeAliases';
|
|
188
194
|
import type { string_javascript_name } from '../types/typeAliases';
|
|
189
195
|
import type { string_postprocessing_function_name } from '../types/typeAliases';
|
|
196
|
+
import type { id } from '../types/typeAliases';
|
|
190
197
|
import type { string_token } from '../types/typeAliases';
|
|
191
198
|
import type { string_license_token } from '../types/typeAliases';
|
|
192
199
|
import type { string_password } from '../types/typeAliases';
|
|
@@ -218,13 +225,14 @@ import type { number_megabytes } from '../types/typeAliases';
|
|
|
218
225
|
import type { number_gigabytes } from '../types/typeAliases';
|
|
219
226
|
import type { number_terabytes } from '../types/typeAliases';
|
|
220
227
|
import type { Registered } from '../utils/$Register';
|
|
221
|
-
import type {
|
|
222
|
-
import type {
|
|
228
|
+
import type { Registration } from '../utils/$Register';
|
|
229
|
+
import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
|
|
230
|
+
import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
|
|
223
231
|
import type { FromtoItems } from '../utils/FromtoItems';
|
|
224
232
|
import type { CodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
|
|
225
233
|
import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
|
|
226
234
|
import type { string_keyword } from '../utils/normalization/IKeywords';
|
|
227
|
-
import type {
|
|
235
|
+
import type { Keywords } from '../utils/normalization/IKeywords';
|
|
228
236
|
import type { string_kebab_case } from '../utils/normalization/normalize-to-kebab-case';
|
|
229
237
|
import type { string_camelCase } from '../utils/normalization/normalizeTo_camelCase';
|
|
230
238
|
import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
|
|
@@ -250,12 +258,14 @@ export type { PrettifyOptions };
|
|
|
250
258
|
export type { renderPipelineMermaidOptions };
|
|
251
259
|
export type { CallbackInterfaceToolsOptions };
|
|
252
260
|
export type { ErrorJson };
|
|
261
|
+
export type { LocateAppOptions };
|
|
253
262
|
export type { AvailableModel };
|
|
254
|
-
export type {
|
|
263
|
+
export type { CommonToolsOptions };
|
|
255
264
|
export type { CreatePipelineExecutorOptions };
|
|
256
|
-
export type { CreatePipelineExecutorSettings };
|
|
257
265
|
export type { EmbeddingVector };
|
|
266
|
+
export type { Executables };
|
|
258
267
|
export type { ExecutionTools };
|
|
268
|
+
export type { FilesystemTools };
|
|
259
269
|
export type { LlmExecutionTools };
|
|
260
270
|
export type { LlmExecutionToolsConstructor };
|
|
261
271
|
export type { PipelineExecutor };
|
|
@@ -284,7 +294,6 @@ export type { AnthropicClaudeExecutionToolsDirectOptions };
|
|
|
284
294
|
export type { AnthropicClaudeExecutionToolsProxiedOptions };
|
|
285
295
|
export type { AzureOpenAiExecutionToolsOptions };
|
|
286
296
|
export type { LangtailExecutionToolsOptions };
|
|
287
|
-
export type { MultipleLlmExecutionTools };
|
|
288
297
|
export type { OpenAiAssistantExecutionToolsOptions };
|
|
289
298
|
export type { OpenAiExecutionToolsOptions };
|
|
290
299
|
export type { PromptbookServer_Error };
|
|
@@ -301,8 +310,11 @@ export type { RemoteLlmExecutionToolsOptions };
|
|
|
301
310
|
export type { RemoteServerOptions };
|
|
302
311
|
export type { AnonymousRemoteServerOptions };
|
|
303
312
|
export type { CollectionRemoteServerOptions };
|
|
313
|
+
export type { CollectionRemoteServerClientOptions };
|
|
304
314
|
export type { PrepareAndScrapeOptions };
|
|
305
315
|
export type { Converter };
|
|
316
|
+
export type { ScraperAndConverterMetadata };
|
|
317
|
+
export type { ScraperConstructor };
|
|
306
318
|
export type { Scraper };
|
|
307
319
|
export type { ScraperSourceHandler };
|
|
308
320
|
export type { ScraperIntermediateSource };
|
|
@@ -314,6 +326,7 @@ export type { ExecutionPromptReportJson };
|
|
|
314
326
|
export type { ExecutionReportJson };
|
|
315
327
|
export type { ExecutionReportString };
|
|
316
328
|
export type { ExecutionReportStringOptions };
|
|
329
|
+
export type { IntermediateFilesStrategy };
|
|
317
330
|
export type { ModelRequirements };
|
|
318
331
|
export type { CompletionModelRequirements };
|
|
319
332
|
export type { ChatModelRequirements };
|
|
@@ -392,15 +405,16 @@ export type { string_data_url };
|
|
|
392
405
|
export type { string_base64 };
|
|
393
406
|
export type { string_href };
|
|
394
407
|
export type { string_url_image };
|
|
408
|
+
export type { string_executable_path };
|
|
395
409
|
export type { string_uri };
|
|
396
410
|
export type { string_uri_part };
|
|
397
|
-
export type { string_uriid };
|
|
398
411
|
export type { string_hostname };
|
|
399
412
|
export type { string_host };
|
|
400
413
|
export type { string_protocol };
|
|
401
414
|
export type { string_email };
|
|
402
415
|
export type { string_emails };
|
|
403
416
|
export type { string_uuid };
|
|
417
|
+
export type { string_app_id };
|
|
404
418
|
export type { string_user_id };
|
|
405
419
|
export type { string_sha256 };
|
|
406
420
|
export type { string_semantic_version };
|
|
@@ -423,6 +437,7 @@ export type { string_translate_name_not_normalized };
|
|
|
423
437
|
export type { string_translate_language };
|
|
424
438
|
export type { string_javascript_name };
|
|
425
439
|
export type { string_postprocessing_function_name };
|
|
440
|
+
export type { id };
|
|
426
441
|
export type { string_token };
|
|
427
442
|
export type { string_license_token };
|
|
428
443
|
export type { string_password };
|
|
@@ -454,13 +469,14 @@ export type { number_megabytes };
|
|
|
454
469
|
export type { number_gigabytes };
|
|
455
470
|
export type { number_terabytes };
|
|
456
471
|
export type { Registered };
|
|
457
|
-
export type {
|
|
458
|
-
export type {
|
|
472
|
+
export type { Registration };
|
|
473
|
+
export type { ExecCommandOptions };
|
|
474
|
+
export type { ExecCommandOptionsAdvanced };
|
|
459
475
|
export type { FromtoItems };
|
|
460
476
|
export type { CodeBlock };
|
|
461
477
|
export type { MarkdownSection };
|
|
462
478
|
export type { string_keyword };
|
|
463
|
-
export type {
|
|
479
|
+
export type { Keywords };
|
|
464
480
|
export type { string_kebab_case };
|
|
465
481
|
export type { string_camelCase };
|
|
466
482
|
export type { string_PascalCase };
|
|
@@ -24,7 +24,7 @@ import { capitalize } from '../utils/normalization/capitalize';
|
|
|
24
24
|
import { decapitalize } from '../utils/normalization/decapitalize';
|
|
25
25
|
import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
|
|
26
26
|
import type { string_keyword } from '../utils/normalization/IKeywords';
|
|
27
|
-
import type {
|
|
27
|
+
import type { Keywords } from '../utils/normalization/IKeywords';
|
|
28
28
|
import { isValidKeyword } from '../utils/normalization/isValidKeyword';
|
|
29
29
|
import { nameToUriPart } from '../utils/normalization/nameToUriPart';
|
|
30
30
|
import { nameToUriParts } from '../utils/normalization/nameToUriParts';
|
|
@@ -95,7 +95,7 @@ export { capitalize };
|
|
|
95
95
|
export { decapitalize };
|
|
96
96
|
export { DIACRITIC_VARIANTS_LETTERS };
|
|
97
97
|
export type { string_keyword };
|
|
98
|
-
export type {
|
|
98
|
+
export type { Keywords };
|
|
99
99
|
export { isValidKeyword };
|
|
100
100
|
export { nameToUriPart };
|
|
101
101
|
export { nameToUriParts };
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { PROMPTBOOK_VERSION } from '../version';
|
|
2
|
+
import { createWebsiteScraper } from '../scrapers/website/createWebsiteScraper';
|
|
3
|
+
import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
|
|
4
|
+
import { WebsiteScraper } from '../scrapers/website/WebsiteScraper';
|
|
5
|
+
export { PROMPTBOOK_VERSION };
|
|
6
|
+
export { createWebsiteScraper };
|
|
7
|
+
export { _WebsiteScraperRegistration };
|
|
8
|
+
export { WebsiteScraper };
|
|
@@ -19,11 +19,11 @@ export declare class SimplePipelineCollection implements PipelineCollection {
|
|
|
19
19
|
* Note: During the construction logic of all pipelines are validated
|
|
20
20
|
* Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
|
|
21
21
|
*/
|
|
22
|
-
constructor(...pipelines:
|
|
22
|
+
constructor(...pipelines: ReadonlyArray<PipelineJson>);
|
|
23
23
|
/**
|
|
24
24
|
* Gets all pipelines in the collection
|
|
25
25
|
*/
|
|
26
|
-
listPipelines():
|
|
26
|
+
listPipelines(): ReadonlyArray<string_pipeline_url>;
|
|
27
27
|
/**
|
|
28
28
|
* Gets pipeline by its URL
|
|
29
29
|
*
|
|
@@ -7,7 +7,7 @@ import type { PipelineCollection } from './PipelineCollection';
|
|
|
7
7
|
*
|
|
8
8
|
* @public exported from `@promptbook/core`
|
|
9
9
|
*/
|
|
10
|
-
export declare function collectionToJson(collection: PipelineCollection): Promise<
|
|
10
|
+
export declare function collectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<PipelineJson>>;
|
|
11
11
|
/**
|
|
12
12
|
* TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
|
|
13
13
|
*/
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { ExecutionTools } from '../../execution/ExecutionTools';
|
|
1
2
|
import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
|
|
2
3
|
import type { string_dirname } from '../../types/typeAliases';
|
|
3
4
|
import type { PipelineCollection } from '../PipelineCollection';
|
|
@@ -40,13 +41,14 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
|
|
|
40
41
|
* Note: Works only in Node.js environment because it reads the file system
|
|
41
42
|
*
|
|
42
43
|
* @param path - path to the directory with pipelines
|
|
43
|
-
* @param
|
|
44
|
+
* @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
|
|
45
|
+
* @param options - Options for the collection creation
|
|
44
46
|
* @returns PipelineCollection
|
|
45
47
|
* @public exported from `@promptbook/node`
|
|
46
48
|
*/
|
|
47
|
-
export declare function createCollectionFromDirectory(path: string_dirname, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
|
|
49
|
+
export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
|
|
48
50
|
export {};
|
|
49
51
|
/**
|
|
50
|
-
* Note: [🟢] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
|
|
51
52
|
* TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
|
|
53
|
+
* TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
|
|
52
54
|
*/
|
|
@@ -10,4 +10,4 @@ import type { PipelineCollection } from '../PipelineCollection';
|
|
|
10
10
|
* @returns PipelineCollection
|
|
11
11
|
* @public exported from `@promptbook/core`
|
|
12
12
|
*/
|
|
13
|
-
export declare function createCollectionFromJson(...promptbooks:
|
|
13
|
+
export declare function createCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;
|
|
@@ -20,4 +20,4 @@ import type { PipelineCollection } from '../PipelineCollection';
|
|
|
20
20
|
* @deprecated Do not use, it will became internal tool for other constructor functions
|
|
21
21
|
* @public exported from `@promptbook/core`
|
|
22
22
|
*/
|
|
23
|
-
export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<
|
|
23
|
+
export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;
|
|
@@ -40,11 +40,11 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
|
|
|
40
40
|
/**
|
|
41
41
|
* @@@
|
|
42
42
|
*/
|
|
43
|
-
readonly aliasNames?:
|
|
43
|
+
readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
|
|
44
44
|
/**
|
|
45
45
|
* @@@
|
|
46
46
|
*/
|
|
47
|
-
readonly deprecatedNames?:
|
|
47
|
+
readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
|
|
48
48
|
/**
|
|
49
49
|
* @@@
|
|
50
50
|
*/
|
|
@@ -56,7 +56,7 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
|
|
|
56
56
|
/**
|
|
57
57
|
* @@@
|
|
58
58
|
*/
|
|
59
|
-
readonly examples:
|
|
59
|
+
readonly examples: ReadonlyArray<string_markdown_text>;
|
|
60
60
|
/**
|
|
61
61
|
* @throws {ParseError} if the parsing fails
|
|
62
62
|
*/
|
|
@@ -95,7 +95,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
|
|
|
95
95
|
*
|
|
96
96
|
* Note: This is used in `pipelineJsonToString` utility
|
|
97
97
|
*/
|
|
98
|
-
takeFromPipelineJson(pipelineJson: PipelineJson):
|
|
98
|
+
takeFromPipelineJson(pipelineJson: PipelineJson): ReadonlyArray<TCommand>;
|
|
99
99
|
};
|
|
100
100
|
/**
|
|
101
101
|
* @@@
|
|
@@ -120,7 +120,7 @@ export type PipelineTemplateCommandParser<TCommand extends CommandBase> = Common
|
|
|
120
120
|
*
|
|
121
121
|
* Note: This is used in `pipelineJsonToString` utility
|
|
122
122
|
*/
|
|
123
|
-
takeFromTemplateJson($templateJson: $TemplateJson):
|
|
123
|
+
takeFromTemplateJson($templateJson: $TemplateJson): ReadonlyArray<TCommand>;
|
|
124
124
|
};
|
|
125
125
|
/**
|
|
126
126
|
* @@@
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { CsvSettings } from './formats/csv/CsvSettings';
|
|
2
|
+
import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
|
|
2
3
|
/**
|
|
3
4
|
* Warning message for the generated sections and files files
|
|
4
5
|
*
|
|
@@ -12,7 +13,7 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
|
|
|
12
13
|
*
|
|
13
14
|
* @public exported from `@promptbook/core`
|
|
14
15
|
*/
|
|
15
|
-
export declare const CLAIM = "
|
|
16
|
+
export declare const CLAIM = "Build responsible, controlled and transparent applications on top of LLM models!";
|
|
16
17
|
/**
|
|
17
18
|
* Warning message for the generated sections and files files
|
|
18
19
|
*
|
|
@@ -50,37 +51,43 @@ export declare const CONNECTION_RETRIES_LIMIT = 5;
|
|
|
50
51
|
*/
|
|
51
52
|
export declare const IMMEDIATE_TIME = 10;
|
|
52
53
|
/**
|
|
53
|
-
* The maximum
|
|
54
|
+
* The maximum length of the (generated) filename
|
|
54
55
|
*
|
|
55
56
|
* @public exported from `@promptbook/core`
|
|
56
57
|
*/
|
|
57
|
-
export declare const
|
|
58
|
+
export declare const MAX_FILENAME_LENGTH = 30;
|
|
58
59
|
/**
|
|
59
|
-
*
|
|
60
|
+
* Strategy for caching the intermediate results for knowledge sources
|
|
60
61
|
*
|
|
61
62
|
* @public exported from `@promptbook/core`
|
|
62
63
|
*/
|
|
63
|
-
export declare const
|
|
64
|
+
export declare const DEFAULT_INTERMEDIATE_FILES_STRATEGY: IntermediateFilesStrategy;
|
|
64
65
|
/**
|
|
65
|
-
* The maximum
|
|
66
|
+
* The maximum number of (LLM) tasks running in parallel
|
|
66
67
|
*
|
|
67
68
|
* @public exported from `@promptbook/core`
|
|
68
69
|
*/
|
|
69
|
-
export declare const
|
|
70
|
+
export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
|
|
71
|
+
/**
|
|
72
|
+
* The maximum number of attempts to execute LLM task before giving up
|
|
73
|
+
*
|
|
74
|
+
* @public exported from `@promptbook/core`
|
|
75
|
+
*/
|
|
76
|
+
export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 3;
|
|
70
77
|
/**
|
|
71
78
|
* @@@
|
|
72
79
|
* TODO: [🐝][main] !!! Use
|
|
73
80
|
*
|
|
74
81
|
* @public exported from `@promptbook/core`
|
|
75
82
|
*/
|
|
76
|
-
export declare const
|
|
83
|
+
export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
|
|
77
84
|
/**
|
|
78
85
|
* @@@
|
|
79
86
|
* TODO: [🐝][main] !!! Use
|
|
80
87
|
*
|
|
81
88
|
* @public exported from `@promptbook/core`
|
|
82
89
|
*/
|
|
83
|
-
export declare const
|
|
90
|
+
export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
|
|
84
91
|
/**
|
|
85
92
|
* Where to store the cache of executions for promptbook CLI
|
|
86
93
|
*
|
|
@@ -88,7 +95,7 @@ export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
|
|
|
88
95
|
*
|
|
89
96
|
* @public exported from `@promptbook/core`
|
|
90
97
|
*/
|
|
91
|
-
export declare const
|
|
98
|
+
export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
|
|
92
99
|
/**
|
|
93
100
|
* Where to store the scrape cache
|
|
94
101
|
*
|
|
@@ -96,13 +103,13 @@ export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
|
|
|
96
103
|
*
|
|
97
104
|
* @public exported from `@promptbook/core`
|
|
98
105
|
*/
|
|
99
|
-
export declare const
|
|
106
|
+
export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
|
|
100
107
|
/**
|
|
101
108
|
* The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
|
|
102
109
|
*
|
|
103
110
|
* @public exported from `@promptbook/core`
|
|
104
111
|
*/
|
|
105
|
-
export declare const
|
|
112
|
+
export declare const DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME = "index";
|
|
106
113
|
/**
|
|
107
114
|
* Nonce which is used for replacing things in strings
|
|
108
115
|
*
|
|
@@ -159,7 +166,13 @@ export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
|
|
|
159
166
|
*
|
|
160
167
|
* @public exported from `@promptbook/core`
|
|
161
168
|
*/
|
|
162
|
-
export declare const
|
|
169
|
+
export declare const DEFAULT_IS_VERBOSE = false;
|
|
170
|
+
/**
|
|
171
|
+
* @@@
|
|
172
|
+
*
|
|
173
|
+
* @public exported from `@promptbook/core`
|
|
174
|
+
*/
|
|
175
|
+
export declare const DEFAULT_IS_AUTO_INSTALLED = false;
|
|
163
176
|
/**
|
|
164
177
|
* @@@
|
|
165
178
|
*
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { ExecutionTools } from '../execution/ExecutionTools';
|
|
1
2
|
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
2
3
|
import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
|
|
3
4
|
import type { PipelineString } from '../types/PipelineString';
|
|
@@ -13,12 +14,13 @@ import type { PipelineString } from '../types/PipelineString';
|
|
|
13
14
|
* Note: This function acts as compilation process
|
|
14
15
|
*
|
|
15
16
|
* @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
|
|
17
|
+
* @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
|
|
16
18
|
* @param options - Options and tools for the compilation
|
|
17
19
|
* @returns {Promptbook} compiled in JSON format (.ptbk.json)
|
|
18
20
|
* @throws {ParseError} if the promptbook string is not valid
|
|
19
21
|
* @public exported from `@promptbook/core`
|
|
20
22
|
*/
|
|
21
|
-
export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
|
|
23
|
+
export declare function pipelineStringToJson(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
|
|
22
24
|
/**
|
|
23
25
|
* TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
|
|
24
26
|
* TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
|
-
import type {
|
|
2
|
+
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
|
|
3
3
|
import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
|
|
4
4
|
/**
|
|
5
5
|
* Options for `CallbackInterfaceTools`
|
|
6
6
|
*
|
|
7
7
|
* @public exported from `@promptbook/core`
|
|
8
8
|
*/
|
|
9
|
-
export type CallbackInterfaceToolsOptions =
|
|
9
|
+
export type CallbackInterfaceToolsOptions = CommonToolsOptions & {
|
|
10
10
|
/**
|
|
11
11
|
* The callback function to be called when promptDialog is called
|
|
12
12
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
|
|
2
2
|
import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
|
|
3
3
|
import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
|
|
4
4
|
/**
|
|
@@ -10,8 +10,8 @@ import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/User
|
|
|
10
10
|
* @public exported from `@promptbook/browser`
|
|
11
11
|
*/
|
|
12
12
|
export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
|
|
13
|
-
protected readonly options:
|
|
14
|
-
constructor(options?:
|
|
13
|
+
protected readonly options: CommonToolsOptions;
|
|
14
|
+
constructor(options?: CommonToolsOptions);
|
|
15
15
|
/**
|
|
16
16
|
* Trigger window.DIALOG TEMPLATE
|
|
17
17
|
*/
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { Executables } from '../execution/Executables';
|
|
2
|
+
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
3
|
+
/**
|
|
4
|
+
* @@@
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/node`
|
|
7
|
+
*/
|
|
8
|
+
export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOptions): Promise<Executables>;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
|
|
11
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
12
|
+
*/
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { string_executable_path } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* @@@
|
|
4
|
+
*
|
|
5
|
+
* @private within the repository
|
|
6
|
+
*/
|
|
7
|
+
export declare function locateLibreoffice(): Promise<string_executable_path | null>;
|
|
8
|
+
/**
|
|
9
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
|
|
10
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
11
|
+
*/
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { string_executable_path } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* @@@
|
|
4
|
+
*
|
|
5
|
+
* @private within the repository
|
|
6
|
+
*/
|
|
7
|
+
export declare function locatePandoc(): Promise<string_executable_path | null>;
|
|
8
|
+
/**
|
|
9
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
|
|
10
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
11
|
+
*/
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import type { RequireAtLeastOne } from 'type-fest';
|
|
2
|
+
import type { string_executable_path } from '../types/typeAliases';
|
|
3
|
+
/**
|
|
4
|
+
* Options for locating any application
|
|
5
|
+
*/
|
|
6
|
+
export interface LocateAppOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Name of the application
|
|
9
|
+
*/
|
|
10
|
+
appName: string;
|
|
11
|
+
/**
|
|
12
|
+
* Name of the executable on Linux
|
|
13
|
+
*/
|
|
14
|
+
linuxWhich?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Path suffix on Windows
|
|
17
|
+
*/
|
|
18
|
+
windowsSuffix?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Name of the application on macOS
|
|
21
|
+
*/
|
|
22
|
+
macOsName?: string;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Locates an application on the system
|
|
26
|
+
*
|
|
27
|
+
* @private within the repository
|
|
28
|
+
*/
|
|
29
|
+
export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path | null>;
|
|
30
|
+
/**
|
|
31
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node`
|
|
32
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
33
|
+
*/
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { string_executable_path } from '../../types/typeAliases';
|
|
2
|
+
import type { LocateAppOptions } from '../locateApp';
|
|
3
|
+
/**
|
|
4
|
+
* @@@
|
|
5
|
+
*
|
|
6
|
+
* @private within the repository
|
|
7
|
+
*/
|
|
8
|
+
export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path | null>;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node`
|
|
11
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
12
|
+
*/
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { string_executable_path } from '../../types/typeAliases';
|
|
2
|
+
import type { LocateAppOptions } from '../locateApp';
|
|
3
|
+
/**
|
|
4
|
+
* @@@
|
|
5
|
+
*
|
|
6
|
+
* @private within the repository
|
|
7
|
+
*/
|
|
8
|
+
export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path | null>;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node`
|
|
11
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
12
|
+
*/
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { string_executable_path } from '../../types/typeAliases';
|
|
2
|
+
import type { LocateAppOptions } from '../locateApp';
|
|
3
|
+
/**
|
|
4
|
+
* @@@
|
|
5
|
+
*
|
|
6
|
+
* @private within the repository
|
|
7
|
+
*/
|
|
8
|
+
export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null>;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node`
|
|
11
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
12
|
+
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Represents a vector in an latent space of the embedding model
|
|
3
3
|
*/
|
|
4
|
-
export type EmbeddingVector =
|
|
4
|
+
export type EmbeddingVector = ReadonlyArray<number>;
|
|
5
5
|
/**
|
|
6
6
|
* TODO: Figure out how to use NPM package xyzt
|
|
7
7
|
* Not using IVectorData due to HUGE dimensionality
|