@promptbook/components 0.100.0-24

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

@@ -0,0 +1,14 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _DeepseekMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/deepseek`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _DeepseekRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts

@@ -0,0 +1,9 @@
+import type { createGoogleGenerativeAI } from '@ai-sdk/google';
+import type { VercelExecutionToolsOptions } from '../vercel/VercelExecutionToolsOptions';
+/**
+ * Options for `createGoogleExecutionTools`
+ *
+ * This combines options for Promptbook, Google and Vercel together
+ * @public exported from `@promptbook/google`
+ */
+export type GoogleExecutionToolsOptions = Omit<VercelExecutionToolsOptions, 'title' | 'description' | 'vercelProvider' | 'availableModels'> & Parameters<typeof createGoogleGenerativeAI>[0];

package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts

@@ -0,0 +1,14 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { GoogleExecutionToolsOptions } from './GoogleExecutionToolsOptions';
+/**
+ * Execution Tools for calling Google Gemini API.
+ *
+ * @public exported from `@promptbook/google`
+ */
+export declare const createGoogleExecutionTools: ((options: GoogleExecutionToolsOptions) => LlmExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available Google models with descriptions
+ *
+ * Note: Done at 2025-05-06
+ *
+ * @see https://ai.google.dev/models/gemini
+ * @public exported from `@promptbook/google`
+ */
+export declare const GOOGLE_MODELS: ReadonlyArray<AvailableModel & {
+    modelDescription?: string;
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * TODO: [🧠] Add information about context window sizes, capabilities, and relative performance characteristics
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🧠] Verify pricing information is current with Google's official documentation
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,14 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _GoogleMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/google`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _GoogleRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts

@@ -0,0 +1,15 @@
+import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
+/**
+ * Gets the expectations and creates a fake text that meets the expectations
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
+ * Note: You can provide postprocessing functions to modify the text before checking the expectations
+ *       The result will be the text BEFORE the postprocessing
+ *
+ * @private internal utility for MockedFackedLlmExecutionTools
+ */
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>): Promise<string>;
+/**
+ * TODO: [💝] Unite object for expecting amount and format - use here also a format
+ */

package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -0,0 +1,40 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } 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';
+/**
+ * Mocked execution Tools for just echoing the requests for testing purposes.
+ *
+ * @public exported from `@promptbook/fake-llm`
+ */
+export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
+    protected readonly options: CommonToolsOptions;
+    constructor(options?: CommonToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Does nothing, just to implement the interface
+     */
+    checkConfiguration(): void;
+    /**
+     * List all available mocked-models that can be used
+     */
+    listModels(): ReadonlyArray<AvailableModel>;
+    /**
+     * Mocks chat model
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
+    /**
+     * Mocks completion model
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+}
+/**
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
+ */

package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -0,0 +1,44 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+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';
+/**
+ * Mocked execution Tools for just faking expected responses for testing purposes
+ *
+ * @public exported from `@promptbook/fake-llm`
+ */
+export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
+    protected readonly options: CommonToolsOptions;
+    constructor(options?: CommonToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Does nothing, just to implement the interface
+     */
+    checkConfiguration(): void;
+    /**
+     * List all available fake-models that can be used
+     */
+    listModels(): ReadonlyArray<AvailableModel>;
+    /**
+     * Fakes chat model
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessingFunctionNames'>): Promise<ChatPromptResult & CompletionPromptResult>;
+    /**
+     * Fakes completion model
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessingFunctionNames'>): Promise<CompletionPromptResult>;
+    /**
+     * Fakes embedding model
+     */
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessingFunctionNames'>): Promise<EmbeddingPromptResult>;
+}
+/**
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ */

package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPipelineExecutor.test.ts"
+ */

package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts

@@ -0,0 +1,5 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPipelineExecutor.test.ts"
+ * Note: [🤖] For each new model variant consider adding new testing unit like "faked-completion.test.ts", "mocked-chat.test.ts" and "mocked-completion.test.ts"
+ */

package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPipelineExecutor.test.ts"
+ */

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

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,11 @@
+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) => 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/ollama/playground/playground.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * Note: [⚫] Code in this file should never be published in any package
+ */

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

@@ -0,0 +1,14 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OllamaMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/ollama`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OllamaRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,36 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } 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 { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
+import { OpenAiExecutionTools } from './OpenAiExecutionTools';
+/**
+ * Execution Tools for calling OpenAI API Assistants
+ *
+ * This is useful for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
+    private readonly assistantId;
+    /**
+     * Creates OpenAI Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI client
+     */
+    constructor(options: OpenAiAssistantExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
+}
+/**
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
+ * 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/OpenAiAssistantExecutionToolsOptions.d.ts

@@ -0,0 +1,14 @@
+import type { ClientOptions } from 'openai';
+import type { string_token } from '../../types/typeAliases';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
+/**
+ * Options for `createOpenAiAssistantExecutionTools` and `OpenAiAssistantExecutionTools`
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiAssistantExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions & ClientOptions & {
+    /**
+     * Which assistant to use
+     */
+    assistantId: string_token;
+};

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 { OpenAiCompatibleExecutionToolsNonProxiedOptions } from './OpenAiCompatibleExecutionToolsOptions';
+/**
+ * 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: OpenAiCompatibleExecutionToolsNonProxiedOptions;
+    /**
+     * 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: OpenAiCompatibleExecutionToolsNonProxiedOptions);
+    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/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/OpenAiExecutionTools.d.ts

@@ -0,0 +1,38 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+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 './computeOpenAiUsage';
+import { OpenAiCompatibleExecutionTools } from './OpenAiCompatibleExecutionTools';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare class OpenAiExecutionTools extends OpenAiCompatibleExecutionTools implements LlmExecutionTools {
+    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 OpenAI API based on the response from OpenAI
+     */
+    protected computeUsage: typeof computeOpenAiUsage;
+    /**
+     * Default model for chat variant.
+     */
+    protected getDefaultChatModel(): AvailableModel;
+    /**
+     * Default model for completion variant.
+     */
+    protected getDefaultCompletionModel(): AvailableModel;
+    /**
+     * Default model for completion variant.
+     */
+    protected getDefaultEmbeddingModel(): AvailableModel;
+}

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

@@ -0,0 +1,9 @@
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
+/**
+ * Options for `createOpenAiExecutionTools` and `OpenAiExecutionTools`
+ *
+ * This extends OpenAiCompatibleExecutionToolsOptions.
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions;

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

@@ -0,0 +1,18 @@
+import type OpenAI from 'openai';
+import type { PartialDeep } from 'type-fest';
+import type { Usage } from '../../execution/Usage';
+import type { Prompt } from '../../types/Prompt';
+/**
+ * Computes the usage of the OpenAI API based on the response from OpenAI
+ *
+ * @param promptContent The content of the prompt
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
+ * @param rawResponse The raw response from OpenAI API
+ * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
+ * @private internal utility of `OpenAiExecutionTools`
+ */
+export declare function computeOpenAiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
+resultContent: string, rawResponse: PartialDeep<Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>>): Usage;
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
+ */