@promptbook/legacy-documents 0.71.0-12

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

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available Anthropic Claude models with pricing
+ *
+ * Note: Done at 2024-08-16
+ *
+ * @see https://docs.anthropic.com/en/docs/models-overview
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * Note: [🤖] Add models of new variant
+ * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
+ * TODO: [🎰] Some mechanism to auto-update available models
+ */

package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts

@@ -0,0 +1,18 @@
+import type Anthropic from '@anthropic-ai/sdk';
+import type { PartialDeep } from 'type-fest';
+import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Prompt } from '../../types/Prompt';
+/**
+ * Computes the usage of the Anthropic Claude API based on the response from Anthropic Claude
+ *
+ * @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 Anthropic Claude API
+ * @throws {PipelineExecutionError} If the usage is not defined in the response from Anthropic Claude
+ * @private internal utility of `AnthropicClaudeExecutionTools`
+ */
+export declare function computeAnthropicClaudeUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
+resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): PromptResultUsage;
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
+ */

package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
+ */

package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts

@@ -0,0 +1,19 @@
+import { RemoteLlmExecutionTools } from '../remote/RemoteLlmExecutionTools';
+import { AnthropicClaudeExecutionTools } from './AnthropicClaudeExecutionTools';
+import type { AnthropicClaudeExecutionToolsOptions } from './AnthropicClaudeExecutionToolsOptions';
+/**
+ * Execution Tools for calling Anthropic Claude API.
+ *
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+export declare const createAnthropicClaudeExecutionTools: ((options: AnthropicClaudeExecutionToolsOptions) => AnthropicClaudeExecutionTools | RemoteLlmExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
+ * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
+ * 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/anthropic-claude/playground/playground.d.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [main] !!! Playground with WebGPT / Promptbook.studio anonymous server
+ * TODO: [main] !!! 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/anthropic-claude/register-configuration.d.ts

@@ -0,0 +1,10 @@
+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/cli`
+ */
+export declare const _AnthropicClaudeMetadataRegistration: Registration;

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

@@ -0,0 +1,13 @@
+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/anthropic-claude`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _AnthropicClaudeRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -0,0 +1,63 @@
+import { OpenAIClient } from '@azure/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 { 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 { AzureOpenAiExecutionToolsOptions } from './AzureOpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling Azure OpenAI API.
+ *
+ * @public exported from `@promptbook/azure-openai`
+ */
+export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    /**
+     * OpenAI Azure API client.
+     */
+    private client;
+    /**
+     * Creates OpenAI Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI client
+     */
+    constructor(options: AzureOpenAiExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    getClient(): Promise<OpenAIClient>;
+    /**
+     * Check the `options` passed to `constructor`
+     */
+    checkConfiguration(): Promise<void>;
+    /**
+     * List all available Azure OpenAI models that can be used
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
+    /**
+     * Calls Azure OpenAI API to use a complete model.
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+    /**
+     * Library `@azure/openai` has bug/weird behavior that it does not throw error but hangs forever
+     *
+     * This method wraps the promise with timeout
+     */
+    private withTimeout;
+    /**
+     * Changes Azure error (which is not propper Error but object) to propper Error
+     */
+    private transformAzureError;
+}
+/**
+ * TODO: Maybe Create some common util for callChatModel and callCompletionModel
+ * TODO: Maybe make custom AzureOpenAiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
+ */

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

@@ -0,0 +1,36 @@
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { string_name } from '../../types/typeAliases';
+import type { string_token } from '../../types/typeAliases';
+/**
+ * Options for `AzureOpenAiExecutionTools`
+ *
+ * @see https://oai.azure.com/portal/
+ * @public exported from `@promptbook/azure-openai`
+ */
+export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
+    /**
+     * The resource name of the Azure OpenAI resource
+     *
+     * Note: Typically you have one resource and multiple deployments.
+     */
+    readonly resourceName: string_name;
+    /**
+     * The deployment name
+     *
+     * Note: If you specify modelName in prompt, it will be used instead of deploymentName
+     * Note: This is kind of a modelName in OpenAI terms
+     * Note: Typically you have one resource and multiple deployments.
+     */
+    readonly deploymentName: string_name;
+    /**
+     * The API key of the Azure OpenAI resource
+     */
+    readonly apiKey: string_token;
+    /**
+     * A unique identifier representing your end-user, which can help Azure OpenAI to monitor
+     * and detect abuse.
+     *
+     * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids (document from OpenAI not Azure, but same concept)
+     */
+    readonly user?: string_token;
+};

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

@@ -0,0 +1,15 @@
+import { AzureOpenAiExecutionTools } from './AzureOpenAiExecutionTools';
+import type { AzureOpenAiExecutionToolsOptions } from './AzureOpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling Azure OpenAI API
+ *
+ * @public exported from `@promptbook/azure-openai`
+ */
+export declare const createAzureOpenAiExecutionTools: ((options: AzureOpenAiExecutionToolsOptions) => AzureOpenAiExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * 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/azure-openai/playground/playground.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: 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/azure-openai/register-configuration.d.ts

@@ -0,0 +1,10 @@
+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/cli`
+ */
+export declare const _AzureOpenAiMetadataRegistration: Registration;

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

@@ -0,0 +1,13 @@
+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/azure-openai`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _AzureOpenAiRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts

@@ -0,0 +1,17 @@
+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 { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
+/**
+ * Execution Tools for calling OpenAI API.
+ *
+ * @public exported from `@promptbook/langtail`
+ */
+export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+}
+/**
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ */ 

package/esm/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts

@@ -0,0 +1,13 @@
+import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionToolsOptions';
+/**
+ * Options for LangtailExecutionTools
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiExecutionTools`.
+ *
+ * @public exported from `@promptbook/langtail`
+ */
+export type LangtailExecutionToolsOptions = OpenAiExecutionToolsOptions;
+/**
+ * TODO: !! Use or remove
+ */

package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

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

@@ -0,0 +1,15 @@
+import type { Expectations } from '../../types/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?: Array<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 {
+    private readonly options;
+    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(): Array<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 {
+    private readonly options;
+    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(): Array<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/multiple/MultipleLlmExecutionTools.d.ts

@@ -0,0 +1,64 @@
+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 { PromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt } from '../../types/Prompt';
+import type { CompletionPrompt } from '../../types/Prompt';
+import type { EmbeddingPrompt } from '../../types/Prompt';
+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';
+/**
+ * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
+ *
+ * Note: Internal utility of `joinLlmExecutionTools` but exposed type
+ * @public exported from `@promptbook/types`
+ * TODO: !!!!!! Export as runtime class not just type
+ */
+export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
+    /**
+     * Array of execution tools in order of priority
+     */
+    readonly llmExecutionTools: Array<LlmExecutionTools>;
+    /**
+     * Gets array of execution tools in order of priority
+     */
+    constructor(...llmExecutionTools: Array<LlmExecutionTools>);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Check the configuration of all execution tools
+     */
+    checkConfiguration(): Promise<void>;
+    /**
+     * List all available models that can be used
+     * This lists is a combination of all available models from all execution tools
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+    /**
+     * Calls the best available chat model
+     */
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
+    /**
+     * Calls the best available completion model
+     */
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls the best available embedding model
+     */
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
+    /**
+     * Calls the best available model
+     *
+     * Note: This should be private or protected but is public to be usable with duck typing
+     */
+    callCommonModel(prompt: Prompt): Promise<PromptResult>;
+}
+/**
+ * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first aviable model BUT all of them
+ * TODO: [🏖] If no llmTools have for example not defined `callCompletionModel` this will still return object with defined `callCompletionModel` which just throws `PipelineExecutionError`, make it undefined instead
+ *       Look how `countTotalUsage` (and `cacheLlmTools`) implements it
+ */

package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts

@@ -0,0 +1,21 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
+/**
+ * Joins multiple LLM Execution Tools into one
+ *
+ * @returns {LlmExecutionTools} Single wrapper for multiple LlmExecutionTools
+ *
+ * 0) If there is no LlmExecutionTools, it warns and returns valid but empty LlmExecutionTools
+ * 1) If there is only one LlmExecutionTools, it returns it wrapped in a proxy object
+ * 2) If there are multiple LlmExecutionTools, first will be used first, second will be used if the first hasn`t defined model variant or fails, etc.
+ * 3) When all LlmExecutionTools fail, it throws an error with a list of all errors merged into one
+ *
+ *
+ * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;
+/**
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ */

package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

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

@@ -0,0 +1,75 @@
+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';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare class OpenAiExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    /**
+     * OpenAI API client.
+     */
+    private client;
+    /**
+     * Creates OpenAI Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI client
+     */
+    constructor(options?: OpenAiExecutionToolsOptions);
+    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(): Array<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
+     */
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
+    /**
+     * Get the model that should be used as default
+     */
+    private getDefaultModel;
+    /**
+     * Default model for chat variant.
+     */
+    private getDefaultChatModel;
+    /**
+     * Default model for completion variant.
+     */
+    private getDefaultCompletionModel;
+    /**
+     * Default model for completion variant.
+     */
+    private getDefaultEmbeddingModel;
+}
+/**
+ * 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

@@ -0,0 +1,20 @@
+import type { ClientOptions } from 'openai';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { string_token } from '../../types/typeAliases';
+/**
+ * Options for `OpenAiExecutionTools`
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiExecutionTools`.
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions & {
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor
+     * and detect abuse.
+     *
+     * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
+     */
+    user?: string_token;
+};

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 { PromptResultUsage } from '../../execution/PromptResultUsage';
+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'>>): PromptResultUsage;
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
+ */

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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
+ */