@promptbook/openai 0.95.0 → 0.98.0-10

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

@@ -11,14 +11,14 @@ 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';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
- * Execution Tools for calling OpenAI API or other OpeenAI compatible provider
+ * Execution Tools for calling OpenAI API or other OpenAI compatible provider
  *
  * @public exported from `@promptbook/openai`
  */
 export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecutionTools {
-    protected readonly options: OpenAiExecutionToolsOptions;
+    protected readonly options: OpenAiCompatibleExecutionToolsNonProxiedOptions;
     /**
      * OpenAI API client.
      */
@@ -32,7 +32,7 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      *
      * @param options which are relevant are directly passed to the OpenAI compatible client
      */
-    constructor(options: OpenAiExecutionToolsOptions);
+    constructor(options: OpenAiCompatibleExecutionToolsNonProxiedOptions);
     abstract get title(): string_title & string_markdown_text;
     abstract get description(): string_markdown;
     getClient(): Promise<OpenAI>;

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

@@ -0,0 +1,52 @@
+import type { ClientOptions } from 'openai';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
+/**
+ * Options for `createOpenAiCompatibleExecutionTools` and `OpenAiCompatibleExecutionTools`
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiCompatibleExecutionTools`.
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiCompatibleExecutionToolsOptions = OpenAiCompatibleExecutionToolsNonProxiedOptions | OpenAiCompatibleExecutionToolsProxiedOptions;
+/**
+ * Options for directly used `OpenAiCompatibleExecutionTools`
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiCompatibleExecutionToolsNonProxiedOptions = CommonToolsOptions & ClientOptions & {
+    /**
+     * Base URL for the OpenAI-compatible API endpoint
+     *
+     * This allows connecting to any OpenAI-compatible LLM service by specifying their API endpoint.
+     *
+     * @example 'https://https://promptbook.s5.ptbk.io/' (Promptbook)
+     * @example 'https://api.openai.com/v1' (OpenAI)
+     * @example 'http://localhost:11434/v1' (Ollama)
+     * @example 'https://api.deepseek.com/v1' (DeepSeek)
+     */
+    baseURL?: string;
+    isProxied?: false;
+};
+/**
+ * Options for proxied `OpenAiCompatibleExecutionTools`
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiCompatibleExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
+    /**
+     * Base URL for the OpenAI-compatible API endpoint
+     *
+     * This allows connecting to any OpenAI-compatible LLM service by specifying their API endpoint.
+     *
+     * @example 'https://https://promptbook.s5.ptbk.io/' (Promptbook)
+     * @example 'https://api.openai.com/v1' (OpenAI)
+     * @example 'http://localhost:11434/v1' (Ollama)
+     * @example 'https://api.deepseek.com/v1' (DeepSeek)
+     */
+    baseURL?: string;
+    isProxied: true;
+} & Pick<RemoteClientOptions<undefined>, 'remoteServerUrl'>;

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

@@ -1,11 +1,9 @@
-import type { ClientOptions } from 'openai';
-import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
  * Options for `createOpenAiExecutionTools` and `OpenAiExecutionTools`
  *
- * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
- * Rest is used by the `OpenAiExecutionTools`.
+ * This extends OpenAiCompatibleExecutionToolsOptions.
  *
  * @public exported from `@promptbook/openai`
  */
-export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions;
+export type OpenAiExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions;

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

@@ -0,0 +1,74 @@
+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_model_name } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+import { RemoteLlmExecutionTools } from '../remote/RemoteLlmExecutionTools';
+import { computeOpenAiUsage } from './computeOpenAiUsage';
+import { OpenAiCompatibleExecutionTools } from './OpenAiCompatibleExecutionTools';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from './OpenAiCompatibleExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI compatible API
+ *
+ * Note: This can be used for any OpenAI compatible APIs
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiCompatibleExecutionTools: ((options: OpenAiCompatibleExecutionToolsOptions & {
+    /**
+     * The model name to use for all operations
+     *
+     * This will be the only model available through this LLM provider and it will be a chat model.
+     * Other variants won't be available for now.
+     */
+    defaultModelName: string_model_name;
+}) => OpenAiCompatibleExecutionTools | RemoteLlmExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * Execution Tools for calling ONE SPECIFIC PRECONFIGURED OpenAI compatible provider
+ *
+ * @private for `createOpenAiCompatibleExecutionTools`
+ */
+export declare class HardcodedOpenAiCompatibleExecutionTools extends OpenAiCompatibleExecutionTools implements LlmExecutionTools {
+    private readonly defaultModelName;
+    protected readonly options: OpenAiCompatibleExecutionToolsNonProxiedOptions;
+    /**
+     * Creates OpenAI compatible Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI compatible client
+     */
+    constructor(defaultModelName: string_model_name, options: OpenAiCompatibleExecutionToolsNonProxiedOptions);
+    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
+     */
+    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: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -19,6 +19,17 @@ export declare const _OpenAiMetadataRegistration: Registration;
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantMetadataRegistration: Registration;
+/**
+ * Registration of the OpenAI Compatible metadata
+ *
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be instantiated directly.
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiCompatibleMetadataRegistration: Registration;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -19,6 +19,20 @@ export declare const _OpenAiRegistration: Registration;
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantRegistration: Registration;
+/**
+ * Registration of the OpenAI Compatible provider
+ *
+ * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiCompatibleRegistration: Registration;
+/**
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be registered directly.
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
+ */
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  * Note: [💞] Ignore a discrepancy between file name and entity name

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`).
+ * It follows semantic versioning (e.g., `0.98.0-9`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.95.0",
+    "version": "0.98.0-10",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -74,13 +74,14 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.95.0"
+        "@promptbook/core": "0.98.0-10"
     },
     "dependencies": {
         "bottleneck": "^2.19.5",
         "colors": "1.4.0",
         "crypto": "1.0.1",
         "openai": "4.63.0",
+        "socket.io-client": "4.7.2",
         "spacetrim": "0.11.59"
     }
 }