@promptbook/remote-server 0.72.0-13 → 0.72.0-15
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 +1 -1
- package/esm/index.es.js +7 -8
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/core.index.d.ts +22 -18
- package/esm/typings/src/_packages/node.index.d.ts +2 -0
- package/esm/typings/src/_packages/types.index.d.ts +10 -10
- package/esm/typings/src/_packages/utils.index.d.ts +2 -2
- 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/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 +21 -14
- 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 +9 -3
- package/esm/typings/src/execution/LlmExecutionTools.d.ts +1 -1
- package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
- package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +1 -0
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +29 -6
- package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +2 -11
- package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +4 -13
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +9 -14
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -3
- 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/register/$provideLlmToolsForCli.d.ts +2 -2
- package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +1 -1
- package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +7 -0
- 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/anthropic-claude-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.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 +1 -1
- package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +4 -5
- package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +3 -3
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +2 -2
- package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +4 -23
- package/esm/typings/src/prepare/prepareTemplates.d.ts +1 -1
- package/esm/typings/src/scrapers/_common/Scraper.d.ts +1 -5
- package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +1 -1
- package/esm/typings/src/scrapers/_common/register/$provideExecutablesForNode.d.ts +12 -0
- package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +2 -2
- package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +2 -2
- package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +2 -2
- package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +2 -2
- package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +2 -2
- package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -1
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +3 -3
- package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -1
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -1
- package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +2 -2
- package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -1
- package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +6 -3
- package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -1
- package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
- package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -1
- package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.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 +1 -1
- package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -1
- package/esm/typings/src/utils/$Register.d.ts +1 -1
- 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 +2 -2
- package/esm/typings/src/utils/execCommand/{IExecCommandOptions.d.ts → ExecCommandOptions.d.ts} +2 -6
- package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +3 -3
- package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
- 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 +7 -8
- 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/website/utils/markdownConverter.d.ts +0 -12
- /package/esm/typings/src/scrapers/website/utils/{markdownConverter.test.d.ts → createShowdownConverter.test.d.ts} +0 -0
|
@@ -31,7 +31,7 @@ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> impleme
|
|
|
31
31
|
/**
|
|
32
32
|
* List all available models that can be used
|
|
33
33
|
*/
|
|
34
|
-
listModels(): Promise<
|
|
34
|
+
listModels(): Promise<ReadonlyArray<AvailableModel>>;
|
|
35
35
|
/**
|
|
36
36
|
* Creates a connection to the remote proxy server.
|
|
37
37
|
*/
|
package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts
CHANGED
|
@@ -4,12 +4,12 @@ import type { AvailableModel } from '../../../execution/AvailableModel';
|
|
|
4
4
|
*
|
|
5
5
|
* This is sent from server to client when models are listed
|
|
6
6
|
*/
|
|
7
|
-
export
|
|
7
|
+
export type PromptbookServer_ListModels_Response = {
|
|
8
8
|
/**
|
|
9
9
|
* Available models that can be used
|
|
10
10
|
*/
|
|
11
|
-
readonly models:
|
|
12
|
-
}
|
|
11
|
+
readonly models: ReadonlyArray<AvailableModel>;
|
|
12
|
+
};
|
|
13
13
|
/**
|
|
14
14
|
* TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
|
|
15
15
|
*/
|
package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts
CHANGED
|
@@ -4,9 +4,9 @@ import type { PromptResult } from '../../../execution/PromptResult';
|
|
|
4
4
|
*
|
|
5
5
|
* This is sent from server to client when the generated text is completed
|
|
6
6
|
*/
|
|
7
|
-
export
|
|
7
|
+
export type PromptbookServer_Prompt_Response = {
|
|
8
8
|
/**
|
|
9
9
|
* The result of the prompt
|
|
10
10
|
*/
|
|
11
11
|
readonly promptResult: PromptResult;
|
|
12
|
-
}
|
|
12
|
+
};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
|
|
1
2
|
import type { string_dirname } from '../types/typeAliases';
|
|
2
3
|
/**
|
|
3
4
|
* Options for preparation of the pipeline
|
|
@@ -21,37 +22,17 @@ export type PrepareAndScrapeOptions = {
|
|
|
21
22
|
*/
|
|
22
23
|
readonly cacheDirname?: string_dirname;
|
|
23
24
|
/**
|
|
24
|
-
*
|
|
25
|
+
* Strategy for caching the intermediate results for knowledge source
|
|
25
26
|
*
|
|
26
|
-
*
|
|
27
|
-
* @default false // <- TODO: !!!!!! Change to `cacheStrategy`/`intermediateFiles`, Put to global config, change to `true` and explicitly set to `false` in all playgrounds
|
|
27
|
+
* @default DEFAULT_INTERMEDIATE_FILES_STRATEGY
|
|
28
28
|
*/
|
|
29
|
-
readonly
|
|
29
|
+
readonly intermediateFilesStrategy?: IntermediateFilesStrategy;
|
|
30
30
|
/**
|
|
31
31
|
* Maximum number of tasks running in parallel
|
|
32
32
|
*
|
|
33
33
|
* @default MAX_PARALLEL_COUNT
|
|
34
34
|
*/
|
|
35
35
|
readonly maxParallelCount?: number;
|
|
36
|
-
/**
|
|
37
|
-
* Path to the external programs executables
|
|
38
|
-
*
|
|
39
|
-
* TODO: !!!!!! Transform to scrapers and make them Classy
|
|
40
|
-
*/
|
|
41
|
-
readonly externalProgramsPaths?: {
|
|
42
|
-
/**
|
|
43
|
-
* Path to the `pandoc` executable
|
|
44
|
-
*
|
|
45
|
-
* @example 'C:/Users/me/AppData/Local/Pandoc/pandoc.exe'
|
|
46
|
-
*/
|
|
47
|
-
readonly pandocPath?: string;
|
|
48
|
-
/**
|
|
49
|
-
* Path to the LibreOffice executable
|
|
50
|
-
*
|
|
51
|
-
* @example 'C:/Program Files/LibreOffice/program/swriter.exe'
|
|
52
|
-
*/
|
|
53
|
-
readonly libreOfficePath?: string;
|
|
54
|
-
};
|
|
55
36
|
/**
|
|
56
37
|
* If true, the missing software is automatically installed
|
|
57
38
|
*/
|
|
@@ -17,7 +17,7 @@ export type Scraper = {
|
|
|
17
17
|
/**
|
|
18
18
|
* Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
|
|
19
19
|
*/
|
|
20
|
-
scrape(source: ScraperSourceHandler): Promisable<
|
|
20
|
+
scrape(source: ScraperSourceHandler): Promisable<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
|
|
21
21
|
};
|
|
22
22
|
/**
|
|
23
23
|
* @@@
|
|
@@ -60,7 +60,3 @@ export type ScraperSourceHandler = {
|
|
|
60
60
|
* TODO: [🐝] @@@ Annotate all
|
|
61
61
|
* TODO: [🔼] Export via types
|
|
62
62
|
*/
|
|
63
|
-
/**
|
|
64
|
-
* TODO: !!!!!! Test that this is catched
|
|
65
|
-
* Note: [⚫] Code in this file should never be published in any package
|
|
66
|
-
*/
|
|
@@ -8,7 +8,7 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
|
|
|
8
8
|
* @see https://github.com/webgptorg/promptbook/discussions/41
|
|
9
9
|
* @public exported from `@promptbook/core`
|
|
10
10
|
*/
|
|
11
|
-
export declare function prepareKnowledgePieces(knowledgeSources:
|
|
11
|
+
export declare function prepareKnowledgePieces(knowledgeSources: ReadonlyArray<KnowledgeSourceJson>, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
|
|
12
12
|
/**
|
|
13
13
|
* TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
|
|
14
14
|
* Put `knowledgePieces` into `PrepareKnowledgeOptions`
|
|
@@ -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: [🧠] THis should be maybe in different folder
|
|
11
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
12
|
+
*/
|
|
@@ -2,11 +2,11 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
|
|
|
2
2
|
import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
|
|
3
3
|
import type { Scraper } from '../Scraper';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* @@@
|
|
6
6
|
*
|
|
7
7
|
* 1) @@@
|
|
8
8
|
* 2) @@@
|
|
9
9
|
*
|
|
10
10
|
* @public exported from `@promptbook/browser`
|
|
11
11
|
*/
|
|
12
|
-
export declare function $provideScrapersForBrowser(tools: Pick<ExecutionTools, 'llm'>, options?: PrepareAndScrapeOptions): Promise<
|
|
12
|
+
export declare function $provideScrapersForBrowser(tools: Pick<ExecutionTools, 'llm'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;
|
|
@@ -2,14 +2,14 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
|
|
|
2
2
|
import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
|
|
3
3
|
import type { Scraper } from '../Scraper';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* @@@
|
|
6
6
|
*
|
|
7
7
|
* 1) @@@
|
|
8
8
|
* 2) @@@
|
|
9
9
|
*
|
|
10
10
|
* @public exported from `@promptbook/node`
|
|
11
11
|
*/
|
|
12
|
-
export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options?: PrepareAndScrapeOptions): Promise<
|
|
12
|
+
export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;
|
|
13
13
|
/**
|
|
14
14
|
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
15
15
|
*/
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
+
import type { Executables } from '../../../execution/Executables';
|
|
1
2
|
import type { string_mime_type } from '../../../types/typeAliases';
|
|
2
3
|
import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
|
|
3
4
|
import type { string_title } from '../../../types/typeAliases';
|
|
4
5
|
import type { Registered } from '../../../utils/$Register';
|
|
5
|
-
import type { TODO_any } from '../../../utils/organization/TODO_any';
|
|
6
6
|
/**
|
|
7
7
|
* @@@
|
|
8
8
|
*
|
|
@@ -33,7 +33,7 @@ export type ScraperAndConverterMetadata = Registered & {
|
|
|
33
33
|
/**
|
|
34
34
|
* @@@
|
|
35
35
|
*/
|
|
36
|
-
readonly requiredExecutables:
|
|
36
|
+
readonly requiredExecutables: ReadonlyArray<Capitalize<keyof Executables extends `${infer N}Path` ? N : never>>;
|
|
37
37
|
/**
|
|
38
38
|
* Link to documentation
|
|
39
39
|
*/
|
|
@@ -13,7 +13,7 @@ type GetScraperIntermediateSourceSource = Pick<ScraperSourceHandler, 'filename'
|
|
|
13
13
|
*
|
|
14
14
|
* @private internal utility of `getScraperIntermediateSource`
|
|
15
15
|
*/
|
|
16
|
-
type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | '
|
|
16
|
+
type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | 'intermediateFilesStrategy' | 'isVerbose'>> & {
|
|
17
17
|
readonly extension: string_file_extension;
|
|
18
18
|
};
|
|
19
19
|
/**
|
|
@@ -28,7 +28,7 @@ export {};
|
|
|
28
28
|
/**
|
|
29
29
|
* Note: Not using `FileCacheStorage` for two reasons:
|
|
30
30
|
* 1) Need to store more than serialized JSONs
|
|
31
|
-
* 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO:
|
|
31
|
+
* 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
|
|
32
32
|
* TODO: [🐱🐉][🧠] Make some smart crop
|
|
33
33
|
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
34
34
|
*/
|
|
@@ -23,7 +23,7 @@ export declare class DocumentScraper implements Converter, Scraper {
|
|
|
23
23
|
* Markdown scraper is used internally
|
|
24
24
|
*/
|
|
25
25
|
private readonly markdownScraper;
|
|
26
|
-
constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
|
|
26
|
+
constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
|
|
27
27
|
/**
|
|
28
28
|
* Convert the `.docx` or `.odt` to `.md` file and returns intermediate source
|
|
29
29
|
*
|
|
@@ -33,7 +33,7 @@ export declare class DocumentScraper implements Converter, Scraper {
|
|
|
33
33
|
/**
|
|
34
34
|
* Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
|
|
35
35
|
*/
|
|
36
|
-
scrape(source: ScraperSourceHandler): Promise<
|
|
36
|
+
scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
39
|
* TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
|
|
@@ -13,7 +13,7 @@ export declare const createDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>
|
|
|
13
13
|
mimeTypes: string[];
|
|
14
14
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
15
15
|
isAvilableInBrowser: false;
|
|
16
|
-
requiredExecutables:
|
|
16
|
+
requiredExecutables: "Pandoc"[];
|
|
17
17
|
}>;
|
|
18
18
|
/**
|
|
19
19
|
* TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
|
|
@@ -11,7 +11,7 @@ export declare const documentScraperMetadata: import("type-fest/source/readonly-
|
|
|
11
11
|
mimeTypes: string[];
|
|
12
12
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
13
13
|
isAvilableInBrowser: false;
|
|
14
|
-
requiredExecutables:
|
|
14
|
+
requiredExecutables: "Pandoc"[];
|
|
15
15
|
}>;
|
|
16
16
|
/**
|
|
17
17
|
* Registration of known scraper metadata
|
|
@@ -7,7 +7,7 @@ import type { Scraper } from '../_common/Scraper';
|
|
|
7
7
|
import type { ScraperSourceHandler } from '../_common/Scraper';
|
|
8
8
|
import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
|
|
9
9
|
/**
|
|
10
|
-
* Scraper for .
|
|
10
|
+
* Scraper for old document files (like .doc and .rtf)
|
|
11
11
|
*
|
|
12
12
|
* @see `documentationUrl` for more details
|
|
13
13
|
* @public exported from `@promptbook/legacy-documents`
|
|
@@ -23,7 +23,7 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
|
|
|
23
23
|
* Document scraper is used internally
|
|
24
24
|
*/
|
|
25
25
|
private readonly documentScraper;
|
|
26
|
-
constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
|
|
26
|
+
constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
|
|
27
27
|
/**
|
|
28
28
|
* Convert the `.doc` or `.rtf` to `.doc` file and returns intermediate source
|
|
29
29
|
*
|
|
@@ -33,7 +33,7 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
|
|
|
33
33
|
/**
|
|
34
34
|
* Scrapes the `.doc` or `.rtf` file and returns the knowledge pieces or `null` if it can't scrape it
|
|
35
35
|
*/
|
|
36
|
-
scrape(source: ScraperSourceHandler): Promise<
|
|
36
|
+
scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
39
|
* TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
|
|
@@ -13,7 +13,7 @@ export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools,
|
|
|
13
13
|
mimeTypes: string[];
|
|
14
14
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
15
15
|
isAvilableInBrowser: false;
|
|
16
|
-
requiredExecutables:
|
|
16
|
+
requiredExecutables: ("Pandoc" | "LibreOffice")[];
|
|
17
17
|
}>;
|
|
18
18
|
/**
|
|
19
19
|
* TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
|
|
@@ -11,7 +11,7 @@ export declare const legacyDocumentScraperMetadata: import("type-fest/source/rea
|
|
|
11
11
|
mimeTypes: string[];
|
|
12
12
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
13
13
|
isAvilableInBrowser: false;
|
|
14
|
-
requiredExecutables:
|
|
14
|
+
requiredExecutables: ("Pandoc" | "LibreOffice")[];
|
|
15
15
|
}>;
|
|
16
16
|
/**
|
|
17
17
|
* Registration of known scraper metadata
|
|
@@ -21,7 +21,7 @@ export declare class MarkdownScraper implements Scraper {
|
|
|
21
21
|
/**
|
|
22
22
|
* Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
|
|
23
23
|
*/
|
|
24
|
-
scrape(source: ScraperSourceHandler): Promise<
|
|
24
|
+
scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
27
|
* TODO: [🪂] Do it in parallel 11:11
|
|
@@ -13,7 +13,7 @@ export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>
|
|
|
13
13
|
mimeTypes: string[];
|
|
14
14
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
15
15
|
isAvilableInBrowser: true;
|
|
16
|
-
requiredExecutables:
|
|
16
|
+
requiredExecutables: never[];
|
|
17
17
|
}>;
|
|
18
18
|
/**
|
|
19
19
|
* TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
|
|
@@ -11,7 +11,7 @@ export declare const markdownScraperMetadata: import("type-fest/source/readonly-
|
|
|
11
11
|
mimeTypes: string[];
|
|
12
12
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
13
13
|
isAvilableInBrowser: true;
|
|
14
|
-
requiredExecutables:
|
|
14
|
+
requiredExecutables: never[];
|
|
15
15
|
}>;
|
|
16
16
|
/**
|
|
17
17
|
* Registration of known scraper metadata
|
|
@@ -7,7 +7,7 @@ import type { Converter } from '../_common/Converter';
|
|
|
7
7
|
import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
|
|
8
8
|
import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
|
|
9
9
|
/**
|
|
10
|
-
* Scraper for .
|
|
10
|
+
* Scraper for .pdf files
|
|
11
11
|
*
|
|
12
12
|
* @see `documentationUrl` for more details
|
|
13
13
|
* @public exported from `@promptbook/pdf`
|
|
@@ -31,7 +31,7 @@ export declare class PdfScraper implements Converter, Scraper {
|
|
|
31
31
|
/**
|
|
32
32
|
* Scrapes the `.pdf` file and returns the knowledge pieces or `null` if it can't scrape it
|
|
33
33
|
*/
|
|
34
|
-
scrape(source: ScraperSourceHandler): Promise<
|
|
34
|
+
scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
37
|
* TODO: [👣] Converted pdf documents can act as cached items - there is no need to run conversion each time
|
|
@@ -13,7 +13,7 @@ export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, opt
|
|
|
13
13
|
mimeTypes: string[];
|
|
14
14
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
15
15
|
isAvilableInBrowser: true;
|
|
16
|
-
requiredExecutables:
|
|
16
|
+
requiredExecutables: never[];
|
|
17
17
|
}>;
|
|
18
18
|
/**
|
|
19
19
|
* TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
|
|
@@ -11,7 +11,7 @@ export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep"
|
|
|
11
11
|
mimeTypes: string[];
|
|
12
12
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
13
13
|
isAvilableInBrowser: true;
|
|
14
|
-
requiredExecutables:
|
|
14
|
+
requiredExecutables: never[];
|
|
15
15
|
}>;
|
|
16
16
|
/**
|
|
17
17
|
* Registration of known scraper metadata
|
|
@@ -8,7 +8,7 @@ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOpti
|
|
|
8
8
|
import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
|
|
9
9
|
import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
|
|
10
10
|
/**
|
|
11
|
-
* Scraper for
|
|
11
|
+
* Scraper for websites
|
|
12
12
|
*
|
|
13
13
|
* @see `documentationUrl` for more details
|
|
14
14
|
* @public exported from `@promptbook/website-crawler`
|
|
@@ -24,6 +24,10 @@ export declare class WebsiteScraper implements Converter, Scraper {
|
|
|
24
24
|
* Markdown scraper is used internally
|
|
25
25
|
*/
|
|
26
26
|
private readonly markdownScraper;
|
|
27
|
+
/**
|
|
28
|
+
* Showdown converter is used internally
|
|
29
|
+
*/
|
|
30
|
+
private readonly showdownConverter;
|
|
27
31
|
constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
|
|
28
32
|
/**
|
|
29
33
|
* Convert the website to `.md` file and returns intermediate source
|
|
@@ -36,10 +40,9 @@ export declare class WebsiteScraper implements Converter, Scraper {
|
|
|
36
40
|
/**
|
|
37
41
|
* Scrapes the website and returns the knowledge pieces or `null` if it can't scrape it
|
|
38
42
|
*/
|
|
39
|
-
scrape(source: ScraperSourceHandler): Promise<
|
|
43
|
+
scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
|
|
40
44
|
}
|
|
41
45
|
/**
|
|
42
|
-
* TODO: !!!!!! Put into separate package
|
|
43
46
|
* TODO: [👣] Scraped website in .md can act as cache item - there is no need to run conversion each time
|
|
44
47
|
* TODO: [🪂] Do it in parallel 11:11
|
|
45
48
|
* Note: No need to aggregate usage here, it is done by intercepting the llmTools
|
|
@@ -13,7 +13,7 @@ export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>,
|
|
|
13
13
|
mimeTypes: string[];
|
|
14
14
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
15
15
|
isAvilableInBrowser: false;
|
|
16
|
-
requiredExecutables:
|
|
16
|
+
requiredExecutables: never[];
|
|
17
17
|
}>;
|
|
18
18
|
/**
|
|
19
19
|
* TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
|
|
@@ -11,7 +11,7 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
|
|
|
11
11
|
mimeTypes: string[];
|
|
12
12
|
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
13
13
|
isAvilableInBrowser: false;
|
|
14
|
-
requiredExecutables:
|
|
14
|
+
requiredExecutables: never[];
|
|
15
15
|
}>;
|
|
16
16
|
/**
|
|
17
17
|
* Registration of known scraper metadata
|
|
@@ -7,7 +7,7 @@ import type { really_any } from '../../../utils/organization/really_any';
|
|
|
7
7
|
* @returns nothing
|
|
8
8
|
* @private internal function of `JavascriptExecutionTools` and `JavascriptEvalExecutionTools`
|
|
9
9
|
*/
|
|
10
|
-
export declare function preserve(func: (...params:
|
|
10
|
+
export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
|
|
11
11
|
/**
|
|
12
12
|
* TODO: !! [1] This maybe does memory leak
|
|
13
13
|
*/
|
|
@@ -4,4 +4,4 @@ import type { string_name } from '../../../types/typeAliases';
|
|
|
4
4
|
*
|
|
5
5
|
* @private for `FileCacheStorage`
|
|
6
6
|
*/
|
|
7
|
-
export declare function nameToSubfolderPath(name: string_name):
|
|
7
|
+
export declare function nameToSubfolderPath(name: string_name): ReadonlyArray<string>;
|
|
@@ -31,7 +31,7 @@ export type KnowledgePiecePreparedJson = {
|
|
|
31
31
|
/**
|
|
32
32
|
* List of sources where the information comes from
|
|
33
33
|
*/
|
|
34
|
-
readonly sources:
|
|
34
|
+
readonly sources: ReadonlyArray<{
|
|
35
35
|
/**
|
|
36
36
|
* Identifier of the source
|
|
37
37
|
*/
|
|
@@ -48,11 +48,11 @@ export type KnowledgePiecePreparedJson = {
|
|
|
48
48
|
/**
|
|
49
49
|
* List of keywords that are associated with the knowledge piece
|
|
50
50
|
*/
|
|
51
|
-
readonly keywords:
|
|
51
|
+
readonly keywords: ReadonlyArray<string_keyword>;
|
|
52
52
|
/**
|
|
53
53
|
* List of models embeddings that are associated with the knowledge piece
|
|
54
54
|
*/
|
|
55
|
-
readonly index:
|
|
55
|
+
readonly index: ReadonlyArray<{
|
|
56
56
|
/**
|
|
57
57
|
* Model name which generated the embedding
|
|
58
58
|
*/
|
|
@@ -65,7 +65,7 @@ export type KnowledgePiecePreparedJson = {
|
|
|
65
65
|
/**
|
|
66
66
|
* List of preparation ids that were used to prepare this knowledge piece
|
|
67
67
|
*/
|
|
68
|
-
readonly preparationIds:
|
|
68
|
+
readonly preparationIds: ReadonlyArray<number_id>;
|
|
69
69
|
};
|
|
70
70
|
/**
|
|
71
71
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -37,7 +37,7 @@ export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
|
|
|
37
37
|
/**
|
|
38
38
|
* List of preparation ids that were used to prepare this knowledge source to knowledge pieces
|
|
39
39
|
*/
|
|
40
|
-
readonly preparationIds:
|
|
40
|
+
readonly preparationIds: ReadonlyArray<number_id>;
|
|
41
41
|
};
|
|
42
42
|
/**
|
|
43
43
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -38,7 +38,7 @@ export type PersonaPreparedJson = PersonaJson & {
|
|
|
38
38
|
/**
|
|
39
39
|
* List of preparation ids that were used to prepare this persona
|
|
40
40
|
*/
|
|
41
|
-
readonly preparationIds:
|
|
41
|
+
readonly preparationIds: ReadonlyArray<number_id>;
|
|
42
42
|
};
|
|
43
43
|
/**
|
|
44
44
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -13,7 +13,7 @@ import type { Expectations } from './Expectations';
|
|
|
13
13
|
/**
|
|
14
14
|
* Common properties of all templates
|
|
15
15
|
*/
|
|
16
|
-
export
|
|
16
|
+
export type TemplateJsonCommon = {
|
|
17
17
|
/**
|
|
18
18
|
* Name of the template
|
|
19
19
|
* - It must be unique across the pipeline
|
|
@@ -93,7 +93,7 @@ export interface TemplateJsonCommon {
|
|
|
93
93
|
* Name of the parameter that is the result of the template
|
|
94
94
|
*/
|
|
95
95
|
readonly resultingParameterName: string_name;
|
|
96
|
-
}
|
|
96
|
+
};
|
|
97
97
|
/**
|
|
98
98
|
* TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
|
|
99
99
|
* TODO: [♈] Probbably move expectations from templates to parameters
|
|
@@ -77,7 +77,7 @@ export type CommonPrompt = {
|
|
|
77
77
|
/**
|
|
78
78
|
* List of postprocessing steps that are executed after the prompt
|
|
79
79
|
*/
|
|
80
|
-
readonly postprocessingFunctionNames?:
|
|
80
|
+
readonly postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
|
|
81
81
|
/**
|
|
82
82
|
* Expectations for the answer
|
|
83
83
|
*
|
|
@@ -34,6 +34,6 @@ export declare class $Register<TRegistered extends Registered> {
|
|
|
34
34
|
private readonly registerName;
|
|
35
35
|
private readonly storage;
|
|
36
36
|
constructor(registerName: string_name);
|
|
37
|
-
list():
|
|
37
|
+
list(): ReadonlyArray<TRegistered>;
|
|
38
38
|
register(registered: TRegistered): Registration;
|
|
39
39
|
}
|
|
@@ -8,4 +8,4 @@ import type { Arrayable } from '../types/Arrayable';
|
|
|
8
8
|
*
|
|
9
9
|
* @private internal utility
|
|
10
10
|
*/
|
|
11
|
-
export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>):
|
|
11
|
+
export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): ReadonlyArray<TItem>;
|
|
@@ -8,7 +8,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
|
|
|
8
8
|
* @private within the repository
|
|
9
9
|
* @deprecated Use /\p{Extended_Pictographic}/ instead
|
|
10
10
|
*/
|
|
11
|
-
export declare const EMOJIS_IN_CATEGORIES: Record<string,
|
|
11
|
+
export declare const EMOJIS_IN_CATEGORIES: Record<string, ReadonlyArray<string_char_emoji>>;
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* All possible emoji chars like "🍆", "🍡", "🍤"...
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { ExecCommandOptions } from './ExecCommandOptions';
|
|
2
2
|
/**
|
|
3
3
|
* Run one command in a shell
|
|
4
4
|
*
|
|
@@ -8,7 +8,7 @@ import type { IExecCommandOptions } from './IExecCommandOptions';
|
|
|
8
8
|
*
|
|
9
9
|
* @public exported from `@promptbook/node`
|
|
10
10
|
*/
|
|
11
|
-
export declare function $execCommand(options:
|
|
11
|
+
export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
|
|
12
12
|
/**
|
|
13
13
|
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
14
14
|
*/
|
package/esm/typings/src/utils/execCommand/{IExecCommandOptions.d.ts → ExecCommandOptions.d.ts}
RENAMED
|
@@ -4,16 +4,12 @@
|
|
|
4
4
|
type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends keyof TBase> = Pick<TBase, TRequired> & Partial<Pick<TBase, TOptional>>;
|
|
5
5
|
/**
|
|
6
6
|
* Simple options for `execCommand`
|
|
7
|
-
*
|
|
8
|
-
* TODO: !!!!!! Rename - remove I prefix
|
|
9
7
|
*/
|
|
10
|
-
export type
|
|
8
|
+
export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
|
|
11
9
|
/**
|
|
12
10
|
* Advanced options for `execCommand`
|
|
13
|
-
*
|
|
14
|
-
* TODO: !!!!!! Rename - remove I prefix
|
|
15
11
|
*/
|
|
16
|
-
export type
|
|
12
|
+
export type ExecCommandOptionsAdvanced = {
|
|
17
13
|
readonly command: string;
|
|
18
14
|
readonly args: string[];
|
|
19
15
|
readonly cwd: string;
|