@promptbook/openai 0.71.0-0 → 0.71.0-7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -0
- package/esm/index.es.js +25 -7
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/browser.index.d.ts +1 -1
- package/esm/typings/src/_packages/core.index.d.ts +28 -10
- package/esm/typings/src/_packages/node.index.d.ts +6 -2
- package/esm/typings/src/_packages/types.index.d.ts +28 -20
- package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
- package/esm/typings/src/cli/cli-commands/hello.d.ts +1 -1
- package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
- package/esm/typings/src/cli/cli-commands/prettify.d.ts +1 -1
- package/esm/typings/src/cli/main.d.ts +1 -1
- package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +8 -5
- package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
- package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +5 -1
- package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
- package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
- package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
- package/esm/typings/src/config.d.ts +10 -0
- package/esm/typings/src/conversion/pipelineStringToJson.d.ts +2 -15
- package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
- package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
- package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +2 -2
- package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +4 -4
- package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
- package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
- package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
- package/esm/typings/src/execution/ExecutionTools.d.ts +3 -3
- package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +5 -2
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +2 -13
- package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +3 -0
- package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +4 -1
- package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +3 -0
- package/esm/typings/src/execution/createPipelineExecutor/{30-executeFormatCells.d.ts → 30-executeFormatSubvalues.d.ts} +2 -6
- package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
- package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -0
- package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +2 -1
- package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
- package/esm/typings/src/llm-providers/_common/createLlmToolsFromConfigurationFromEnv.d.ts +1 -1
- package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts +1 -1
- package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +1 -1
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -1
- package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +8 -1
- package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
- package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
- package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -1
- package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
- package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
- package/esm/typings/src/personas/preparePersona.d.ts +2 -2
- package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +67 -0
- package/esm/typings/src/prepare/preparePipeline.d.ts +2 -2
- package/esm/typings/src/prepare/prepareTemplates.d.ts +2 -2
- package/esm/typings/src/scrapers/_common/Converter.d.ts +28 -0
- package/esm/typings/src/scrapers/_common/Scraper.d.ts +71 -0
- package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
- package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +4 -4
- package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +33 -0
- package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
- package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +10 -0
- package/esm/typings/src/scrapers/document/documentScraper.d.ts +37 -0
- package/esm/typings/src/scrapers/document/documentScraper.test.d.ts +4 -0
- package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/document-legacy/legacyDocumentScraper.d.ts +37 -0
- package/esm/typings/src/scrapers/document-legacy/legacyDocumentScraper.test.d.ts +4 -0
- package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/index.d.ts +7 -0
- package/esm/typings/src/scrapers/markdown/markdownScraper.d.ts +29 -0
- package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/pdf/pdfScraper.d.ts +35 -0
- package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +12 -0
- package/esm/typings/src/scrapers/website/websiteScraper.d.ts +43 -0
- package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +4 -4
- package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
- package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +1 -1
- package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
- package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
- package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
- package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +0 -3
- package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
- package/esm/typings/src/types/typeAliases.d.ts +9 -12
- package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
- package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
- package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts +23 -0
- package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
- package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
- package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
- package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +3 -3
- package/esm/typings/src/utils/files/$isFileExisting.d.ts +3 -3
- package/esm/typings/src/utils/files/$listAllFiles.d.ts +4 -4
- 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/validators/filePath/isValidFilePath.d.ts +2 -2
- package/package.json +2 -2
- package/umd/index.umd.js +25 -7
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
- package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
- package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
- package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
- package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
- package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
- /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
- /package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.test.d.ts +0 -0
- /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/markdownScraper.test.d.ts} +0 -0
- /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → scrapers/website/utils/markdownConverter.test.d.ts} +0 -0
- /package/esm/typings/src/{storage/files-storage/utils/nameToSubfolderPath.test.d.ts → scrapers/website/websiteScraper.test.d.ts} +0 -0
|
@@ -7,5 +7,5 @@ import type { Command as Program } from 'commander';
|
|
|
7
7
|
export declare function initializeAboutCommand(program: Program): void;
|
|
8
8
|
/**
|
|
9
9
|
* TODO: [🗽] Unite branding and make single place for it
|
|
10
|
-
* Note: [🟡]
|
|
10
|
+
* Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
|
|
11
11
|
*/
|
|
@@ -6,5 +6,5 @@ import type { Command as Program } from 'commander';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare function initializeHelloCommand(program: Program): void;
|
|
8
8
|
/**
|
|
9
|
-
* Note: [🟡]
|
|
9
|
+
* Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
|
|
10
10
|
*/
|
|
@@ -9,6 +9,6 @@ export declare function initializeMakeCommand(program: Program): void;
|
|
|
9
9
|
* TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
|
|
10
10
|
* TODO: Maybe remove this command - "about" command should be enough?
|
|
11
11
|
* TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
|
|
12
|
-
* Note: [🟡]
|
|
12
|
+
* Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
|
|
13
13
|
* TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
|
|
14
14
|
*/
|
|
@@ -6,6 +6,6 @@ import type { Command as Program } from 'commander';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare function initializePrettifyCommand(program: Program): void;
|
|
8
8
|
/**
|
|
9
|
-
* Note: [🟡]
|
|
9
|
+
* Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
|
|
10
10
|
* TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
|
|
11
11
|
*/
|
|
@@ -8,5 +8,5 @@ export declare function promptbookCli(): Promise<void>;
|
|
|
8
8
|
* TODO: [🥠] Do not export, its just for CLI script
|
|
9
9
|
* TODO: [🕌] When more functionalities, rename
|
|
10
10
|
* Note: 11:11
|
|
11
|
-
* Note: [🟡]
|
|
11
|
+
* Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
|
|
12
12
|
*/
|
|
@@ -1,10 +1,13 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
1
|
+
import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
|
|
2
|
+
import type { string_dirname } from '../../types/typeAliases';
|
|
3
3
|
import type { PipelineCollection } from '../PipelineCollection';
|
|
4
4
|
/**
|
|
5
5
|
* Options for `createCollectionFromDirectory` function
|
|
6
|
+
*
|
|
7
|
+
* Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
|
|
8
|
+
* This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
|
|
6
9
|
*/
|
|
7
|
-
type CreatePipelineCollectionFromDirectoryOptions =
|
|
10
|
+
type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
|
|
8
11
|
/**
|
|
9
12
|
* If true, the directory is searched recursively for pipelines
|
|
10
13
|
*
|
|
@@ -41,9 +44,9 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
|
|
|
41
44
|
* @returns PipelineCollection
|
|
42
45
|
* @public exported from `@promptbook/node`
|
|
43
46
|
*/
|
|
44
|
-
export declare function createCollectionFromDirectory(path:
|
|
47
|
+
export declare function createCollectionFromDirectory(path: string_dirname, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
|
|
45
48
|
export {};
|
|
46
49
|
/**
|
|
47
|
-
* Note: [🟢]
|
|
50
|
+
* Note: [🟢] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
|
|
48
51
|
* TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
|
|
49
52
|
*/
|
|
@@ -25,5 +25,5 @@ type CreatePipelineCollectionFromUrlyOptions = {
|
|
|
25
25
|
export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
|
|
26
26
|
export {};
|
|
27
27
|
/**
|
|
28
|
-
* TODO:[main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
|
|
28
|
+
* TODO: [main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
|
|
29
29
|
*/
|
|
@@ -3,7 +3,7 @@ import type { ExpectCommand } from './ExpectCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the expect command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const expectCommandParser: PipelineTemplateCommandParser<ExpectCommand>;
|
|
@@ -19,5 +19,9 @@ export type ForeachJson = {
|
|
|
19
19
|
/**
|
|
20
20
|
* @@@
|
|
21
21
|
*/
|
|
22
|
-
readonly
|
|
22
|
+
readonly inputSubparameterNames: Array<string_parameter_name>;
|
|
23
|
+
/**
|
|
24
|
+
* @@@
|
|
25
|
+
*/
|
|
26
|
+
readonly outputSubparameterName: string_parameter_name;
|
|
23
27
|
};
|
|
@@ -5,7 +5,7 @@ import type { ForeachCommand } from './ForeachCommand';
|
|
|
5
5
|
*
|
|
6
6
|
* Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
|
|
7
7
|
*
|
|
8
|
-
* @see
|
|
8
|
+
* @see `documentationUrl` for more details
|
|
9
9
|
* @private within the commands folder
|
|
10
10
|
*/
|
|
11
11
|
export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
|
|
@@ -3,7 +3,7 @@ import type { FormatCommand } from './FormatCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the format command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const formatCommandParser: PipelineTemplateCommandParser<FormatCommand>;
|
|
@@ -3,7 +3,7 @@ import type { JokerCommand } from './JokerCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the joker command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const jokerCommandParser: PipelineTemplateCommandParser<JokerCommand>;
|
|
@@ -3,7 +3,7 @@ import type { KnowledgeCommand } from './KnowledgeCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the knowledge command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { string_knowledge_source_content } from '../../../types/typeAliases';
|
|
2
|
+
import type { string_name } from '../../../types/typeAliases';
|
|
3
|
+
/**
|
|
4
|
+
* Creates unique name for the source
|
|
5
|
+
*
|
|
6
|
+
* @private within the repository
|
|
7
|
+
*/
|
|
8
|
+
export declare function sourceContentToName(sourceContent: string_knowledge_source_content): string_name;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: [🐱🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
|
|
11
|
+
*/
|
|
@@ -3,7 +3,7 @@ import type { ModelCommand } from './ModelCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the model command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;
|
|
@@ -3,7 +3,7 @@ import type { ParameterCommand } from './ParameterCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the parameter command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;
|
|
@@ -3,7 +3,7 @@ import type { PersonaCommand } from './PersonaCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the persona command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;
|
|
@@ -3,7 +3,7 @@ import type { PostprocessCommand } from './PostprocessCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the postprocess command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const postprocessCommandParser: PipelineTemplateCommandParser<PostprocessCommand>;
|
|
@@ -3,7 +3,7 @@ import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the PROMPTBOOK_VERSION command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const promptbookVersionCommandParser: PipelineHeadCommandParser<PromptbookVersionCommand>;
|
|
@@ -3,7 +3,7 @@ import type { TemplateCommand } from './TemplateCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the template command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const templateCommandParser: PipelineTemplateCommandParser<TemplateCommand>;
|
|
@@ -3,7 +3,7 @@ import type { UrlCommand } from './UrlCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the url command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const urlCommandParser: PipelineHeadCommandParser<UrlCommand>;
|
|
@@ -3,7 +3,7 @@ import type { ActionCommand } from './ActionCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the action command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;
|
|
@@ -3,7 +3,7 @@ import type { InstrumentCommand } from './InstrumentCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the instrument command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const instrumentCommandParser: PipelineHeadCommandParser<InstrumentCommand>;
|
|
@@ -5,7 +5,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
|
|
|
5
5
|
*
|
|
6
6
|
* Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.ptbk.md` file
|
|
7
7
|
*
|
|
8
|
-
* @see
|
|
8
|
+
* @see `documentationUrl` for more details
|
|
9
9
|
* @private within the commands folder
|
|
10
10
|
*/
|
|
11
11
|
export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;
|
|
@@ -84,9 +84,19 @@ export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
|
|
|
84
84
|
/**
|
|
85
85
|
* Where to store the cache of executions for promptbook CLI
|
|
86
86
|
*
|
|
87
|
+
* Note: When the folder does not exist, it is created recursively
|
|
88
|
+
*
|
|
87
89
|
* @public exported from `@promptbook/core`
|
|
88
90
|
*/
|
|
89
91
|
export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
|
|
92
|
+
/**
|
|
93
|
+
* Where to store the scrape cache
|
|
94
|
+
*
|
|
95
|
+
* Note: When the folder does not exist, it is created recursively
|
|
96
|
+
*
|
|
97
|
+
* @public exported from `@promptbook/core`
|
|
98
|
+
*/
|
|
99
|
+
export declare const SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
|
|
90
100
|
/**
|
|
91
101
|
* The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
|
|
92
102
|
*
|
|
@@ -1,19 +1,6 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
2
2
|
import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
|
|
3
3
|
import type { PipelineString } from '../types/PipelineString';
|
|
4
|
-
/**
|
|
5
|
-
* Options for `pipelineStringToJson`
|
|
6
|
-
*
|
|
7
|
-
* @public exported from `@promptbook/core`
|
|
8
|
-
*/
|
|
9
|
-
export type PipelineStringToJsonOptions = {
|
|
10
|
-
/**
|
|
11
|
-
* Tools for processing required for preparation of knowledge *(not for actual execution)*
|
|
12
|
-
*
|
|
13
|
-
* Note: If you provide `null`, the knowledge will not be prepared
|
|
14
|
-
*/
|
|
15
|
-
readonly llmTools: LlmExecutionTools | null;
|
|
16
|
-
};
|
|
17
4
|
/**
|
|
18
5
|
* Compile pipeline from string (markdown) format to JSON format
|
|
19
6
|
*
|
|
@@ -31,7 +18,7 @@ export type PipelineStringToJsonOptions = {
|
|
|
31
18
|
* @throws {ParseError} if the promptbook string is not valid
|
|
32
19
|
* @public exported from `@promptbook/core`
|
|
33
20
|
*/
|
|
34
|
-
export declare function pipelineStringToJson(pipelineString: PipelineString, options?:
|
|
21
|
+
export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
|
|
35
22
|
/**
|
|
36
23
|
* TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
|
|
37
24
|
* TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
|
|
@@ -18,7 +18,7 @@ import type { PipelineString } from '../types/PipelineString';
|
|
|
18
18
|
*/
|
|
19
19
|
export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
|
|
20
20
|
/**
|
|
21
|
-
* TODO:[main] !!!! Warn if used only sync version
|
|
21
|
+
* TODO: [main] !!!! Warn if used only sync version
|
|
22
22
|
* TODO: [🚞] Report here line/column of error
|
|
23
23
|
* TODO: Use spaceTrim more effectively
|
|
24
24
|
* TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
|
|
@@ -25,5 +25,5 @@ export declare function importPipelineJson(path: `${string}.ptbk.json`): Pipelin
|
|
|
25
25
|
*/
|
|
26
26
|
export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* Note: [⚫] Code in this file should never be published in any package
|
|
29
29
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { UserInterfaceTools } from '
|
|
2
|
-
import type { UserInterfaceToolsPromptDialogOptions } from '
|
|
1
|
+
import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
|
|
2
|
+
import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
|
|
3
3
|
import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
|
|
4
4
|
/**
|
|
5
5
|
* Delagates the user interaction to a async callback function
|
package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
|
-
import type { CommonExecutionToolsOptions } from '
|
|
3
|
-
import type { UserInterfaceToolsPromptDialogOptions } from '
|
|
2
|
+
import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
|
|
3
|
+
import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
|
|
4
4
|
/**
|
|
5
5
|
* Options for `CallbackInterfaceTools`
|
|
6
6
|
*
|
package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { CommonExecutionToolsOptions } from '
|
|
2
|
-
import type { UserInterfaceTools } from '
|
|
3
|
-
import type { UserInterfaceToolsPromptDialogOptions } from '
|
|
1
|
+
import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
|
|
2
|
+
import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
|
|
3
|
+
import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
|
|
4
4
|
/**
|
|
5
5
|
* Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
|
|
6
6
|
*
|
|
@@ -18,5 +18,5 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
|
|
|
18
18
|
promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
* Note: [🔵]
|
|
21
|
+
* Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
|
|
22
22
|
*/
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This error indicates problems parsing the format value
|
|
3
|
+
*
|
|
4
|
+
* For example, when the format value is not a valid JSON or CSV
|
|
5
|
+
* This is not thrown directly but in extended classes
|
|
6
|
+
*
|
|
7
|
+
* @public exported from `@promptbook/core`
|
|
8
|
+
*/
|
|
9
|
+
export declare class AbstractFormatError extends Error {
|
|
10
|
+
constructor(message: string);
|
|
11
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This error indicates that the promptbook can not retrieve knowledge from external sources
|
|
3
|
+
*
|
|
4
|
+
* @public exported from `@promptbook/core`
|
|
5
|
+
*/
|
|
6
|
+
export declare class KnowledgeScrapeError extends Error {
|
|
7
|
+
readonly name = "KnowledgeScrapeError";
|
|
8
|
+
constructor(message: string);
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This error type indicates that some tools are missing for pipeline execution or preparation
|
|
3
|
+
*
|
|
4
|
+
* @public exported from `@promptbook/core`
|
|
5
|
+
*/
|
|
6
|
+
export declare class MissingToolsError extends Error {
|
|
7
|
+
readonly name = "MissingToolsError";
|
|
8
|
+
constructor(message: string);
|
|
9
|
+
}
|
|
@@ -14,7 +14,7 @@ export type ExecutionTools = {
|
|
|
14
14
|
* Tip: Use `createLlmToolsFromEnv()` to use all available LLM providers you configured
|
|
15
15
|
* @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
|
|
16
16
|
*/
|
|
17
|
-
llm?: Arrayable<LlmExecutionTools>;
|
|
17
|
+
readonly llm?: Arrayable<LlmExecutionTools>;
|
|
18
18
|
/**
|
|
19
19
|
* Tools for executing scripts
|
|
20
20
|
*
|
|
@@ -25,12 +25,12 @@ export type ExecutionTools = {
|
|
|
25
25
|
* @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
|
|
26
26
|
* @default [] - If not provided, no script execution will be possible
|
|
27
27
|
*/
|
|
28
|
-
script?: Arrayable<ScriptExecutionTools>;
|
|
28
|
+
readonly script?: Arrayable<ScriptExecutionTools>;
|
|
29
29
|
/**
|
|
30
30
|
* Tools for interacting with the user
|
|
31
31
|
*
|
|
32
32
|
* Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
|
|
33
33
|
* @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
|
|
34
34
|
*/
|
|
35
|
-
userInterface?: UserInterfaceTools;
|
|
35
|
+
readonly userInterface?: UserInterfaceTools;
|
|
36
36
|
};
|
|
@@ -14,5 +14,6 @@ export type PipelineExecutor = {
|
|
|
14
14
|
(inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
|
+
* TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
|
|
17
18
|
* TODO: [🧠] Should this file be in /execution or /types folder?
|
|
18
19
|
*/
|
package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutor
|
|
|
4
4
|
/**
|
|
5
5
|
* Options for `createPipelineExecutor`
|
|
6
6
|
*/
|
|
7
|
-
export
|
|
7
|
+
export type CreatePipelineExecutorOptions = {
|
|
8
8
|
/**
|
|
9
9
|
* The pipeline to be executed
|
|
10
10
|
*/
|
|
@@ -17,4 +17,7 @@ export interface CreatePipelineExecutorOptions {
|
|
|
17
17
|
* Optional settings for the pipeline executor
|
|
18
18
|
*/
|
|
19
19
|
readonly settings?: Partial<CreatePipelineExecutorSettings>;
|
|
20
|
-
}
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* TODO: !!!!!! Unite `CreatePipelineExecutorOptions` and `CreatePipelineExecutorSettings` OR describe the difference
|
|
23
|
+
*/
|
package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts
CHANGED
|
@@ -1,23 +1,12 @@
|
|
|
1
1
|
import type { CsvSettings } from '../../formats/csv/CsvSettings';
|
|
2
|
-
|
|
2
|
+
import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
|
|
3
|
+
export type CreatePipelineExecutorSettings = Omit<PrepareAndScrapeOptions, 'llmTools'> & {
|
|
3
4
|
/**
|
|
4
5
|
* When executor does not satisfy expectations it will be retried this amount of times
|
|
5
6
|
*
|
|
6
7
|
* @default MAX_EXECUTION_ATTEMPTS
|
|
7
8
|
*/
|
|
8
9
|
readonly maxExecutionAttempts: number;
|
|
9
|
-
/**
|
|
10
|
-
* Maximum number of tasks running in parallel
|
|
11
|
-
*
|
|
12
|
-
* @default MAX_PARALLEL_COUNT
|
|
13
|
-
*/
|
|
14
|
-
readonly maxParallelCount: number;
|
|
15
|
-
/**
|
|
16
|
-
* If true, the preparation logs additional information
|
|
17
|
-
*
|
|
18
|
-
* @default false
|
|
19
|
-
*/
|
|
20
|
-
readonly isVerbose: boolean;
|
|
21
10
|
/**
|
|
22
11
|
* Settings for CSV format
|
|
23
12
|
*
|
|
@@ -8,3 +8,6 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
|
|
|
8
8
|
* @public exported from `@promptbook/core`
|
|
9
9
|
*/
|
|
10
10
|
export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
|
|
11
|
+
/**
|
|
12
|
+
* TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
|
|
13
|
+
*/
|
|
@@ -22,7 +22,7 @@ type ExecutePipelineOptions = {
|
|
|
22
22
|
/**
|
|
23
23
|
* @@@
|
|
24
24
|
*/
|
|
25
|
-
|
|
25
|
+
onProgress?(taskProgress: TaskProgress): Promisable<void>;
|
|
26
26
|
/**
|
|
27
27
|
* @@@
|
|
28
28
|
*/
|
|
@@ -53,3 +53,6 @@ type ExecutePipelineOptions = {
|
|
|
53
53
|
*/
|
|
54
54
|
export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
|
|
55
55
|
export {};
|
|
56
|
+
/**
|
|
57
|
+
* TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
|
|
58
|
+
*/
|
|
@@ -3,7 +3,7 @@ import type { ExecuteAttemptsOptions } from './40-executeAttempts';
|
|
|
3
3
|
/**
|
|
4
4
|
* @@@
|
|
5
5
|
*
|
|
6
|
-
* @private internal type of `
|
|
6
|
+
* @private internal type of `executeFormatSubvalues`
|
|
7
7
|
*/
|
|
8
8
|
type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
|
|
9
9
|
/**
|
|
@@ -11,9 +11,5 @@ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
|
|
|
11
11
|
*
|
|
12
12
|
* @private internal utility of `createPipelineExecutor`
|
|
13
13
|
*/
|
|
14
|
-
export declare function
|
|
14
|
+
export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
|
|
15
15
|
export {};
|
|
16
|
-
/**
|
|
17
|
-
* TODO: !!!!!! Make pipelineIdentification more precise
|
|
18
|
-
* TODO: !!!!!! How FOREACH execution looks in the report
|
|
19
|
-
*/
|
|
@@ -4,4 +4,4 @@ import type { EmbeddingVector } from './EmbeddingVector';
|
|
|
4
4
|
*
|
|
5
5
|
* @public exported from `@promptbook/core`
|
|
6
6
|
*/
|
|
7
|
-
export declare function embeddingVectorToString(embeddingVector: EmbeddingVector): string;
|
|
7
|
+
export declare function embeddingVectorToString(embeddingVector: Readonly<EmbeddingVector>): string;
|
|
@@ -14,6 +14,7 @@ type ForEachAsyncOptions = {
|
|
|
14
14
|
* @param options - Options for the function
|
|
15
15
|
* @param callbackfunction - Function to call for each item
|
|
16
16
|
* @public exported from `@promptbook/utils`
|
|
17
|
+
* @deprecated [🪂] Use queues instead
|
|
17
18
|
*/
|
|
18
19
|
export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
|
|
19
20
|
export {};
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
2
|
import type { Parameters } from '../../types/typeAliases';
|
|
3
|
+
import type { string_parameter_name } from '../../types/typeAliases';
|
|
3
4
|
import type { string_name } from '../../types/typeAliases';
|
|
4
5
|
import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
|
|
5
6
|
import type { empty_object } from '../../utils/organization/empty_object';
|
|
@@ -23,7 +24,7 @@ export type FormatSubvalueDefinition<TValue extends string, TSettings extends em
|
|
|
23
24
|
* For example, if you have a JSON object and you want to map all values to uppercase
|
|
24
25
|
* Or iterate over all CSV cells @@@
|
|
25
26
|
*/
|
|
26
|
-
mapValues(value: TValue, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
|
|
27
|
+
mapValues(value: TValue, outputParameterName: string_parameter_name, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
|
|
27
28
|
};
|
|
28
29
|
/**
|
|
29
30
|
* Note: [👩🏾🤝🧑🏽]
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { AbstractFormatError } from "../../errors/AbstractFormatError";
|
|
2
|
+
/**
|
|
3
|
+
* This error indicates problem with parsing of CSV
|
|
4
|
+
*
|
|
5
|
+
* @public exported from `@promptbook/core`
|
|
6
|
+
*/
|
|
7
|
+
export declare class CsvFormatError extends AbstractFormatError {
|
|
8
|
+
readonly name = "CsvFormatError";
|
|
9
|
+
constructor(message: string);
|
|
10
|
+
}
|
|
@@ -17,7 +17,7 @@ export declare function createLlmToolsFromConfigurationFromEnv(): LlmToolsConfig
|
|
|
17
17
|
* TODO: Add Azure OpenAI
|
|
18
18
|
* TODO: [🧠][🍛]
|
|
19
19
|
* TODO: [🧠] Is there some meaningfull way how to test this util
|
|
20
|
-
* Note: [🟢]
|
|
20
|
+
* Note: [🟢] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
|
|
21
21
|
* TODO: [👷♂️] @@@ Manual about construction of llmTools
|
|
22
22
|
* TODO: This should be maybe not under `_common` but under `utils`
|
|
23
23
|
* TODO: [🧠] Maybe pass env as argument
|
|
@@ -19,7 +19,7 @@ export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromConfig
|
|
|
19
19
|
* TODO: @@@ write `createLlmToolsFromEnv` vs `createLlmToolsFromConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
|
|
20
20
|
* TODO: [🧠][🍛] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
|
|
21
21
|
* TODO: [🧠] Is there some meaningfull way how to test this util
|
|
22
|
-
* Note: [🟢]
|
|
22
|
+
* Note: [🟢] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
|
|
23
23
|
* TODO: [🥃] Allow `ptbk make` without llm tools
|
|
24
24
|
* TODO: This should be maybe not under `_common` but under `utils`
|
|
25
25
|
*/
|
|
@@ -15,7 +15,7 @@ type GetLlmToolsForCliOptions = {
|
|
|
15
15
|
export declare function getLlmToolsForCli(options?: GetLlmToolsForCliOptions): LlmExecutionToolsWithTotalUsage;
|
|
16
16
|
export {};
|
|
17
17
|
/**
|
|
18
|
-
* Note: [🟡]
|
|
18
|
+
* Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
|
|
19
19
|
* TODO: [👷♂️] @@@ Manual about construction of llmTools
|
|
20
20
|
* TODO: [🥃] Allow `ptbk make` without llm tools
|
|
21
21
|
* TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
|