@promptbook/openai 0.52.0-2 → 0.52.0-4

package/README.md

@@ -34,7 +34,45 @@ Wrapper around [OpenAI's SDK](https://www.npmjs.com/package/openai) to make it e
 
 
 
+## Usage
 
+```typescript
+import { createPromptbookExecutor, createPromptbookLibraryFromDirectory } from '@promptbook/core';
+import { JavascriptEvalExecutionTools } from '@promptbook/execute-javascript';
+import { OpenAiExecutionTools } from '@promptbook/openai';
+import { assertsExecutionSuccessful } from '@promptbook/utils';
+
+// TODO: !!!!! Test that this code works
+// TODO: !!!!! Comment
+
+const library = createPromptbookLibraryFromDirectory('./promptbook');
+const promptbook = library.getPromptbookByUrl(`https://promptbook.studio/my-library/write-article.ptbk.md`);
+
+const tools = {
+    llm: new OpenAiExecutionTools({
+        apiKey: process.env.OPENAI_API_KEY,
+    }),
+    script: [new JavascriptEvalExecutionTools()],
+};
+
+const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
+
+const inputParameters = { word: 'cat' };
+const { isSuccessful, errors, outputParameters, executionReport } = await promptbookExecutor(inputParameters);
+
+console.info(outputParameters);
+
+assertsExecutionSuccessful({ isSuccessful, errors });
+```
+
+
+
+## Other models
+
+See the other models available in the Promptbook package:
+
+-   [Azure OpenAI](https://www.npmjs.com/package/@promptbook/azure-openai)
+-   [Anthropic Claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)
 
 
 ---
@@ -493,9 +531,10 @@ Internally it calls OpenAI, Azure, GPU, proxy, cache, logging,...
 -   _(Not implemented yet)_ `BardExecutionTools`
 -   _(Not implemented yet)_ `LamaExecutionTools`
 -   _(Not implemented yet)_ `GpuExecutionTools`
--   And a special case are `RemoteLlmExecutionTools` that connect to a remote server and run one of the above execution tools on that server.
--   The second special case is `MockedEchoLlmExecutionTools` that is used for testing and mocking.
--   The third special case is `LogLlmExecutionToolsWrapper` that is technically also an execution tools but it is more proxy wrapper around other execution tools that logs all calls to execution tools.
+-   And a special case are `MultipleLlmExecutionTools` that combines multiple execution tools together and tries to execute the prompt on the best one.
+-   Another special case are `RemoteLlmExecutionTools` that connect to a remote server and run one of the above execution tools on that server.
+-   The another special case is `MockedEchoLlmExecutionTools` that is used for testing and mocking.
+-   The another special case is `LogLlmExecutionToolsWrapper` that is technically also an execution tools but it is more proxy wrapper around other execution tools that logs all calls to execution tools.
 
 #### Script Execution Tools
 
@@ -594,6 +633,8 @@ Execution report is a simple object or markdown that contains information about
 
 
 
+
+
 ### Remote server
 
 Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.

package/esm/typings/_packages/core.index.d.ts

@@ -11,9 +11,10 @@ import { createPromptbookLibraryFromSources } from '../library/constructors/crea
 import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
 import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
+import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookStringToJson, promptbookJsonToString, validatePromptbookJson };
-export { createPromptbookExecutor };
+export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

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

@@ -35,6 +35,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
+ * 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

@@ -25,6 +25,10 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
      * Calls Azure OpenAI API to use a complete model.
      */
     gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * Changes Azure error (which is not propper Error but object) to propper Error
+     */
+    private transformAzureError;
     /**
      * List all available Azure OpenAI models that can be used
      */

package/esm/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools.d.ts

@@ -0,0 +1,35 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
+ *
+ * @see https://github.com/webgptorg/promptbook#multiple-server
+ */
+export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
+    /**
+     * Array of execution tools in order of priority
+     */
+    private llmExecutionTools;
+    /**
+     * Gets array of execution tools in order of priority
+     */
+    constructor(...llmExecutionTools: Array<LlmExecutionTools>);
+    /**
+     * Calls the best available chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls the best available completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Calls the best available model
+     */
+    private gptCommon;
+    /**
+     * List all available models that can be used
+     * This liost is a combination of all available models from all execution tools
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+}

package/esm/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionToolsOptions.d.ts

@@ -0,0 +1,23 @@
+import type { client_id, string_uri } from '../../../../types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for MultipleLlmExecutionTools
+ */
+export type MultipleLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * URL of the multiple PROMPTBOOK server
+     * On this server will be connected to the socket.io server
+     */
+    readonly multipleUrl: URL;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
+     * Your client ID
+     */
+    readonly clientId: client_id;
+};

package/esm/typings/execution/plugins/llm-execution-tools/multiple/playground/playground.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts

@@ -8,7 +8,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
+    constructor(options?: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts

@@ -7,7 +7,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
  */
 export declare class JavascriptExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
+    constructor(options?: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */

package/package.json

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

package/umd/typings/_packages/core.index.d.ts

@@ -11,9 +11,10 @@ import { createPromptbookLibraryFromSources } from '../library/constructors/crea
 import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
 import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
+import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookStringToJson, promptbookJsonToString, validatePromptbookJson };
-export { createPromptbookExecutor };
+export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

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

@@ -35,6 +35,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
+ * 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

@@ -25,6 +25,10 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
      * Calls Azure OpenAI API to use a complete model.
      */
     gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * Changes Azure error (which is not propper Error but object) to propper Error
+     */
+    private transformAzureError;
     /**
      * List all available Azure OpenAI models that can be used
      */

package/umd/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools.d.ts

@@ -0,0 +1,35 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
+ *
+ * @see https://github.com/webgptorg/promptbook#multiple-server
+ */
+export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
+    /**
+     * Array of execution tools in order of priority
+     */
+    private llmExecutionTools;
+    /**
+     * Gets array of execution tools in order of priority
+     */
+    constructor(...llmExecutionTools: Array<LlmExecutionTools>);
+    /**
+     * Calls the best available chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls the best available completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Calls the best available model
+     */
+    private gptCommon;
+    /**
+     * List all available models that can be used
+     * This liost is a combination of all available models from all execution tools
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+}

package/umd/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionToolsOptions.d.ts

@@ -0,0 +1,23 @@
+import type { client_id, string_uri } from '../../../../types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for MultipleLlmExecutionTools
+ */
+export type MultipleLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * URL of the multiple PROMPTBOOK server
+     * On this server will be connected to the socket.io server
+     */
+    readonly multipleUrl: URL;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
+     * Your client ID
+     */
+    readonly clientId: client_id;
+};

package/umd/typings/execution/plugins/llm-execution-tools/multiple/playground/playground.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts

@@ -8,7 +8,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
+    constructor(options?: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */

package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts

@@ -7,7 +7,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
  */
 export declare class JavascriptExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
+    constructor(options?: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */