@promptbook/openai 0.52.0-0 → 0.52.0-10

package/umd/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/umd/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/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/playground/playground.d.ts

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

package/umd/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/umd/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/umd/typings/execution/plugins/llm-execution-tools/azure-openai/playground/playground.d.ts

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

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

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

package/umd/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/umd/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/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/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/umd/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/umd/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/umd/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/umd/typings/execution/plugins/llm-execution-tools/openai/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

@@ -1,20 +1,7 @@
-import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
+import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
 /**
- * ScriptExecutionTools for JavaScript implemented via vm2
+ * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
- * Warning: This is not implemented yet
- */
-export declare class JavascriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
-    /**
-     * Executes a JavaScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
-/**
- * TODO: !! Pass isVerbose to constructor and use it
- * TODO: !! Probbably make some common util createStatementToEvaluate
- * TODO: !! Implement via vm2
+ * @alias JavascriptExecutionTools
  */
+export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -1,4 +1,16 @@
+import { string_folder_path } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromDirectoryOptions = {
+    /**
+     * If true, the directory is searched recursively for promptbooks
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+};
 /**
  * Constructs Promptbook from given directory
  *
@@ -6,9 +18,12 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
  *       SO during the construction syntax and logic sources IS NOT validated
  *
+ * @param path - path to the directory with promptbooks
+ * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): PromptbookLibrary;
+export {};
 /***
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -1,5 +0,0 @@
-import { Wizzard } from '../wizzard/Wizzard';
-export { Wizzard };
-/**
- * TODO: [🧙‍♂️]
- */ 

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

@@ -1,5 +0,0 @@
-import { Wizzard } from '../wizzard/Wizzard';
-export { Wizzard };
-/**
- * TODO: [🧙‍♂️]
- */