@promptbook/openai 0.52.0-29 → 0.52.0-30

package/README.md

@@ -30,11 +30,9 @@ npm i ptbk
 npm i @promptbook/openai
 ```
 
-Wrapper around [OpenAI's SDK](https://www.npmjs.com/package/openai) to make it easier to use inside Promptbooks.
+`@promptbook/openai` integrates [OpenAI's API](https://openai.com/) with [Promptbook](https://github.com/webgptorg/promptbook). It allows to execute Promptbooks with OpenAI GPT models.
 
-
-
-## Usage
+## 🧡 Usage
 
 ```typescript
 import {
@@ -45,13 +43,13 @@ import {
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 
-// Create whole Promptbook library
+// ▶ Create whole Promptbook library
 const library = await createPromptbookLibraryFromDirectory('./promptbook-library');
 
-// Get one Promptbook
+// ▶ Get one Promptbook
 const promptbook = await library.getPromptbookByUrl(`https://promptbook.studio/my-library/write-article.ptbk.md`);
 
-// Prepare tools
+// ▶ Prepare tools
 const tools = {
     llm: new OpenAiExecutionTools({
         apiKey: process.env.OPENAI_API_KEY,
@@ -59,26 +57,79 @@ const tools = {
     script: [new JavascriptExecutionTools()],
 };
 
-// Create executor - the function that will execute the Promptbook
+// ▶ Create executor - the function that will execute the Promptbook
 const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
 
-// Prepare input parameters
+// ▶ Prepare input parameters
 const inputParameters = { word: 'cat' };
 
-// 🚀 Execute the Promptbook
+// 🚀▶ Execute the Promptbook
 const result = await promptbookExecutor(inputParameters);
 
-// Fail if the execution was not successful
+// ▶ Fail if the execution was not successful
 assertsExecutionSuccessful(result);
 
-// Handle the result
+// ▶ Handle the result
 const { isSuccessful, errors, outputParameters, executionReport } = result;
 console.info(outputParameters);
 ```
 
+## 💕 Usage of multiple LLM providers
+
+You can use multiple LLM providers in one Promptbook execution. The best model will be chosen automatically according to the prompt and the model's capabilities.
+
+```typescript
+import {
+    createPromptbookExecutor,
+    createPromptbookLibraryFromDirectory,
+    assertsExecutionSuccessful,
+} from '@promptbook/core';
+import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
+import { OpenAiExecutionTools } from '@promptbook/openai';
+
+// ▶ Create whole Promptbook library
+const library = await createPromptbookLibraryFromDirectory('./promptbook-library');
+
+// ▶ Get one Promptbook
+const promptbook = await library.getPromptbookByUrl(`https://promptbook.studio/my-library/write-article.ptbk.md`);
+
+// ▶ Prepare tools
+const tools = new MultipleLlmExecutionTools(
+    // Note: You can use multiple LLM providers in one Promptbook execution. The best model will be chosen automatically according to the prompt and the model's capabilities.
+    new OpenAiExecutionTools({
+        isVerbose: true,
+        apiKey: process.env.OPENAI_API_KEY,
+    }),
+    new AnthropicClaudeExecutionTools({
+        isVerbose: true,
+        apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
+    }),
+    new AzureOpenAiExecutionTools({
+        isVerbose: true,
+        resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,
+        deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,
+        apiKey: process.env.AZUREOPENAI_API_KEY,
+    }),
+);
 
+// ▶ Create executor - the function that will execute the Promptbook
+const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
 
-## Other models
+// ▶ Prepare input parameters
+const inputParameters = { word: 'cat' };
+
+// 🚀▶ Execute the Promptbook
+const result = await promptbookExecutor(inputParameters);
+
+// ▶ Fail if the execution was not successful
+assertsExecutionSuccessful(result);
+
+// ▶ Handle the result
+const { isSuccessful, errors, outputParameters, executionReport } = result;
+console.info(outputParameters);
+```
+
+## 💙 Integration with other models
 
 See the other models available in the Promptbook package:
 
@@ -86,6 +137,8 @@ See the other models available in the Promptbook package:
 -   [Anthropic Claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)
 
 
+
+
 ---
 
 Rest of the documentation is common for **entire promptbook ecosystem**:

package/esm/index.es.js

@@ -675,7 +675,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
     return OpenAiExecutionTools;
 }());
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -36,7 +36,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
 }
 /**
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
- * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -35,7 +35,6 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom AzureOpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -5,6 +5,3 @@ import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
  */
 export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
-/**
- * TODO: [🍓][♐] Allow to list the available prompts in Langtail
- */

package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -39,7 +39,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -35,6 +35,6 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.52.0-29",
+    "version": "0.52.0-30",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -48,7 +48,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.52.0-29"
+        "@promptbook/core": "0.52.0-30"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -683,7 +683,7 @@
         return OpenAiExecutionTools;
     }());
     /**
-     * TODO: [🍓][♐] Allow to list compatible models with each variant
+     * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
      * TODO: Maybe Create some common util for gptChat and gptComplete
      * TODO: Maybe make custom OpenaiError
      */

package/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -36,7 +36,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
 }
 /**
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
- * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/umd/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -35,7 +35,6 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom AzureOpenaiError
  */

package/umd/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -5,6 +5,3 @@ import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
  */
 export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
-/**
- * TODO: [🍓][♐] Allow to list the available prompts in Langtail
- */

package/umd/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -39,7 +39,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/umd/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -35,6 +35,6 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */