@promptbook/openai 0.94.0-1 → 0.94.0-4

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-3`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.94.0-1",
+    "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/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.94.0-1"
+        "@promptbook/core": "0.94.0-4"
     },
     "dependencies": {
         "bottleneck": "^2.19.5",