@promptbook/core 0.52.0-1 → 0.52.0-3

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/_packages/openai.index.d.ts

@@ -1,4 +1,4 @@
-import { OPENAI_MODELS } from '../execution/plugins/llm-execution-tools/openai/models';
+import { OPENAI_MODELS } from '../execution/plugins/llm-execution-tools/openai/openai-models';
 import { OpenAiExecutionTools } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools';
 import { OpenAiExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions';
 export { OPENAI_MODELS, OpenAiExecutionTools, OpenAiExecutionToolsOptions };

package/esm/typings/execution/PromptResult.d.ts

@@ -23,7 +23,7 @@ export type PromptCommonResult = {
     /**
      * Name of the model used to generate the response
      */
-    readonly model: string_model_name;
+    readonly modelName: string_model_name;
     /**
      * Timing
      */
@@ -54,11 +54,11 @@ export type PromptCommonResult = {
         /**
          * Number of tokens used in the input aka. `prompt_tokens`
          */
-        inputTokens: number_tokens;
+        inputTokens: number_tokens | 'UNKNOWN';
         /**
          * Number of tokens used in the output aka. `completion_tokens`
          */
-        outputTokens: number_tokens;
+        outputTokens: number_tokens | 'UNKNOWN';
     };
     /**
      * Raw response from the model

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

@@ -0,0 +1,42 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { AnthropicClaudeExecutionToolsOptions } from './AnthropicClaudeExecutionToolsOptions';
+/**
+ * Execution Tools for calling Anthropic Claude API.
+ */
+export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    /**
+     * Anthropic Claude API client.
+     */
+    private readonly client;
+    /**
+     * Creates Anthropic Claude Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the Anthropic Claude client
+     */
+    constructor(options: AnthropicClaudeExecutionToolsOptions);
+    /**
+     * Calls Anthropic Claude API to use a chat model.
+     */
+    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    /**
+     * Calls Anthropic Claude API to use a complete model.
+     */
+    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * Default model for chat variant.
+     */
+    private getDefaultChatModel;
+    /**
+     * List all available Anthropic Claude models that can be used
+     */
+    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/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts

@@ -0,0 +1,8 @@
+import type { ClientOptions } from '@anthropic-ai/sdk';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for AnthropicClaudeExecutionTools
+ *
+ * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
+ */
+export type AnthropicClaudeExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions;

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

@@ -0,0 +1,20 @@
+import { number_usd } from '../../../../types/typeAliases';
+import type { AvailableModel } from '../../../LlmExecutionTools';
+/**
+ * List of available Anthropic Claude models with pricing
+ *
+ * Note: Done at 2024-05-25
+ *
+ * @see https://docs.anthropic.com/en/docs/models-overview
+ */
+export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
+    pricing?: {
+        prompt: number_usd;
+        output: number_usd;
+    };
+}>;
+/**
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
+ * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ */

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

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

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

@@ -0,0 +1,41 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { AzureOpenAiExecutionToolsOptions } from './AzureOpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling Azure OpenAI API.
+ */
+export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    /**
+     * OpenAI Azure API client.
+     */
+    private readonly client;
+    /**
+     * Creates OpenAI Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI client
+     */
+    constructor(options: AzureOpenAiExecutionToolsOptions);
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    /**
+     * 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
+     */
+    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/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts

@@ -0,0 +1,34 @@
+import { string_name, string_token } from '../../../../types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for AzureOpenAiExecutionTools
+ *
+ * @see https://oai.azure.com/portal/
+ */
+export type AzureOpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * The resource name of the Azure OpenAI resource
+     *
+     * Note: Typically you have one resource and multiple deployments.
+     */
+    resourceName: string_name;
+    /**
+     * The deployment name
+     *
+     * Note: If you specify modelName in prompt, it will be used instead of deploymentName
+     * Note: This is kind of a modelName in OpenAI terms
+     * Note: Typically you have one resource and multiple deployments.
+     */
+    deploymentName: string_name;
+    /**
+     * The API key of the Azure OpenAI resource
+     */
+    apiKey: string_token;
+    /**
+     * A unique identifier representing your end-user, which can help Azure OpenAI to monitor
+     * and detect abuse.
+     *
+     * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids (document from OpenAI not Azure, but same concept)
+     */
+    user?: string_token;
+};

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

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

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

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

package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -11,11 +11,11 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     /**
      * Mocks chat model
      */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
     /**
      * Mocks completion model
      */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
      * List all available mocked-models that can be used
      */

package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -11,11 +11,11 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     /**
      * Fakes chat model
      */
-    gptChat(prompt: Prompt): Promise<PromptChatResult & PromptCompletionResult>;
+    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptChatResult & PromptCompletionResult>;
     /**
      * Fakes completion model
      */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptCompletionResult>;
     /**
      * List all available fake-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/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -10,7 +10,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * OpenAI API client.
      */
-    private readonly openai;
+    private readonly client;
     /**
      * Creates OpenAI Execution Tools.
      *
@@ -20,11 +20,11 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a chat model.
      */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
     /**
      * Calls OpenAI API to use a complete model.
      */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
      * Default model for chat variant.
      */

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

@@ -10,7 +10,9 @@ import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsO
 export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions & {
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor
-     * and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
+     * and detect abuse.
+     *
+     * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
      */
     user?: string_token;
 };

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

@@ -1,13 +1,16 @@
 /**
- * String value found on openai page
+ * String value found on OpenAI and Anthropic Claude page
+ *
+ * @see https://openai.com/api/pricing/
+ * @see https://docs.anthropic.com/en/docs/models-overview
  *
  * @private within the library, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
  */
-type string_openai_price = `$${number}.${number} / ${number}M tokens`;
+type string_model_price = `$${number}.${number} / ${number}M tokens`;
 /**
  * Function computeUsage will create price per one token based on the string value found on openai page
  *
  * @private within the library, used only as internal helper for `OPENAI_MODELS`
  */
-export declare function computeUsage(value: string_openai_price): number;
+export declare function computeUsage(value: string_model_price): number;
 export {};

package/esm/typings/execution/plugins/llm-execution-tools/openai/{models.d.ts → openai-models.d.ts}

@@ -16,7 +16,8 @@ export declare const OPENAI_MODELS: Array<AvailableModel & {
 }>;
 /**
  * TODO: [🧠] Some mechanism to propagate unsureness
- * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
  * @see https://openai.com/api/pricing/
  * @see /other/playground/playground.ts

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.52.0-1",
+    "version": "0.52.0-3",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -453,7 +453,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.52.0-0';
+    var PROMPTBOOK_VERSION = '0.52.0-2';
 
     /**
      * Parses the template and returns the list of all parameter names
@@ -3132,8 +3132,140 @@
      * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
      */
 
+    /**
+     * 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
+     */
+    var MultipleLlmExecutionTools = /** @class */ (function () {
+        /**
+         * Gets array of execution tools in order of priority
+         */
+        function MultipleLlmExecutionTools() {
+            var llmExecutionTools = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                llmExecutionTools[_i] = arguments[_i];
+            }
+            this.llmExecutionTools = llmExecutionTools;
+        }
+        /**
+         * Calls the best available chat model
+         */
+        MultipleLlmExecutionTools.prototype.gptChat = function (prompt) {
+            return this.gptCommon(prompt);
+        };
+        /**
+         * Calls the best available completion model
+         */
+        MultipleLlmExecutionTools.prototype.gptComplete = function (prompt) {
+            return this.gptCommon(prompt);
+        };
+        /**
+         * Calls the best available model
+         */
+        MultipleLlmExecutionTools.prototype.gptCommon = function (prompt) {
+            return __awaiter(this, void 0, void 0, function () {
+                var errors, _a, _b, llmExecutionTools, error_1, e_1_1;
+                var e_1, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0:
+                            errors = [];
+                            _d.label = 1;
+                        case 1:
+                            _d.trys.push([1, 11, 12, 13]);
+                            _a = __values(this.llmExecutionTools), _b = _a.next();
+                            _d.label = 2;
+                        case 2:
+                            if (!!_b.done) return [3 /*break*/, 10];
+                            llmExecutionTools = _b.value;
+                            _d.label = 3;
+                        case 3:
+                            _d.trys.push([3, 8, , 9]);
+                            if (!(prompt.modelRequirements.modelVariant === 'CHAT')) return [3 /*break*/, 5];
+                            return [4 /*yield*/, llmExecutionTools.gptChat(prompt)];
+                        case 4: return [2 /*return*/, _d.sent()];
+                        case 5:
+                            if (!(prompt.modelRequirements.modelVariant === 'COMPLETION')) return [3 /*break*/, 7];
+                            return [4 /*yield*/, llmExecutionTools.gptComplete(prompt)];
+                        case 6: return [2 /*return*/, _d.sent()];
+                        case 7: return [3 /*break*/, 9];
+                        case 8:
+                            error_1 = _d.sent();
+                            if (!(error_1 instanceof Error)) {
+                                throw error_1;
+                            }
+                            errors.push(error_1);
+                            return [3 /*break*/, 9];
+                        case 9:
+                            _b = _a.next();
+                            return [3 /*break*/, 2];
+                        case 10: return [3 /*break*/, 13];
+                        case 11:
+                            e_1_1 = _d.sent();
+                            e_1 = { error: e_1_1 };
+                            return [3 /*break*/, 13];
+                        case 12:
+                            try {
+                                if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                            }
+                            finally { if (e_1) throw e_1.error; }
+                            return [7 /*endfinally*/];
+                        case 13: throw new Error(spaceTrim__default["default"](function (block) { return "\n                  All execution tools failed:\n                  \n                  ".concat(block(errors.map(function (error) { return "- ".concat(error.name || 'Error', ": ").concat(error.message); }).join('\n')), "\n            \n            "); }));
+                    }
+                });
+            });
+        };
+        /**
+         * List all available models that can be used
+         * This liost is a combination of all available models from all execution tools
+         */
+        MultipleLlmExecutionTools.prototype.listModels = function () {
+            return __awaiter(this, void 0, void 0, function () {
+                var availableModels, _a, _b, llmExecutionTools, models, e_2_1;
+                var e_2, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0:
+                            availableModels = [];
+                            _d.label = 1;
+                        case 1:
+                            _d.trys.push([1, 6, 7, 8]);
+                            _a = __values(this.llmExecutionTools), _b = _a.next();
+                            _d.label = 2;
+                        case 2:
+                            if (!!_b.done) return [3 /*break*/, 5];
+                            llmExecutionTools = _b.value;
+                            return [4 /*yield*/, llmExecutionTools.listModels()];
+                        case 3:
+                            models = _d.sent();
+                            availableModels.push.apply(availableModels, __spreadArray([], __read(models), false));
+                            _d.label = 4;
+                        case 4:
+                            _b = _a.next();
+                            return [3 /*break*/, 2];
+                        case 5: return [3 /*break*/, 8];
+                        case 6:
+                            e_2_1 = _d.sent();
+                            e_2 = { error: e_2_1 };
+                            return [3 /*break*/, 8];
+                        case 7:
+                            try {
+                                if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                            }
+                            finally { if (e_2) throw e_2.error; }
+                            return [7 /*endfinally*/];
+                        case 8: return [2 /*return*/, availableModels];
+                    }
+                });
+            });
+        };
+        return MultipleLlmExecutionTools;
+    }());
+
     exports.CallbackInterfaceTools = CallbackInterfaceTools;
     exports.ExecutionTypes = ExecutionTypes;
+    exports.MultipleLlmExecutionTools = MultipleLlmExecutionTools;
     exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;
     exports.SimplePromptInterfaceTools = SimplePromptInterfaceTools;
     exports.SimplePromptbookLibrary = SimplePromptbookLibrary;