@promptbook/legacy-documents 0.71.0-18 → 0.71.0-20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/README.md +0 -6
  2. package/esm/index.es.js +80 -86
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/core.index.d.ts +22 -18
  5. package/esm/typings/src/_packages/types.index.d.ts +2 -2
  6. package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
  7. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +2 -2
  8. package/esm/typings/src/collection/collectionToJson.d.ts +1 -1
  9. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +1 -1
  10. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +1 -1
  11. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +5 -5
  12. package/esm/typings/src/config.d.ts +21 -14
  13. package/esm/typings/src/execution/EmbeddingVector.d.ts +1 -1
  14. package/esm/typings/src/execution/LlmExecutionTools.d.ts +1 -1
  15. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
  16. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +1 -0
  17. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +29 -6
  18. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +2 -11
  19. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +4 -13
  20. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +9 -14
  21. package/esm/typings/src/execution/utils/addUsage.d.ts +1 -1
  22. package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -1
  23. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
  24. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +2 -2
  25. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +2 -2
  26. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +1 -1
  27. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +4 -1
  28. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
  29. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  30. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -1
  31. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
  32. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +1 -1
  33. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +1 -1
  34. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +3 -3
  35. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +1 -1
  36. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +1 -1
  37. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  38. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +1 -1
  39. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +1 -1
  40. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +4 -4
  41. package/esm/typings/src/prepare/prepareTemplates.d.ts +1 -1
  42. package/esm/typings/src/scrapers/_common/Scraper.d.ts +1 -5
  43. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +1 -1
  44. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +1 -1
  45. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +1 -1
  46. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +2 -2
  47. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +2 -2
  48. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +1 -1
  49. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +1 -1
  50. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -1
  51. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -1
  52. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -1
  53. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -1
  54. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -1
  55. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +1 -1
  56. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -1
  57. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -1
  58. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +1 -1
  59. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -1
  60. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -1
  61. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +1 -1
  62. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -1
  63. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -1
  64. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -1
  65. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +1 -1
  66. package/esm/typings/src/types/Arrayable.d.ts +1 -1
  67. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  68. package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +4 -4
  69. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +1 -1
  70. package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
  71. package/esm/typings/src/types/Prompt.d.ts +1 -1
  72. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -1
  73. package/esm/typings/src/utils/$Register.d.ts +1 -1
  74. package/esm/typings/src/utils/FromtoItems.d.ts +1 -1
  75. package/esm/typings/src/utils/arrayableToArray.d.ts +1 -1
  76. package/esm/typings/src/utils/emojis.d.ts +1 -1
  77. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
  78. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
  79. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
  80. package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -1
  81. package/esm/typings/src/utils/organization/keepUnused.d.ts +1 -1
  82. package/esm/typings/src/utils/random/$randomSeed.d.ts +1 -1
  83. package/esm/typings/src/utils/sets/intersection.d.ts +1 -1
  84. package/esm/typings/src/utils/sets/union.d.ts +1 -1
  85. package/package.json +2 -2
  86. package/umd/index.umd.js +80 -86
  87. package/umd/index.umd.js.map +1 -1
  88. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +0 -29
@@ -7,20 +7,21 @@ import { createSubcollection } from '../collection/constructors/createSubcollect
7
7
  import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
8
8
  import { TemplateTypes } from '../commands/TEMPLATE/TemplateTypes';
9
9
  import { CLAIM } from '../config';
10
- import { MAX_PARALLEL_COUNT } from '../config';
11
- import { MAX_EXECUTION_ATTEMPTS } from '../config';
12
10
  import { MAX_FILENAME_LENGTH } from '../config';
13
- import { MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
14
- import { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
15
- import { EXECUTIONS_CACHE_DIRNAME } from '../config';
16
- import { SCRAPE_CACHE_DIRNAME } from '../config';
17
- import { PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
11
+ import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
12
+ import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
13
+ import { DEFAULT_MAX_EXECUTION_ATTEMPTS } from '../config';
14
+ import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
15
+ import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
16
+ import { DEFAULT_EXECUTIONS_CACHE_DIRNAME } from '../config';
17
+ import { DEFAULT_SCRAPE_CACHE_DIRNAME } from '../config';
18
+ import { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
18
19
  import { RESERVED_PARAMETER_NAMES } from '../config';
19
20
  import { DEFAULT_REMOTE_URL } from '../config';
20
21
  import { DEFAULT_REMOTE_URL_PATH } from '../config';
21
22
  import { DEFAULT_CSV_SETTINGS } from '../config';
22
- import { IS_VERBOSE } from '../config';
23
- import { IS_AUTO_INSTALLED } from '../config';
23
+ import { DEFAULT_IS_VERBOSE } from '../config';
24
+ import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
24
25
  import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
25
26
  import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
26
27
  import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
@@ -75,6 +76,7 @@ import { unpreparePipeline } from '../prepare/unpreparePipeline';
75
76
  import { prepareKnowledgePieces } from '../scrapers/_common/prepareKnowledgePieces';
76
77
  import { $scrapersMetadataRegister } from '../scrapers/_common/register/$scrapersMetadataRegister';
77
78
  import { $scrapersRegister } from '../scrapers/_common/register/$scrapersRegister';
79
+ import { makeKnowledgeSourceHandler } from '../scrapers/_common/utils/makeKnowledgeSourceHandler';
78
80
  import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
79
81
  import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
80
82
  import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
@@ -96,20 +98,21 @@ export { createSubcollection };
96
98
  export type { TemplateType };
97
99
  export { TemplateTypes };
98
100
  export { CLAIM };
99
- export { MAX_PARALLEL_COUNT };
100
- export { MAX_EXECUTION_ATTEMPTS };
101
101
  export { MAX_FILENAME_LENGTH };
102
- export { MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
103
- export { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
104
- export { EXECUTIONS_CACHE_DIRNAME };
105
- export { SCRAPE_CACHE_DIRNAME };
106
- export { PIPELINE_COLLECTION_BASE_FILENAME };
102
+ export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
103
+ export { DEFAULT_MAX_PARALLEL_COUNT };
104
+ export { DEFAULT_MAX_EXECUTION_ATTEMPTS };
105
+ export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
106
+ export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
107
+ export { DEFAULT_EXECUTIONS_CACHE_DIRNAME };
108
+ export { DEFAULT_SCRAPE_CACHE_DIRNAME };
109
+ export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
107
110
  export { RESERVED_PARAMETER_NAMES };
108
111
  export { DEFAULT_REMOTE_URL };
109
112
  export { DEFAULT_REMOTE_URL_PATH };
110
113
  export { DEFAULT_CSV_SETTINGS };
111
- export { IS_VERBOSE };
112
- export { IS_AUTO_INSTALLED };
114
+ export { DEFAULT_IS_VERBOSE };
115
+ export { DEFAULT_IS_AUTO_INSTALLED };
113
116
  export { pipelineJsonToString };
114
117
  export { pipelineStringToJson };
115
118
  export { pipelineStringToJsonSync };
@@ -164,6 +167,7 @@ export { unpreparePipeline };
164
167
  export { prepareKnowledgePieces };
165
168
  export { $scrapersMetadataRegister };
166
169
  export { $scrapersRegister };
170
+ export { makeKnowledgeSourceHandler };
167
171
  export { _LegacyDocumentScraperMetadataRegistration };
168
172
  export { _DocumentScraperMetadataRegistration };
169
173
  export { _MarkdownScraperMetadataRegistration };
@@ -17,7 +17,6 @@ import type { ErrorJson } from '../errors/utils/ErrorJson';
17
17
  import type { AvailableModel } from '../execution/AvailableModel';
18
18
  import type { CommonToolsOptions } from '../execution/CommonToolsOptions';
19
19
  import type { CreatePipelineExecutorOptions } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorOptions';
20
- import type { CreatePipelineExecutorSettings } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorSettings';
21
20
  import type { EmbeddingVector } from '../execution/EmbeddingVector';
22
21
  import type { Executables } from '../execution/Executables';
23
22
  import type { ExecutionTools } from '../execution/ExecutionTools';
@@ -80,6 +79,7 @@ import type { ExecutionPromptReportJson } from '../types/execution-report/Execut
80
79
  import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
81
80
  import type { ExecutionReportString } from '../types/execution-report/ExecutionReportString';
82
81
  import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
82
+ import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
83
83
  import type { ModelRequirements } from '../types/ModelRequirements';
84
84
  import type { CompletionModelRequirements } from '../types/ModelRequirements';
85
85
  import type { ChatModelRequirements } from '../types/ModelRequirements';
@@ -257,7 +257,6 @@ export type { ErrorJson };
257
257
  export type { AvailableModel };
258
258
  export type { CommonToolsOptions };
259
259
  export type { CreatePipelineExecutorOptions };
260
- export type { CreatePipelineExecutorSettings };
261
260
  export type { EmbeddingVector };
262
261
  export type { Executables };
263
262
  export type { ExecutionTools };
@@ -320,6 +319,7 @@ export type { ExecutionPromptReportJson };
320
319
  export type { ExecutionReportJson };
321
320
  export type { ExecutionReportString };
322
321
  export type { ExecutionReportStringOptions };
322
+ export type { IntermediateFilesStrategy };
323
323
  export type { ModelRequirements };
324
324
  export type { CompletionModelRequirements };
325
325
  export type { ChatModelRequirements };
@@ -11,7 +11,7 @@ export type PipelineCollection = {
11
11
  /**
12
12
  * Gets all pipelines in the collection
13
13
  */
14
- listPipelines(): Promisable<Array<string_pipeline_url>>;
14
+ listPipelines(): Promisable<ReadonlyArray<string_pipeline_url>>;
15
15
  /**
16
16
  * Gets pipeline by its URL
17
17
  *
@@ -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: Array<PipelineJson>);
22
+ constructor(...pipelines: ReadonlyArray<PipelineJson>);
23
23
  /**
24
24
  * Gets all pipelines in the collection
25
25
  */
26
- listPipelines(): Array<string_pipeline_url>;
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<Array<PipelineJson>>;
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
  */
@@ -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: Array<PipelineJson>): PipelineCollection;
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<Array<PipelineJson>> | (() => Promise<Array<PipelineJson>>)): PipelineCollection;
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?: Array<string_name & string_SCREAMING_CASE>;
43
+ readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
44
44
  /**
45
45
  * @@@
46
46
  */
47
- readonly deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
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: Array<string_markdown_text>;
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): Array<TCommand>;
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): Array<TCommand>;
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 = "Supercharge LLM models with Promptbook";
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 number of (LLM) tasks running in parallel
54
+ * The maximum length of the (generated) filename
54
55
  *
55
56
  * @public exported from `@promptbook/core`
56
57
  */
57
- export declare const MAX_PARALLEL_COUNT = 5;
58
+ export declare const MAX_FILENAME_LENGTH = 30;
58
59
  /**
59
- * The maximum number of attempts to execute LLM task before giving up
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 MAX_EXECUTION_ATTEMPTS = 3;
64
+ export declare const DEFAULT_INTERMEDIATE_FILES_STRATEGY: IntermediateFilesStrategy;
64
65
  /**
65
- * The maximum length of the (generated) filename
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 MAX_FILENAME_LENGTH = 30;
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 MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
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 MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
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 EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
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 SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
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 PIPELINE_COLLECTION_BASE_FILENAME = "index";
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,13 +166,13 @@ export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
159
166
  *
160
167
  * @public exported from `@promptbook/core`
161
168
  */
162
- export declare const IS_VERBOSE = false;
169
+ export declare const DEFAULT_IS_VERBOSE = false;
163
170
  /**
164
171
  * @@@
165
172
  *
166
173
  * @public exported from `@promptbook/core`
167
174
  */
168
- export declare const IS_AUTO_INSTALLED = false;
175
+ export declare const DEFAULT_IS_AUTO_INSTALLED = false;
169
176
  /**
170
177
  * @@@
171
178
  *
@@ -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 = Array<number>;
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
@@ -37,7 +37,7 @@ export type LlmExecutionTools = {
37
37
  /**
38
38
  * List all available models that can be used
39
39
  */
40
- listModels(): Promisable<Array<AvailableModel>>;
40
+ listModels(): Promisable<ReadonlyArray<AvailableModel>>;
41
41
  /**
42
42
  * Calls a chat model
43
43
  */
@@ -27,11 +27,11 @@ export type PipelineExecutorResult = {
27
27
  /**
28
28
  * Errors that occured during the execution, details are aviable in `executionReport`
29
29
  */
30
- readonly errors: ReadonlyDeep<Array<ErrorJson>>;
30
+ readonly errors: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
31
31
  /**
32
32
  * Warnings that occured during the execution, details are aviable in `executionReport`
33
33
  */
34
- readonly warnings: ReadonlyDeep<Array<ErrorJson>>;
34
+ readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
35
35
  /**
36
36
  * The report of the execution with all details
37
37
  */
@@ -8,5 +8,6 @@ import type { PipelineExecutor } from './PipelineExecutor';
8
8
  */
9
9
  export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PipelineExecutor>>, 'isSuccessful' | 'errors'>): void;
10
10
  /**
11
+ * TODO: [🐚] This function should be removed OR changed OR be completely rewritten
11
12
  * TODO: [🧠] Can this return type be better typed than void
12
13
  */
@@ -1,10 +1,11 @@
1
+ import type { CsvSettings } from '../../formats/csv/CsvSettings';
2
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
1
3
  import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
2
4
  import type { ExecutionTools } from '../ExecutionTools';
3
- import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
4
5
  /**
5
6
  * Options for `createPipelineExecutor`
6
7
  */
7
- export type CreatePipelineExecutorOptions = {
8
+ export type CreatePipelineExecutorOptions = PrepareAndScrapeOptions & {
8
9
  /**
9
10
  * The pipeline to be executed
10
11
  */
@@ -14,10 +15,32 @@ export type CreatePipelineExecutorOptions = {
14
15
  */
15
16
  readonly tools: ExecutionTools;
16
17
  /**
17
- * Optional settings for the pipeline executor
18
+ * When executor does not satisfy expectations it will be retried this amount of times
19
+ *
20
+ * @default MAX_EXECUTION_ATTEMPTS
18
21
  */
19
- readonly settings?: Partial<CreatePipelineExecutorSettings>;
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 isNotPreparedWarningSupressed?: boolean;
20
39
  };
21
40
  /**
22
- * TODO: !!!!!! Unite `CreatePipelineExecutorOptions` and `CreatePipelineExecutorSettings` OR describe the difference
23
- */
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
+ */
@@ -2,23 +2,18 @@ import type { Promisable, ReadonlyDeep } from 'type-fest';
2
2
  import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
3
3
  import type { TaskProgress } from '../../types/TaskProgress';
4
4
  import type { Parameters } from '../../types/typeAliases';
5
- import type { ExecutionTools } from '../ExecutionTools';
6
5
  import type { PipelineExecutorResult } from '../PipelineExecutorResult';
7
- import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
6
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
8
7
  /**
9
8
  * @@@
10
9
  *
11
10
  * @private internal type of `executePipeline`
12
11
  */
13
- type ExecutePipelineOptions = {
12
+ type ExecutePipelineOptions = CreatePipelineExecutorOptions & {
14
13
  /**
15
14
  * @@@
16
15
  */
17
16
  readonly inputParameters: Readonly<Parameters>;
18
- /**
19
- * @@@
20
- */
21
- readonly tools: ExecutionTools;
22
17
  /**
23
18
  * @@@
24
19
  */
@@ -39,10 +34,6 @@ type ExecutePipelineOptions = {
39
34
  * @@@
40
35
  */
41
36
  readonly pipelineIdentification: string;
42
- /**
43
- * Settings for the pipeline executor
44
- */
45
- readonly settings: CreatePipelineExecutorSettings;
46
37
  };
47
38
  /**
48
39
  * @@@
@@ -1,17 +1,16 @@
1
- import { Promisable, ReadonlyDeep } from 'type-fest';
1
+ import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
2
2
  import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
3
3
  import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
4
4
  import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
5
5
  import type { TaskProgress } from '../../types/TaskProgress';
6
6
  import type { Parameters } from '../../types/typeAliases';
7
- import type { ExecutionTools } from '../ExecutionTools';
8
- import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
7
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
9
8
  /**
10
9
  * @@@
11
10
  *
12
11
  * @private internal type of `executeTemplate`
13
12
  */
14
- type executeSingleTemplateOptions = {
13
+ type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
15
14
  /**
16
15
  * @@@
17
16
  */
@@ -24,22 +23,14 @@ type executeSingleTemplateOptions = {
24
23
  * @@@
25
24
  */
26
25
  readonly parametersToPass: Readonly<Parameters>;
27
- /**
28
- * @@@
29
- */
30
- readonly tools: ExecutionTools;
31
26
  /**
32
27
  * @@@
33
28
  */
34
29
  readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
35
- /**
36
- * Settings for the pipeline executor
37
- */
38
- readonly settings: CreatePipelineExecutorSettings;
39
30
  /**
40
31
  * @@@
41
32
  */
42
- readonly $executionReport: ExecutionReportJson;
33
+ readonly $executionReport: WritableDeep<ExecutionReportJson>;
43
34
  /**
44
35
  * @@@
45
36
  */
@@ -1,28 +1,31 @@
1
- import type { ReadonlyDeep } from 'type-fest';
1
+ import type { ReadonlyDeep, WritableDeep } from 'type-fest';
2
2
  import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
3
3
  import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
4
4
  import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
5
5
  import type { Parameters } from '../../types/typeAliases';
6
6
  import type { string_parameter_name } from '../../types/typeAliases';
7
7
  import type { TODO_string } from '../../utils/organization/TODO_string';
8
- import type { ExecutionTools } from '../ExecutionTools';
9
- import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
8
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
10
9
  /**
11
10
  * @@@
12
11
  *
13
12
  * @private internal type of `executeAttempts`
14
13
  */
15
- export type ExecuteAttemptsOptions = {
14
+ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeline'> & {
16
15
  /**
17
16
  * @@@
18
17
  */
19
- readonly jokerParameterNames: Readonly<Array<string_parameter_name>>;
18
+ readonly jokerParameterNames: Readonly<ReadonlyArray<string_parameter_name>>;
20
19
  /**
21
20
  * @@@
22
21
  */
23
22
  readonly priority: number;
24
23
  /**
25
24
  * @@@
25
+ *
26
+ * Note: [💂] There are two distinct variabiles
27
+ * 1) `maxExecutionAttempts` - the amount of attempts LLM model
28
+ * 2) `maxAttempts` - the amount of attempts for any template - LLM, SCRIPT, DIALOG, etc.
26
29
  */
27
30
  readonly maxAttempts: number;
28
31
  /**
@@ -44,15 +47,7 @@ export type ExecuteAttemptsOptions = {
44
47
  /**
45
48
  * @@@
46
49
  */
47
- readonly tools: ExecutionTools;
48
- /**
49
- * Settings for the pipeline executor
50
- */
51
- readonly settings: CreatePipelineExecutorSettings;
52
- /**
53
- * @@@
54
- */
55
- readonly $executionReport: ExecutionReportJson;
50
+ readonly $executionReport: WritableDeep<ExecutionReportJson>;
56
51
  /**
57
52
  * @@@
58
53
  */
@@ -62,4 +62,4 @@ export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").Readon
62
62
  *
63
63
  * @public exported from `@promptbook/core`
64
64
  */
65
- export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;
65
+ export declare function addUsage(...usageItems: ReadonlyArray<PromptResultUsage>): PromptResultUsage;
@@ -16,5 +16,5 @@ type ForEachAsyncOptions = {
16
16
  * @public exported from `@promptbook/utils`
17
17
  * @deprecated [🪂] Use queues instead
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
+ export declare function forEachAsync<TItem>(array: ReadonlyArray<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: ReadonlyArray<TItem>) => Promisable<void>): Promise<void>;
20
20
  export {};
@@ -21,7 +21,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
21
21
  /**
22
22
  * Aliases for the `formatName`
23
23
  */
24
- readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
24
+ readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
25
25
  /**
26
26
  * The mime type of the format (if any)
27
27
  *
@@ -58,7 +58,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
58
58
  /**
59
59
  * @@@
60
60
  */
61
- readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue, TSettings>>;
61
+ readonly subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<TValue, TSettings>>;
62
62
  };
63
63
  /**
64
64
  * TODO: [♏] Add some prepare hook to modify prompt according to the format
@@ -1,7 +1,7 @@
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';
4
3
  import type { string_name } from '../../types/typeAliases';
4
+ import type { string_parameter_name } from '../../types/typeAliases';
5
5
  import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
6
6
  import type { empty_object } from '../../utils/organization/empty_object';
7
7
  /**
@@ -17,7 +17,7 @@ export type FormatSubvalueDefinition<TValue extends string, TSettings extends em
17
17
  /**
18
18
  * Aliases for the `subvalueName`
19
19
  */
20
- readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
20
+ readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
21
21
  /**
22
22
  * Maps values
23
23
  *
@@ -1,11 +1,11 @@
1
- import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
1
+ import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
2
2
  import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
3
3
  /**
4
4
  * Returns LLM tools for CLI
5
5
  *
6
6
  * @private within the repository - for CLI utils
7
7
  */
8
- export declare function $provideLlmToolsForCli(options?: Pick<PrepareAndScrapeOptions, 'isCacheCleaned'>): LlmExecutionToolsWithTotalUsage;
8
+ export declare function $provideLlmToolsForCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): LlmExecutionToolsWithTotalUsage;
9
9
  /**
10
10
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
11
11
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
@@ -6,7 +6,7 @@ import type { LlmToolsOptions } from './LlmToolsOptions';
6
6
  *
7
7
  * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
8
8
  */
9
- export type LlmToolsConfiguration = Array<Registered & {
9
+ export type LlmToolsConfiguration = ReadonlyArray<Registered & {
10
10
  /**
11
11
  * @@@
12
12
  */
@@ -1,5 +1,8 @@
1
1
  import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
2
2
  import type { CacheItem } from './CacheItem';
3
+ /**
4
+ * @@@
5
+ */
3
6
  export type CacheLlmToolsOptions = {
4
7
  /**
5
8
  * @@@
@@ -12,5 +15,5 @@ export type CacheLlmToolsOptions = {
12
15
  *
13
16
  * @default false
14
17
  */
15
- isReloaded?: boolean;
18
+ isCacheReloaded?: boolean;
16
19
  };
@@ -35,7 +35,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
35
35
  /**
36
36
  * List all available Anthropic Claude models that can be used
37
37
  */
38
- listModels(): Array<AvailableModel>;
38
+ listModels(): ReadonlyArray<AvailableModel>;
39
39
  /**
40
40
  * Calls Anthropic Claude API to use a chat model.
41
41
  */