@promptbook/editable 0.94.0-3 → 0.94.0-4

package/esm/index.es.js

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

package/esm/typings/src/_packages/ollama.index.d.ts

@@ -1,10 +1,14 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createOllamaExecutionTools } from '../llm-providers/ollama/createOllamaExecutionTools';
+import { OLLAMA_MODELS } from '../llm-providers/ollama/ollama-models';
+import { OllamaExecutionTools } from '../llm-providers/ollama/OllamaExecutionTools';
 import { DEFAULT_OLLAMA_BASE_URL } from '../llm-providers/ollama/OllamaExecutionToolsOptions';
 import type { OllamaExecutionToolsOptions } from '../llm-providers/ollama/OllamaExecutionToolsOptions';
 import { _OllamaRegistration } from '../llm-providers/ollama/register-constructor';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createOllamaExecutionTools };
+export { OLLAMA_MODELS };
+export { OllamaExecutionTools };
 export { DEFAULT_OLLAMA_BASE_URL };
 export type { OllamaExecutionToolsOptions };
 export { _OllamaRegistration };

package/esm/typings/src/_packages/openai.index.d.ts

@@ -4,6 +4,7 @@ import { createOpenAiExecutionTools } from '../llm-providers/openai/createOpenAi
 import { OPENAI_MODELS } from '../llm-providers/openai/openai-models';
 import { OpenAiAssistantExecutionTools } from '../llm-providers/openai/OpenAiAssistantExecutionTools';
 import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
+import { OpenAiCompatibleExecutionTools } from '../llm-providers/openai/OpenAiCompatibleExecutionTools';
 import { OpenAiExecutionTools } from '../llm-providers/openai/OpenAiExecutionTools';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
@@ -14,6 +15,7 @@ export { createOpenAiExecutionTools };
 export { OPENAI_MODELS };
 export { OpenAiAssistantExecutionTools };
 export type { OpenAiAssistantExecutionToolsOptions };
+export { OpenAiCompatibleExecutionTools };
 export { OpenAiExecutionTools };
 export type { OpenAiExecutionToolsOptions };
 export { _OpenAiRegistration };

package/esm/typings/src/llm-providers/{openai/computeUsage.d.ts → _common/utils/pricing.d.ts}

@@ -8,9 +8,9 @@
  */
 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
+ * Create price per one token based on the string value found on openai page
  *
  * @private within the repository, used only as internal helper for `OPENAI_MODELS`
  */
-export declare function computeUsage(value: string_model_price): number;
+export declare function pricing(value: string_model_price): number;
 export {};

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

@@ -0,0 +1,44 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+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 Ollama API
+ *
+ * @public exported from `@promptbook/ollama`
+ */
+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

@@ -4,7 +4,7 @@ import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionTools
  *
  * @public exported from `@promptbook/ollama`
  */
-export declare const DEFAULT_OLLAMA_BASE_URL = "http://localhost:11434";
+export declare const DEFAULT_OLLAMA_BASE_URL = "http://localhost:11434/v1";
 /**
  * Options for `createOllamaExecutionTools`
  *

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

@@ -5,7 +5,7 @@ import type { OllamaExecutionToolsOptions } from './OllamaExecutionToolsOptions'
  *
  * @public exported from `@promptbook/ollama`
  */
-export declare const createOllamaExecutionTools: ((ollamaOptions: OllamaExecutionToolsOptions) => LlmExecutionTools) & {
+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/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(): Promise<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/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-2`).
+ * It follows semantic versioning (e.g., `0.94.0-3`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/editable",
-    "version": "0.94.0-3",
+    "version": "0.94.0-4",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -63,7 +63,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/editable.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.94.0-3"
+        "@promptbook/core": "0.94.0-4"
     },
     "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-3';
+    const PROMPTBOOK_ENGINE_VERSION = '0.94.0-4';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name