@promptbook/cli 0.60.0-4 → 0.60.0-5

package/README.md

@@ -47,14 +47,14 @@ This will emit `index.ts` with `getPipelineCollection` function file in `promptb
 Then just use it:
 
 ```typescript
-import { createPromptbookExecutor, assertsExecutionSuccessful } from '@promptbook/core';
+import { createPipelineExecutor, assertsExecutionSuccessful } from '@promptbook/core';
 import { getPipelineCollection } from './promptbook-collection'; // <- Importing from pre-built library
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 
-// ▶ Get one Promptbook
+// ▶ Get single Pipeline
 const promptbook = await getPipelineCollection().getPipelineByUrl(
-    `https://promptbook.studio/my-library/write-article.ptbk.md`,
+    `https://promptbook.studio/my-collection/write-article.ptbk.md`,
 );
 
 // ▶ Prepare tools
@@ -66,14 +66,14 @@ const tools = {
     script: [new JavascriptExecutionTools()],
 };
 
-// ▶ Create executor - the function that will execute the Promptbook
-const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
+// ▶ Create executor - the function that will execute the Pipeline
+const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
 
 // ▶ Prepare input parameters
 const inputParameters = { word: 'cat' };
 
-// 🚀▶ Execute the Promptbook
-const result = await promptbookExecutor(inputParameters);
+// 🚀▶ Execute the Pipeline
+const result = await pipelineExecutor(inputParameters);
 
 // ▶ Fail if the execution was not successful
 assertsExecutionSuccessful(result);
@@ -83,7 +83,7 @@ const { isSuccessful, errors, outputParameters, executionReport } = result;
 console.info(outputParameters);
 ```
 
-This is simmilar to compilation process, during the build time the `promptbook make` command will check promptbooks for errors, convert them to the more optimized format and build knowledge base (RAG) for the library.
+This is simmilar to compilation process, during the build time the `promptbook make` command will check promptbooks for errors, convert them to the more optimized format and build knowledge base (RAG) for the pipeline collection.
 
 There is also a javascript and json format available.
 
@@ -100,8 +100,6 @@ This will prettify all promptbooks in `promptbook` directory and adds Mermaid gr
 
 Rest of the documentation is common for **entire promptbook ecosystem**:
 
-
-
 ## 🤍 The Promptbook Whitepaper
 
 When you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how it is integrated. Whether it's the direct calling of a REST API, using the SDK, hardcoding the prompt in the source code, or importing a text file, the process remains the same.
@@ -146,7 +144,7 @@ File `write-website-content.ptbk.md`:
 >
 > Instructions for creating web page content.
 >
-> -   PROMPTBOOK URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
+> -   PIPELINE URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
 > -   PROMPTBOOK VERSION 0.0.1
 > -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
 > -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
@@ -500,7 +498,7 @@ Internally it can have multiple formats:
 ### Promptbook **Library**
 
 Library of all promptbooks used in your application.
-Each promptbook is a separate `.ptbk.md` file with unique `PROMPTBOOK URL`. Theese urls are used to reference promptbooks in other promptbooks or in the application code.
+Each promptbook is a separate `.ptbk.md` file with unique `PIPELINE URL`. Theese urls are used to reference promptbooks in other promptbooks or in the application code.
 
 ### Prompt Result
 
@@ -638,7 +636,7 @@ Look at [expectations.ptbk.md](samples/templates/45-expectations.ptbk.md) and [e
 
 ### Execution report
 
-Execution report is a simple object or markdown that contains information about the execution of the promptbook.
+Execution report is a simple object or markdown that contains information about the execution of the pipeline.
 
 [See the example of such a report](/samples/templates/50-advanced.report.md)