@promptbook/editable 0.94.0-1 → 0.94.0-12

package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts

@@ -1,19 +1,44 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { Usage } from '../../execution/Usage';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+import { computeOpenAiUsage } from '../openai/computeOpenAiUsage';
+import { OpenAiCompatibleExecutionTools } from '../openai/OpenAiCompatibleExecutionTools';
 import type { OllamaExecutionToolsOptions } from './OllamaExecutionToolsOptions';
 /**
- * Execution Tools for calling a local Ollama model via HTTP API
+ * Execution Tools for calling Ollama API
  *
  * @public exported from `@promptbook/ollama`
  */
-export declare class OllamaExecutionTools implements LlmExecutionTools {
-    protected readonly options: OllamaExecutionToolsOptions;
-    private limiter;
-    constructor(options: OllamaExecutionToolsOptions);
-    get title(): string;
-    get description(): string;
-    checkConfiguration(): Promise<void>;
-    listModels(): Promise<ReadonlyArray<AvailableModel>>;
-    callChatModel(prompt: Pick<import('../../types/Prompt').Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
+export declare class OllamaExecutionTools extends OpenAiCompatibleExecutionTools implements LlmExecutionTools {
+    constructor(ollamaOptions: OllamaExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * List all available models (non dynamically)
+     *
+     * Note: Purpose of this is to provide more information about models than standard listing from API
+     */
+    protected get HARDCODED_MODELS(): ReadonlyArray<AvailableModel>;
+    /**
+     * Computes the usage of the Ollama API based on the response from Ollama
+     */
+    protected computeUsage(...args: Parameters<typeof computeOpenAiUsage>): Usage;
+    /**
+     * Default model for chat variant.
+     */
+    protected getDefaultChatModel(): AvailableModel;
+    /**
+     * Default model for completion variant.
+     */
+    protected getDefaultCompletionModel(): AvailableModel;
+    /**
+     * Default model for completion variant.
+     */
+    protected getDefaultEmbeddingModel(): AvailableModel;
 }
+/**
+ * TODO: [🛄] Some way how to re-wrap the errors from `OpenAiCompatibleExecutionTools`
+ */

package/esm/typings/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts

@@ -1,12 +1,23 @@
-export interface OllamaExecutionToolsOptions {
-    /** Base URL of Ollama API, e.g., http://localhost:11434 */
-    baseUrl: string;
-    /** Model name to use for requests */
-    model: string;
-    /** Optional rate limit: max requests per minute */
-    maxRequestsPerMinute?: number;
-    /** Verbose logging */
-    isVerbose?: boolean;
-    /** Optional user identifier */
-    userId?: string;
-}
+import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionToolsOptions';
+/**
+ * Default base URL for Ollama API
+ *
+ * @public exported from `@promptbook/ollama`
+ */
+export declare const DEFAULT_OLLAMA_BASE_URL = "http://localhost:11434/v1";
+/**
+ * Options for `createOllamaExecutionTools`
+ *
+ * This combines options for Promptbook, Google and Vercel together
+ * @public exported from `@promptbook/ollama`
+ */
+export type OllamaExecutionToolsOptions = {
+    /**
+     * Base URL of Ollama API
+     *
+     * Note: Naming this `baseURL` not `baseUrl` to be consistent with OpenAI API
+     *
+     * @default `DEFAULT_OLLAMA_BASE_URL`
+     */
+    baseURL?: string;
+} & Omit<OpenAiExecutionToolsOptions, 'baseURL' | 'userId'>;

package/esm/typings/src/llm-providers/ollama/createOllamaExecutionTools.d.ts

@@ -1,11 +1,11 @@
-import { OllamaExecutionTools } from "./OllamaExecutionTools";
-import { OllamaExecutionToolsOptions } from "./OllamaExecutionToolsOptions";
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { OllamaExecutionToolsOptions } from './OllamaExecutionToolsOptions';
 /**
  * Execution Tools for calling Ollama API
  *
  * @public exported from `@promptbook/ollama`
  */
-export declare const createOllamaExecutionTools: ((options: OllamaExecutionToolsOptions) => OllamaExecutionTools) & {
+export declare const createOllamaExecutionTools: ((options: OllamaExecutionToolsOptions) => LlmExecutionTools) & {
     packageName: string;
     className: string;
 };

package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts

@@ -0,0 +1,14 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+/**
+ * List of available models in Ollama library
+ *
+ * Note: Done at 2025-05-19
+ *
+ * @see https://ollama.com/library
+ * @public exported from `@promptbook/ollama`
+ */
+export declare const OLLAMA_MODELS: ReadonlyArray<AvailableModel>;
+/**
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { ClientOptions } from 'openai';
 import type { string_token } from '../../types/typeAliases';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
- * Options for `OpenAiAssistantExecutionTools`
+ * Options for `createOpenAiAssistantExecutionTools` and `OpenAiAssistantExecutionTools`
  *
  * @public exported from `@promptbook/openai`
  */

package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts

@@ -0,0 +1,91 @@
+import OpenAI from 'openai';
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { Usage } from '../../execution/Usage';
+import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_model_name } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+import { computeOpenAiUsage } from './computeOpenAiUsage';
+import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API or other OpeenAI compatible provider
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecutionTools {
+    protected readonly options: OpenAiExecutionToolsOptions;
+    /**
+     * OpenAI API client.
+     */
+    private client;
+    /**
+     * Rate limiter instance
+     */
+    private limiter;
+    /**
+     * Creates OpenAI compatible Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI compatible client
+     */
+    constructor(options: OpenAiExecutionToolsOptions);
+    abstract get title(): string_title & string_markdown_text;
+    abstract get description(): string_markdown;
+    getClient(): Promise<OpenAI>;
+    /**
+     * Check the `options` passed to `constructor`
+     */
+    checkConfiguration(): Promise<void>;
+    /**
+     * List all available OpenAI compatible models that can be used
+     */
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
+    /**
+     * Calls OpenAI compatible API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
+    /**
+     * Calls OpenAI API to use a complete model.
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+    /**
+     * Calls OpenAI compatible API to use a embedding model
+     */
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
+    /**
+     * Get the model that should be used as default
+     */
+    protected getDefaultModel(defaultModelName: string_model_name): AvailableModel;
+    /**
+     * List all available models (non dynamically)
+     *
+     * Note: Purpose of this is to provide more information about models than standard listing from API
+     */
+    protected abstract get HARDCODED_MODELS(): ReadonlyArray<AvailableModel>;
+    /**
+     * Computes the usage of the OpenAI API based on the response from OpenAI Compatible API
+     */
+    protected abstract computeUsage(...args: Parameters<typeof computeOpenAiUsage>): Usage;
+    /**
+     * Default model for chat variant.
+     */
+    protected abstract getDefaultChatModel(): AvailableModel;
+    /**
+     * Default model for completion variant.
+     */
+    protected abstract getDefaultCompletionModel(): AvailableModel;
+    /**
+     * Default model for completion variant.
+     */
+    protected abstract getDefaultEmbeddingModel(): AvailableModel;
+}
+/**
+ * TODO: [🛄] Some way how to re-wrap the errors from `OpenAiCompatibleExecutionTools`
+ * TODO: [🛄] Maybe make custom `OpenAiCompatibleError`
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
+ */

package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -1,79 +1,38 @@
-import OpenAI from 'openai';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
-import type { EmbeddingPromptResult } from '../../execution/PromptResult';
-import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
-import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+import { computeOpenAiUsage } from './computeOpenAiUsage';
+import { OpenAiCompatibleExecutionTools } from './OpenAiCompatibleExecutionTools';
 /**
  * Execution Tools for calling OpenAI API
  *
  * @public exported from `@promptbook/openai`
  */
-export declare class OpenAiExecutionTools implements LlmExecutionTools {
-    protected readonly options: OpenAiExecutionToolsOptions;
-    /**
-     * OpenAI API client.
-     */
-    private client;
-    /**
-     * Rate limiter instance
-     */
-    private limiter;
-    /**
-     * Creates OpenAI Execution Tools.
-     *
-     * @param options which are relevant are directly passed to the OpenAI client
-     */
-    constructor(options: OpenAiExecutionToolsOptions);
+export declare class OpenAiExecutionTools extends OpenAiCompatibleExecutionTools implements LlmExecutionTools {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
-    getClient(): Promise<OpenAI>;
-    /**
-     * Check the `options` passed to `constructor`
-     */
-    checkConfiguration(): Promise<void>;
     /**
-     * List all available OpenAI models that can be used
-     */
-    listModels(): ReadonlyArray<AvailableModel>;
-    /**
-     * Calls OpenAI API to use a chat model.
-     */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
-    /**
-     * Calls OpenAI API to use a complete model.
-     */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
-    /**
-     * Calls OpenAI API to use a embedding model
+     * List all available models (non dynamically)
+     *
+     * Note: Purpose of this is to provide more information about models than standard listing from API
      */
-    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
+    protected get HARDCODED_MODELS(): ReadonlyArray<AvailableModel>;
     /**
-     * Get the model that should be used as default
+     * Computes the usage of the OpenAI API based on the response from OpenAI
      */
-    private getDefaultModel;
+    protected computeUsage: typeof computeOpenAiUsage;
     /**
      * Default model for chat variant.
      */
-    private getDefaultChatModel;
+    protected getDefaultChatModel(): AvailableModel;
     /**
      * Default model for completion variant.
      */
-    private getDefaultCompletionModel;
+    protected getDefaultCompletionModel(): AvailableModel;
     /**
      * Default model for completion variant.
      */
-    private getDefaultEmbeddingModel;
+    protected getDefaultEmbeddingModel(): AvailableModel;
 }
-/**
- * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
- * TODO: Maybe Create some common util for callChatModel and callCompletionModel
- * TODO: Maybe make custom OpenAiError
- * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
- * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
- */

package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts

@@ -1,7 +1,7 @@
 import type { ClientOptions } from 'openai';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 /**
- * Options for `OpenAiExecutionTools`
+ * Options for `createOpenAiExecutionTools` and `OpenAiExecutionTools`
  *
  * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
  * Rest is used by the `OpenAiExecutionTools`.

package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts

@@ -3,6 +3,8 @@ import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions'
 /**
  * Execution Tools for calling OpenAI API
  *
+ * Note: This can be also used for other OpenAI compatible APIs, like Ollama
+ *
  * @public exported from `@promptbook/openai`
  */
 export declare const createOpenAiExecutionTools: ((options: OpenAiExecutionToolsOptions) => OpenAiExecutionTools) & {

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -1,5 +1,4 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
-import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available OpenAI models with pricing
  *
@@ -9,12 +8,7 @@ import type { number_usd } from '../../types/typeAliases';
  * @see https://openai.com/api/pricing/
  * @public exported from `@promptbook/openai`
  */
-export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
-    pricing?: {
-        readonly prompt: number_usd;
-        readonly output: number_usd;
-    };
-}>;
+export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel>;
 /**
  * Note: [🤖] Add models of new variant
  * TODO: [🧠] Some mechanism to propagate unsureness

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.94.0-0`).
+ * It follows semantic versioning (e.g., `0.94.0-7`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/editable",
-    "version": "0.94.0-1",
+    "version": "0.94.0-12",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -36,6 +36,29 @@
         "o1-mini",
         "o1-preview",
         "anthropic",
+        "claude",
+        "claude-3",
+        "claude-3-opus",
+        "claude-3-sonnet",
+        "claude-3-haiku",
+        "gemini",
+        "gemini-pro",
+        "gemini-flash",
+        "mixtral",
+        "mistral",
+        "ollama",
+        "ai-orchestration",
+        "prompt-engineering",
+        "llmops",
+        "multimodal",
+        "reasoning",
+        "rag",
+        "embeddings",
+        "function-calling",
+        "large-language-models",
+        "ai-application-framework",
+        "text-generation",
+        "ai-agents",
         "LLMOps"
     ],
     "license": "BUSL-1.1",
@@ -63,7 +86,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/editable.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.94.0-1"
+        "@promptbook/core": "0.94.0-12"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.94.0-1';
+    const PROMPTBOOK_ENGINE_VERSION = '0.94.0-12';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name