@promptbook/types 0.72.0-9 → 0.73.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -253
- package/esm/typings/src/_packages/core.index.d.ts +24 -18
- package/esm/typings/src/_packages/node.index.d.ts +2 -0
- package/esm/typings/src/_packages/types.index.d.ts +18 -12
- 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/TEMPLATE/TemplateTypes.d.ts +1 -1
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +5 -5
- package/esm/typings/src/config.d.ts +22 -15
- package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -3
- package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts +1 -1
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
- package/esm/typings/src/conversion/validation/validatePipeline.d.ts +2 -2
- package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
- package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
- package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
- package/esm/typings/src/executables/locateApp.d.ts +33 -0
- package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
- package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
- package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
- package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
- package/esm/typings/src/execution/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/FilesystemTools.d.ts +1 -1
- package/esm/typings/src/execution/LlmExecutionTools.d.ts +2 -2
- package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
- package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +3 -2
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +29 -6
- package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +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/createPipelineExecutor/{getSamplesForTemplate.d.ts → getExamplesForTemplate.d.ts} +1 -1
- 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 +4 -4
- package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +3 -3
- 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/AnthropicClaudeExecutionToolsOptions.d.ts +2 -2
- 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/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +2 -1
- package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
- package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +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/OpenAiAssistantExecutionTools.d.ts +0 -1
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -2
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +2 -2
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +15 -6
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +4 -4
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +6 -12
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +3 -3
- package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +9 -14
- package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +23 -8
- package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
- package/esm/typings/src/personas/preparePersona.d.ts +1 -1
- package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +4 -23
- package/esm/typings/src/prepare/isPipelinePrepared.d.ts +2 -2
- package/esm/typings/src/prepare/prepareTemplates.d.ts +2 -2
- package/esm/typings/src/scrapers/_common/Scraper.d.ts +2 -9
- package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +1 -1
- 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/_common/utils/makeKnowledgeSourceHandler.d.ts +1 -1
- package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +2 -2
- package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +1 -1
- 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/LegacyDocumentScraper.test.d.ts +1 -1
- 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/MarkdownScraper.test.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/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -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/ParameterJson.d.ts +2 -2
- package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/PreparationJson.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +2 -2
- package/esm/typings/src/types/Prompt.d.ts +2 -1
- package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -1
- package/esm/typings/src/types/typeAliases.d.ts +11 -8
- 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 +4 -2
- package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
- package/esm/typings/src/utils/execCommand/$execCommands.d.ts +1 -0
- package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
- package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
- package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
- package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
- package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
- package/esm/typings/src/utils/normalization/IKeywords.d.ts +2 -2
- package/esm/typings/src/utils/normalization/parseKeywords.d.ts +2 -2
- package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +2 -2
- package/esm/typings/src/utils/normalization/searchKeywords.d.ts +2 -2
- package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -1
- package/esm/typings/src/utils/organization/keepUnused.d.ts +1 -1
- package/esm/typings/src/utils/random/$randomSeed.d.ts +1 -1
- package/esm/typings/src/utils/sets/intersection.d.ts +1 -1
- package/esm/typings/src/utils/sets/union.d.ts +1 -1
- package/esm/typings/src/utils/unwrapResult.d.ts +4 -4
- package/package.json +5 -3
- 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/utils/execCommand/IExecCommandOptions.d.ts +0 -23
- package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +0 -10
- /package/esm/typings/src/{scrapers/website/WebsiteScraper.test.d.ts → executables/apps/locateLibreoffice.test.d.ts} +0 -0
- /package/esm/typings/src/{scrapers/website/utils/markdownConverter.test.d.ts → executables/apps/locatePandoc.test.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
#  Promptbook
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Build responsible, controlled and transparent applications on top of LLM models!
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
@@ -18,12 +18,10 @@ Supercharge your use of large language models
|
|
|
18
18
|
|
|
19
19
|
## ✨ New Features
|
|
20
20
|
|
|
21
|
+
- 💙 Working on [the **Book** language v1](https://github.com/webgptorg/book)
|
|
22
|
+
- 📚 Support of `.docx`, `.doc` and `.pdf` documents
|
|
21
23
|
- ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
|
|
22
24
|
|
|
23
|
-
<blockquote style="color: #ff8811">
|
|
24
|
-
<b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
|
|
25
|
-
</blockquote>
|
|
26
|
-
|
|
27
25
|
|
|
28
26
|
|
|
29
27
|
## 📦 Package `@promptbook/types`
|
|
@@ -49,7 +47,7 @@ import { pipelineStringToJson } from '@promptbook/core';
|
|
|
49
47
|
const promptbook: PipelineJson = pipelineStringToJson(
|
|
50
48
|
spaceTrim(`
|
|
51
49
|
|
|
52
|
-
# ✨
|
|
50
|
+
# ✨ Example prompt
|
|
53
51
|
|
|
54
52
|
- OUTPUT PARAMETER {greeting}
|
|
55
53
|
|
|
@@ -75,260 +73,48 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
75
73
|
|
|
76
74
|
## 🤍 The Promptbook Whitepaper
|
|
77
75
|
|
|
76
|
+
If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
|
|
78
77
|
|
|
79
|
-
|
|
80
|
-
If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
|
|
81
|
-
|
|
82
|
-
But often you will struggle with the limitations of LLMs, such as hallucinations, off-topic responses, poor quality output, language drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses. When this happens, you generally have three options:
|
|
78
|
+
But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd resp0nses**. When this happens, you generally have three options:
|
|
83
79
|
|
|
84
80
|
1. **Fine-tune** the model to your specifications or even train your own.
|
|
85
81
|
2. **Prompt-engineer** the prompt to the best shape you can achieve.
|
|
86
82
|
3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
|
|
87
83
|
|
|
88
|
-
In all of these situations, but especially in 3., the Promptbook
|
|
84
|
+
In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
|
|
89
85
|
|
|
90
|
-
- [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic.
|
|
91
|
-
-
|
|
92
|
-
- **Forget** about **low-level details** like choosing the right model, tokens, context size, temperature
|
|
93
|
-
-
|
|
86
|
+
- [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic. For this purpose, it introduces a new language called [the **💙 Book**](https://github.com/webgptorg/book).
|
|
87
|
+
- Book allows you to **focus on the business** logic without having to write code or deal with the technicalities of LLMs.
|
|
88
|
+
- **Forget** about **low-level details** like choosing the right model, tokens, context size, `temperature`, `top-k`, `top-p`, or kernel sampling. **Just write your intent** and [**persona**](https://github.com/webgptorg/promptbook/discussions/22) who should be responsible for the task and let the library do the rest.
|
|
89
|
+
- We have built-in **orchestration** of [pipeline](https://github.com/webgptorg/promptbook/discussions/64) execution and many tools to make the process easier, more reliable, and more efficient, such as caching, [compilation+preparation](https://github.com/webgptorg/promptbook/discussions/78), [just-in-time fine-tuning](https://github.com/webgptorg/promptbook/discussions/33), [expectation-aware generation](https://github.com/webgptorg/promptbook/discussions/37), [agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39), and more.
|
|
94
90
|
- Sometimes even the best prompts with the best framework like Promptbook `:)` can't avoid the problems. In this case, the library has built-in **[anomaly detection](https://github.com/webgptorg/promptbook/discussions/40) and logging** to help you find and fix the problems.
|
|
95
|
-
-
|
|
96
|
-
- Promptbook is designed to
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
##
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
- Multiple pipelines forms a **collection** which will handle core **know-how of your LLM application**.
|
|
105
|
-
- Theese pipelines are designed such as they **can be written by non-programmers**.
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
### Sample:
|
|
110
|
-
|
|
111
|
-
File `write-website-content.ptbk.md`:
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
> # 🌍 Create website content
|
|
118
|
-
>
|
|
119
|
-
> Instructions for creating web page content.
|
|
120
|
-
>
|
|
121
|
-
> - PIPELINE URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
|
|
122
|
-
> - INPUT PARAM `{rawTitle}` Automatically suggested a site name or empty text
|
|
123
|
-
> - INPUT PARAM `{rawAssigment}` Automatically generated site entry from image recognition
|
|
124
|
-
> - OUTPUT PARAM `{websiteContent}` Web content
|
|
125
|
-
> - OUTPUT PARAM `{keywords}` Keywords
|
|
126
|
-
>
|
|
127
|
-
> ## 👤 Specifying the assigment
|
|
128
|
-
>
|
|
129
|
-
> What is your web about?
|
|
130
|
-
>
|
|
131
|
-
> - DIALOG TEMPLATE
|
|
132
|
-
>
|
|
133
|
-
> ```
|
|
134
|
-
> {rawAssigment}
|
|
135
|
-
> ```
|
|
136
|
-
>
|
|
137
|
-
> `-> {assigment}` Website assignment and specification
|
|
138
|
-
>
|
|
139
|
-
> ## ✨ Improving the title
|
|
140
|
-
>
|
|
141
|
-
> - PERSONA Jane, Copywriter and Marketing Specialist.
|
|
142
|
-
>
|
|
143
|
-
> ```
|
|
144
|
-
> As an experienced marketing specialist, you have been entrusted with improving the name of your client's business.
|
|
145
|
-
>
|
|
146
|
-
> A suggested name from a client:
|
|
147
|
-
> "{rawTitle}"
|
|
148
|
-
>
|
|
149
|
-
> Assignment from customer:
|
|
150
|
-
>
|
|
151
|
-
> > {assigment}
|
|
152
|
-
>
|
|
153
|
-
> ## Instructions:
|
|
154
|
-
>
|
|
155
|
-
> - Write only one name suggestion
|
|
156
|
-
> - The name will be used on the website, business cards, visuals, etc.
|
|
157
|
-
> ```
|
|
158
|
-
>
|
|
159
|
-
> `-> {enhancedTitle}` Enhanced title
|
|
160
|
-
>
|
|
161
|
-
> ## 👤 Website title approval
|
|
162
|
-
>
|
|
163
|
-
> Is the title for your website okay?
|
|
164
|
-
>
|
|
165
|
-
> - DIALOG TEMPLATE
|
|
166
|
-
>
|
|
167
|
-
> ```
|
|
168
|
-
> {enhancedTitle}
|
|
169
|
-
> ```
|
|
170
|
-
>
|
|
171
|
-
> `-> {title}` Title for the website
|
|
172
|
-
>
|
|
173
|
-
> ## 🐰 Cunning subtitle
|
|
174
|
-
>
|
|
175
|
-
> - PERSONA Josh, a copywriter, tasked with creating a claim for the website.
|
|
176
|
-
>
|
|
177
|
-
> ```
|
|
178
|
-
> As an experienced copywriter, you have been entrusted with creating a claim for the "{title}" web page.
|
|
179
|
-
>
|
|
180
|
-
> A website assignment from a customer:
|
|
181
|
-
>
|
|
182
|
-
> > {assigment}
|
|
183
|
-
>
|
|
184
|
-
> ## Instructions:
|
|
185
|
-
>
|
|
186
|
-
> - Write only one name suggestion
|
|
187
|
-
> - Claim will be used on website, business cards, visuals, etc.
|
|
188
|
-
> - Claim should be punchy, funny, original
|
|
189
|
-
> ```
|
|
190
|
-
>
|
|
191
|
-
> `-> {claim}` Claim for the web
|
|
192
|
-
>
|
|
193
|
-
> ## 🚦 Keyword analysis
|
|
194
|
-
>
|
|
195
|
-
> - PERSONA Paul, extremely creative SEO specialist.
|
|
196
|
-
>
|
|
197
|
-
> ```
|
|
198
|
-
> As an experienced SEO specialist, you have been entrusted with creating keywords for the website "{title}".
|
|
199
|
-
>
|
|
200
|
-
> Website assignment from the customer:
|
|
201
|
-
>
|
|
202
|
-
> > {assigment}
|
|
203
|
-
>
|
|
204
|
-
> ## Instructions:
|
|
205
|
-
>
|
|
206
|
-
> - Write a list of keywords
|
|
207
|
-
> - Keywords are in basic form
|
|
208
|
-
>
|
|
209
|
-
> ## Example:
|
|
210
|
-
>
|
|
211
|
-
> - Ice cream
|
|
212
|
-
> - Olomouc
|
|
213
|
-
> - Quality
|
|
214
|
-
> - Family
|
|
215
|
-
> - Tradition
|
|
216
|
-
> - Italy
|
|
217
|
-
> - Craft
|
|
218
|
-
>
|
|
219
|
-
> ```
|
|
220
|
-
>
|
|
221
|
-
> `-> {keywords}` Keywords
|
|
222
|
-
>
|
|
223
|
-
> ## 🔗 Combine the beginning
|
|
224
|
-
>
|
|
225
|
-
> - SIMPLE TEMPLATE
|
|
226
|
-
>
|
|
227
|
-
> ```
|
|
228
|
-
>
|
|
229
|
-
> # {title}
|
|
230
|
-
>
|
|
231
|
-
> > {claim}
|
|
232
|
-
>
|
|
233
|
-
> ```
|
|
234
|
-
>
|
|
235
|
-
> `-> {contentBeginning}` Beginning of web content
|
|
236
|
-
>
|
|
237
|
-
> ## 🖋 Write the content
|
|
238
|
-
>
|
|
239
|
-
> - PERSONA Jane
|
|
240
|
-
>
|
|
241
|
-
> ```
|
|
242
|
-
> As an experienced copywriter and web designer, you have been entrusted with creating text for a new website {title}.
|
|
243
|
-
>
|
|
244
|
-
> A website assignment from a customer:
|
|
245
|
-
>
|
|
246
|
-
> > {assigment}
|
|
247
|
-
>
|
|
248
|
-
> ## Instructions:
|
|
249
|
-
>
|
|
250
|
-
> - Text formatting is in Markdown
|
|
251
|
-
> - Be concise and to the point
|
|
252
|
-
> - Use keywords, but they should be naturally in the text
|
|
253
|
-
> - This is the complete content of the page, so don't forget all the important information and elements the page should contain
|
|
254
|
-
> - Use headings, bullets, text formatting
|
|
255
|
-
>
|
|
256
|
-
> ## Keywords:
|
|
257
|
-
>
|
|
258
|
-
> {keywords}
|
|
259
|
-
>
|
|
260
|
-
> ## Web Content:
|
|
261
|
-
>
|
|
262
|
-
> {contentBeginning}
|
|
263
|
-
> ```
|
|
264
|
-
>
|
|
265
|
-
> `-> {contentBody}` Middle of the web content
|
|
266
|
-
>
|
|
267
|
-
> ## 🔗 Combine the content
|
|
268
|
-
>
|
|
269
|
-
> - SIMPLE TEMPLATE
|
|
270
|
-
>
|
|
271
|
-
> ```markdown
|
|
272
|
-
> {contentBeginning}
|
|
273
|
-
>
|
|
274
|
-
> {contentBody}
|
|
275
|
-
> ```
|
|
276
|
-
>
|
|
277
|
-
> `-> {websiteContent}`
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
Following is the scheme how the promptbook above is executed:
|
|
282
|
-
|
|
283
|
-
```mermaid
|
|
284
|
-
%% 🔮 Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually
|
|
285
|
-
|
|
286
|
-
flowchart LR
|
|
287
|
-
subgraph "🌍 Create website content"
|
|
288
|
-
|
|
289
|
-
direction TB
|
|
290
|
-
|
|
291
|
-
input((Input)):::input
|
|
292
|
-
templateSpecifyingTheAssigment(👤 Specifying the assigment)
|
|
293
|
-
input--"{rawAssigment}"-->templateSpecifyingTheAssigment
|
|
294
|
-
templateImprovingTheTitle(✨ Improving the title)
|
|
295
|
-
input--"{rawTitle}"-->templateImprovingTheTitle
|
|
296
|
-
templateSpecifyingTheAssigment--"{assigment}"-->templateImprovingTheTitle
|
|
297
|
-
templateWebsiteTitleApproval(👤 Website title approval)
|
|
298
|
-
templateImprovingTheTitle--"{enhancedTitle}"-->templateWebsiteTitleApproval
|
|
299
|
-
templateCunningSubtitle(🐰 Cunning subtitle)
|
|
300
|
-
templateWebsiteTitleApproval--"{title}"-->templateCunningSubtitle
|
|
301
|
-
templateSpecifyingTheAssigment--"{assigment}"-->templateCunningSubtitle
|
|
302
|
-
templateKeywordAnalysis(🚦 Keyword analysis)
|
|
303
|
-
templateWebsiteTitleApproval--"{title}"-->templateKeywordAnalysis
|
|
304
|
-
templateSpecifyingTheAssigment--"{assigment}"-->templateKeywordAnalysis
|
|
305
|
-
templateCombineTheBeginning(🔗 Combine the beginning)
|
|
306
|
-
templateWebsiteTitleApproval--"{title}"-->templateCombineTheBeginning
|
|
307
|
-
templateCunningSubtitle--"{claim}"-->templateCombineTheBeginning
|
|
308
|
-
templateWriteTheContent(🖋 Write the content)
|
|
309
|
-
templateWebsiteTitleApproval--"{title}"-->templateWriteTheContent
|
|
310
|
-
templateSpecifyingTheAssigment--"{assigment}"-->templateWriteTheContent
|
|
311
|
-
templateKeywordAnalysis--"{keywords}"-->templateWriteTheContent
|
|
312
|
-
templateCombineTheBeginning--"{contentBeginning}"-->templateWriteTheContent
|
|
313
|
-
templateCombineTheContent(🔗 Combine the content)
|
|
314
|
-
templateCombineTheBeginning--"{contentBeginning}"-->templateCombineTheContent
|
|
315
|
-
templateWriteTheContent--"{contentBody}"-->templateCombineTheContent
|
|
316
|
-
|
|
317
|
-
templateCombineTheContent--"{websiteContent}"-->output
|
|
318
|
-
output((Output)):::output
|
|
319
|
-
|
|
320
|
-
classDef input color: grey;
|
|
321
|
-
classDef output color: grey;
|
|
322
|
-
|
|
323
|
-
end;
|
|
324
|
-
```
|
|
91
|
+
- Versioning is build in. You can test multiple **A/B versions** of pipelines and see which one works best.
|
|
92
|
+
- Promptbook is designed to use [**RAG** (Retrieval-Augmented Generation)](https://github.com/webgptorg/promptbook/discussions/41) and other advanced techniques to bring the context of your business to generic LLM. You can use **knowledge** to improve the quality of the output.
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
## 💙 Book language _(for prompt-engineer)_
|
|
97
|
+
|
|
98
|
+
Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) are written in markdown-like language called [Book](https://github.com/webgptorg/book). It is designed to be understandable by non-programmers and non-technical people.
|
|
325
99
|
|
|
326
|
-
- [More template samples](./samples/pipelines/)
|
|
327
|
-
- [Read more about `.ptbk.md` file format here](https://github.com/webgptorg/promptbook/discussions/categories/concepts?discussions_q=is%3Aopen+label%3A.ptbk.md+category%3AConcepts)
|
|
328
100
|
|
|
329
|
-
_Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
|
|
330
101
|
|
|
331
|
-
|
|
102
|
+
```markdown
|
|
103
|
+
# 🌟 My first Book
|
|
104
|
+
|
|
105
|
+
- PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
|
|
106
|
+
- KNOWLEDGE https://ptbk.io
|
|
107
|
+
- KNOWLEDGE ./promptbook.pdf
|
|
108
|
+
- EXPECT MIN 1 Sentence
|
|
109
|
+
- EXPECT MAX 1 Paragraph
|
|
110
|
+
|
|
111
|
+
> Write an article about the future of artificial intelligence in the next 10 years and how metalanguages will change the way AI is used in the world.
|
|
112
|
+
> Look specifically at the impact of Promptbook on the AI industry.
|
|
113
|
+
|
|
114
|
+
-> {article}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## 📦 Packages _(for developers)_
|
|
332
118
|
|
|
333
119
|
This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
334
120
|
You can install all of them at once:
|
|
@@ -370,8 +156,6 @@ Or you can install them separately:
|
|
|
370
156
|
|
|
371
157
|
The following glossary is used to clarify certain concepts:
|
|
372
158
|
|
|
373
|
-
|
|
374
|
-
|
|
375
159
|
### Core concepts
|
|
376
160
|
|
|
377
161
|
- [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|
|
@@ -402,8 +186,8 @@ The following glossary is used to clarify certain concepts:
|
|
|
402
186
|
|
|
403
187
|
## 🔌 Usage in Typescript / Javascript
|
|
404
188
|
|
|
405
|
-
- [Simple usage](./
|
|
406
|
-
- [Usage with client and remote server](./
|
|
189
|
+
- [Simple usage](./examples/usage/simple-script)
|
|
190
|
+
- [Usage with client and remote server](./examples/usage/remote)
|
|
407
191
|
|
|
408
192
|
## ➕➖ When to use Promptbook?
|
|
409
193
|
|
|
@@ -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 {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
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 {
|
|
23
|
-
import {
|
|
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';
|
|
@@ -66,6 +67,7 @@ import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usag
|
|
|
66
67
|
import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
|
|
67
68
|
import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
|
|
68
69
|
import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
|
|
70
|
+
import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
|
|
69
71
|
import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
|
|
70
72
|
import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
|
|
71
73
|
import { preparePersona } from '../personas/preparePersona';
|
|
@@ -76,6 +78,7 @@ import { unpreparePipeline } from '../prepare/unpreparePipeline';
|
|
|
76
78
|
import { prepareKnowledgePieces } from '../scrapers/_common/prepareKnowledgePieces';
|
|
77
79
|
import { $scrapersMetadataRegister } from '../scrapers/_common/register/$scrapersMetadataRegister';
|
|
78
80
|
import { $scrapersRegister } from '../scrapers/_common/register/$scrapersRegister';
|
|
81
|
+
import { makeKnowledgeSourceHandler } from '../scrapers/_common/utils/makeKnowledgeSourceHandler';
|
|
79
82
|
import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
|
|
80
83
|
import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
|
|
81
84
|
import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
|
|
@@ -97,20 +100,21 @@ export { createSubcollection };
|
|
|
97
100
|
export type { TemplateType };
|
|
98
101
|
export { TemplateTypes };
|
|
99
102
|
export { CLAIM };
|
|
100
|
-
export { MAX_PARALLEL_COUNT };
|
|
101
|
-
export { MAX_EXECUTION_ATTEMPTS };
|
|
102
103
|
export { MAX_FILENAME_LENGTH };
|
|
103
|
-
export {
|
|
104
|
-
export {
|
|
105
|
-
export {
|
|
106
|
-
export {
|
|
107
|
-
export {
|
|
104
|
+
export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
|
|
105
|
+
export { DEFAULT_MAX_PARALLEL_COUNT };
|
|
106
|
+
export { DEFAULT_MAX_EXECUTION_ATTEMPTS };
|
|
107
|
+
export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
|
|
108
|
+
export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
|
|
109
|
+
export { DEFAULT_EXECUTIONS_CACHE_DIRNAME };
|
|
110
|
+
export { DEFAULT_SCRAPE_CACHE_DIRNAME };
|
|
111
|
+
export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
|
|
108
112
|
export { RESERVED_PARAMETER_NAMES };
|
|
109
113
|
export { DEFAULT_REMOTE_URL };
|
|
110
114
|
export { DEFAULT_REMOTE_URL_PATH };
|
|
111
115
|
export { DEFAULT_CSV_SETTINGS };
|
|
112
|
-
export {
|
|
113
|
-
export {
|
|
116
|
+
export { DEFAULT_IS_VERBOSE };
|
|
117
|
+
export { DEFAULT_IS_AUTO_INSTALLED };
|
|
114
118
|
export { pipelineJsonToString };
|
|
115
119
|
export { pipelineStringToJson };
|
|
116
120
|
export { pipelineStringToJsonSync };
|
|
@@ -156,6 +160,7 @@ export { limitTotalUsage };
|
|
|
156
160
|
export { _AnthropicClaudeMetadataRegistration };
|
|
157
161
|
export { _AzureOpenAiMetadataRegistration };
|
|
158
162
|
export { joinLlmExecutionTools };
|
|
163
|
+
export { MultipleLlmExecutionTools };
|
|
159
164
|
export { _OpenAiMetadataRegistration };
|
|
160
165
|
export { _OpenAiAssistantMetadataRegistration };
|
|
161
166
|
export { preparePersona };
|
|
@@ -166,6 +171,7 @@ export { unpreparePipeline };
|
|
|
166
171
|
export { prepareKnowledgePieces };
|
|
167
172
|
export { $scrapersMetadataRegister };
|
|
168
173
|
export { $scrapersRegister };
|
|
174
|
+
export { makeKnowledgeSourceHandler };
|
|
169
175
|
export { _LegacyDocumentScraperMetadataRegistration };
|
|
170
176
|
export { _DocumentScraperMetadataRegistration };
|
|
171
177
|
export { _MarkdownScraperMetadataRegistration };
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { PROMPTBOOK_VERSION } from '../version';
|
|
2
2
|
import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
|
|
3
|
+
import { $provideExecutablesForNode } from '../executables/$provideExecutablesForNode';
|
|
3
4
|
import { $provideExecutionToolsForNode } from '../execution/utils/$provideExecutionToolsForNode';
|
|
4
5
|
import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv';
|
|
5
6
|
import { $provideLlmToolsFromEnv } from '../llm-providers/_common/register/$provideLlmToolsFromEnv';
|
|
@@ -10,6 +11,7 @@ import { $execCommand } from '../utils/execCommand/$execCommand';
|
|
|
10
11
|
import { $execCommands } from '../utils/execCommand/$execCommands';
|
|
11
12
|
export { PROMPTBOOK_VERSION };
|
|
12
13
|
export { createCollectionFromDirectory };
|
|
14
|
+
export { $provideExecutablesForNode };
|
|
13
15
|
export { $provideExecutionToolsForNode };
|
|
14
16
|
export { $provideLlmToolsConfigurationFromEnv };
|
|
15
17
|
export { $provideLlmToolsFromEnv };
|
|
@@ -14,11 +14,12 @@ import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
|
|
|
14
14
|
import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
|
|
15
15
|
import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
|
|
16
16
|
import type { ErrorJson } from '../errors/utils/ErrorJson';
|
|
17
|
+
import type { LocateAppOptions } from '../executables/locateApp';
|
|
17
18
|
import type { AvailableModel } from '../execution/AvailableModel';
|
|
18
19
|
import type { CommonToolsOptions } from '../execution/CommonToolsOptions';
|
|
19
20
|
import type { CreatePipelineExecutorOptions } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorOptions';
|
|
20
|
-
import type { CreatePipelineExecutorSettings } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorSettings';
|
|
21
21
|
import type { EmbeddingVector } from '../execution/EmbeddingVector';
|
|
22
|
+
import type { Executables } from '../execution/Executables';
|
|
22
23
|
import type { ExecutionTools } from '../execution/ExecutionTools';
|
|
23
24
|
import type { FilesystemTools } from '../execution/FilesystemTools';
|
|
24
25
|
import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
|
|
@@ -49,7 +50,6 @@ import type { AnthropicClaudeExecutionToolsDirectOptions } from '../llm-provider
|
|
|
49
50
|
import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
|
|
50
51
|
import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions';
|
|
51
52
|
import type { LangtailExecutionToolsOptions } from '../llm-providers/langtail/LangtailExecutionToolsOptions';
|
|
52
|
-
import type { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
|
|
53
53
|
import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
|
|
54
54
|
import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
|
|
55
55
|
import type { PromptbookServer_Error } from '../llm-providers/remote/interfaces/PromptbookServer_Error';
|
|
@@ -66,6 +66,7 @@ import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/int
|
|
|
66
66
|
import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
67
67
|
import type { AnonymousRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
68
68
|
import type { CollectionRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
69
|
+
import type { CollectionRemoteServerClientOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
69
70
|
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
70
71
|
import type { Converter } from '../scrapers/_common/Converter';
|
|
71
72
|
import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
|
|
@@ -81,6 +82,7 @@ import type { ExecutionPromptReportJson } from '../types/execution-report/Execut
|
|
|
81
82
|
import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
|
|
82
83
|
import type { ExecutionReportString } from '../types/execution-report/ExecutionReportString';
|
|
83
84
|
import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
|
|
85
|
+
import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
|
|
84
86
|
import type { ModelRequirements } from '../types/ModelRequirements';
|
|
85
87
|
import type { CompletionModelRequirements } from '../types/ModelRequirements';
|
|
86
88
|
import type { ChatModelRequirements } from '../types/ModelRequirements';
|
|
@@ -162,13 +164,13 @@ import type { string_url_image } from '../types/typeAliases';
|
|
|
162
164
|
import type { string_executable_path } from '../types/typeAliases';
|
|
163
165
|
import type { string_uri } from '../types/typeAliases';
|
|
164
166
|
import type { string_uri_part } from '../types/typeAliases';
|
|
165
|
-
import type { string_uriid } from '../types/typeAliases';
|
|
166
167
|
import type { string_hostname } from '../types/typeAliases';
|
|
167
168
|
import type { string_host } from '../types/typeAliases';
|
|
168
169
|
import type { string_protocol } from '../types/typeAliases';
|
|
169
170
|
import type { string_email } from '../types/typeAliases';
|
|
170
171
|
import type { string_emails } from '../types/typeAliases';
|
|
171
172
|
import type { string_uuid } from '../types/typeAliases';
|
|
173
|
+
import type { string_app_id } from '../types/typeAliases';
|
|
172
174
|
import type { string_user_id } from '../types/typeAliases';
|
|
173
175
|
import type { string_sha256 } from '../types/typeAliases';
|
|
174
176
|
import type { string_semantic_version } from '../types/typeAliases';
|
|
@@ -191,6 +193,7 @@ import type { string_translate_name_not_normalized } from '../types/typeAliases'
|
|
|
191
193
|
import type { string_translate_language } from '../types/typeAliases';
|
|
192
194
|
import type { string_javascript_name } from '../types/typeAliases';
|
|
193
195
|
import type { string_postprocessing_function_name } from '../types/typeAliases';
|
|
196
|
+
import type { id } from '../types/typeAliases';
|
|
194
197
|
import type { string_token } from '../types/typeAliases';
|
|
195
198
|
import type { string_license_token } from '../types/typeAliases';
|
|
196
199
|
import type { string_password } from '../types/typeAliases';
|
|
@@ -223,13 +226,13 @@ import type { number_gigabytes } from '../types/typeAliases';
|
|
|
223
226
|
import type { number_terabytes } from '../types/typeAliases';
|
|
224
227
|
import type { Registered } from '../utils/$Register';
|
|
225
228
|
import type { Registration } from '../utils/$Register';
|
|
226
|
-
import type {
|
|
227
|
-
import type {
|
|
229
|
+
import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
|
|
230
|
+
import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
|
|
228
231
|
import type { FromtoItems } from '../utils/FromtoItems';
|
|
229
232
|
import type { CodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
|
|
230
233
|
import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
|
|
231
234
|
import type { string_keyword } from '../utils/normalization/IKeywords';
|
|
232
|
-
import type {
|
|
235
|
+
import type { Keywords } from '../utils/normalization/IKeywords';
|
|
233
236
|
import type { string_kebab_case } from '../utils/normalization/normalize-to-kebab-case';
|
|
234
237
|
import type { string_camelCase } from '../utils/normalization/normalizeTo_camelCase';
|
|
235
238
|
import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
|
|
@@ -255,11 +258,12 @@ export type { PrettifyOptions };
|
|
|
255
258
|
export type { renderPipelineMermaidOptions };
|
|
256
259
|
export type { CallbackInterfaceToolsOptions };
|
|
257
260
|
export type { ErrorJson };
|
|
261
|
+
export type { LocateAppOptions };
|
|
258
262
|
export type { AvailableModel };
|
|
259
263
|
export type { CommonToolsOptions };
|
|
260
264
|
export type { CreatePipelineExecutorOptions };
|
|
261
|
-
export type { CreatePipelineExecutorSettings };
|
|
262
265
|
export type { EmbeddingVector };
|
|
266
|
+
export type { Executables };
|
|
263
267
|
export type { ExecutionTools };
|
|
264
268
|
export type { FilesystemTools };
|
|
265
269
|
export type { LlmExecutionTools };
|
|
@@ -290,7 +294,6 @@ export type { AnthropicClaudeExecutionToolsDirectOptions };
|
|
|
290
294
|
export type { AnthropicClaudeExecutionToolsProxiedOptions };
|
|
291
295
|
export type { AzureOpenAiExecutionToolsOptions };
|
|
292
296
|
export type { LangtailExecutionToolsOptions };
|
|
293
|
-
export type { MultipleLlmExecutionTools };
|
|
294
297
|
export type { OpenAiAssistantExecutionToolsOptions };
|
|
295
298
|
export type { OpenAiExecutionToolsOptions };
|
|
296
299
|
export type { PromptbookServer_Error };
|
|
@@ -307,6 +310,7 @@ export type { RemoteLlmExecutionToolsOptions };
|
|
|
307
310
|
export type { RemoteServerOptions };
|
|
308
311
|
export type { AnonymousRemoteServerOptions };
|
|
309
312
|
export type { CollectionRemoteServerOptions };
|
|
313
|
+
export type { CollectionRemoteServerClientOptions };
|
|
310
314
|
export type { PrepareAndScrapeOptions };
|
|
311
315
|
export type { Converter };
|
|
312
316
|
export type { ScraperAndConverterMetadata };
|
|
@@ -322,6 +326,7 @@ export type { ExecutionPromptReportJson };
|
|
|
322
326
|
export type { ExecutionReportJson };
|
|
323
327
|
export type { ExecutionReportString };
|
|
324
328
|
export type { ExecutionReportStringOptions };
|
|
329
|
+
export type { IntermediateFilesStrategy };
|
|
325
330
|
export type { ModelRequirements };
|
|
326
331
|
export type { CompletionModelRequirements };
|
|
327
332
|
export type { ChatModelRequirements };
|
|
@@ -403,13 +408,13 @@ export type { string_url_image };
|
|
|
403
408
|
export type { string_executable_path };
|
|
404
409
|
export type { string_uri };
|
|
405
410
|
export type { string_uri_part };
|
|
406
|
-
export type { string_uriid };
|
|
407
411
|
export type { string_hostname };
|
|
408
412
|
export type { string_host };
|
|
409
413
|
export type { string_protocol };
|
|
410
414
|
export type { string_email };
|
|
411
415
|
export type { string_emails };
|
|
412
416
|
export type { string_uuid };
|
|
417
|
+
export type { string_app_id };
|
|
413
418
|
export type { string_user_id };
|
|
414
419
|
export type { string_sha256 };
|
|
415
420
|
export type { string_semantic_version };
|
|
@@ -432,6 +437,7 @@ export type { string_translate_name_not_normalized };
|
|
|
432
437
|
export type { string_translate_language };
|
|
433
438
|
export type { string_javascript_name };
|
|
434
439
|
export type { string_postprocessing_function_name };
|
|
440
|
+
export type { id };
|
|
435
441
|
export type { string_token };
|
|
436
442
|
export type { string_license_token };
|
|
437
443
|
export type { string_password };
|
|
@@ -464,13 +470,13 @@ export type { number_gigabytes };
|
|
|
464
470
|
export type { number_terabytes };
|
|
465
471
|
export type { Registered };
|
|
466
472
|
export type { Registration };
|
|
467
|
-
export type {
|
|
468
|
-
export type {
|
|
473
|
+
export type { ExecCommandOptions };
|
|
474
|
+
export type { ExecCommandOptionsAdvanced };
|
|
469
475
|
export type { FromtoItems };
|
|
470
476
|
export type { CodeBlock };
|
|
471
477
|
export type { MarkdownSection };
|
|
472
478
|
export type { string_keyword };
|
|
473
|
-
export type {
|
|
479
|
+
export type { Keywords };
|
|
474
480
|
export type { string_kebab_case };
|
|
475
481
|
export type { string_camelCase };
|
|
476
482
|
export type { string_PascalCase };
|
|
@@ -24,7 +24,7 @@ import { capitalize } from '../utils/normalization/capitalize';
|
|
|
24
24
|
import { decapitalize } from '../utils/normalization/decapitalize';
|
|
25
25
|
import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
|
|
26
26
|
import type { string_keyword } from '../utils/normalization/IKeywords';
|
|
27
|
-
import type {
|
|
27
|
+
import type { Keywords } from '../utils/normalization/IKeywords';
|
|
28
28
|
import { isValidKeyword } from '../utils/normalization/isValidKeyword';
|
|
29
29
|
import { nameToUriPart } from '../utils/normalization/nameToUriPart';
|
|
30
30
|
import { nameToUriParts } from '../utils/normalization/nameToUriParts';
|
|
@@ -95,7 +95,7 @@ export { capitalize };
|
|
|
95
95
|
export { decapitalize };
|
|
96
96
|
export { DIACRITIC_VARIANTS_LETTERS };
|
|
97
97
|
export type { string_keyword };
|
|
98
|
-
export type {
|
|
98
|
+
export type { Keywords };
|
|
99
99
|
export { isValidKeyword };
|
|
100
100
|
export { nameToUriPart };
|
|
101
101
|
export { nameToUriParts };
|
|
@@ -19,11 +19,11 @@ export declare class SimplePipelineCollection implements PipelineCollection {
|
|
|
19
19
|
* Note: During the construction logic of all pipelines are validated
|
|
20
20
|
* Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
|
|
21
21
|
*/
|
|
22
|
-
constructor(...pipelines:
|
|
22
|
+
constructor(...pipelines: ReadonlyArray<PipelineJson>);
|
|
23
23
|
/**
|
|
24
24
|
* Gets all pipelines in the collection
|
|
25
25
|
*/
|
|
26
|
-
listPipelines():
|
|
26
|
+
listPipelines(): ReadonlyArray<string_pipeline_url>;
|
|
27
27
|
/**
|
|
28
28
|
* Gets pipeline by its URL
|
|
29
29
|
*
|
|
@@ -7,7 +7,7 @@ import type { PipelineCollection } from './PipelineCollection';
|
|
|
7
7
|
*
|
|
8
8
|
* @public exported from `@promptbook/core`
|
|
9
9
|
*/
|
|
10
|
-
export declare function collectionToJson(collection: PipelineCollection): Promise<
|
|
10
|
+
export declare function collectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<PipelineJson>>;
|
|
11
11
|
/**
|
|
12
12
|
* TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
|
|
13
13
|
*/
|