@promptbook/markdown-utils 0.61.0-10

package/esm/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -0,0 +1,17 @@
+import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
+import type { UserInterfaceTools } from '../../../execution/UserInterfaceTools';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
+/**
+ * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
+ *
+ * Warning: It is used for testing and mocking
+ *          **NOT intended to use in the production** due to its synchronous nature.
+ */
+export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
+    private readonly options;
+    constructor(options?: CommonExecutionToolsOptions);
+    /**
+     * Trigger window.PROMPT DIALOG
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+}

package/esm/typings/src/knowledge/dialogs/user-interface-execution-tools.test.d.ts

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

package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts

@@ -0,0 +1,18 @@
+import type { PrepareOptions } from '../../../prepare/PrepareOptions';
+import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeSourceJson';
+/**
+ * Prepares the knowle
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ * @private within the package
+ */
+export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
+/**
+ * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+ *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
+ * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
+ * TODO: [🧠][❎] Do here propper M:N mapping
+ *       [x] One source can make multiple pieces
+ *       [ ] One piece can have multiple sources
+ */

package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts

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

package/esm/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTests.d.ts

@@ -0,0 +1,7 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+/**
+ * Returns LLM tools for testing purposes
+ *
+ * @private within the package - JUST FOR TESTS
+ */
+export declare function getLlmToolsForTests(): LlmExecutionTools;

package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -0,0 +1,11 @@
+import type { PrepareOptions } from '../../../prepare/PrepareOptions';
+import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
+import type { string_markdown } from '../../../types/typeAliases';
+/**
+ * @@@
+ */
+export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
+/**
+ * TODO: [🪂] Do it in parallel 11:11
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
+ */

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts

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

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -0,0 +1,12 @@
+import type { PrepareOptions } from '../../../prepare/PrepareOptions';
+import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
+import type { string_base64 } from '../../../types/typeAliases';
+/**
+ * @@@
+ */
+export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
+/**
+ * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
+ *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
+ * TODO: [🪂] Do it in parallel
+ */

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts

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

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

@@ -0,0 +1,48 @@
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { PromptChatResult } 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 { AnthropicClaudeExecutionToolsOptions } from './AnthropicClaudeExecutionToolsOptions';
+/**
+ * Execution Tools for calling Anthropic Claude API.
+ */
+export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    /**
+     * Anthropic Claude API client.
+     */
+    private readonly client;
+    /**
+     * Creates Anthropic Claude Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the Anthropic Claude client
+     */
+    constructor(options?: AnthropicClaudeExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Calls Anthropic Claude API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    /**
+     * Get the model that should be used as default
+     */
+    private getDefaultModel;
+    /**
+     * Default model for chat variant.
+     */
+    private getDefaultChatModel;
+    /**
+     * List all available Anthropic Claude models that can be used
+     */
+    listModels(): Array<AvailableModel>;
+}
+/**
+ * TODO: !!!! [🍆] JSON mode
+ * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
+ * TODO: Maybe Create some common util for callChatModel and callCompletionModel
+ * TODO: Maybe make custom OpenaiError
+ */

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

@@ -0,0 +1,8 @@
+import type { ClientOptions } from '@anthropic-ai/sdk';
+import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+/**
+ * Options for `AnthropicClaudeExecutionTools`
+ *
+ * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
+ */
+export type AnthropicClaudeExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions;

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

@@ -0,0 +1,22 @@
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available Anthropic Claude models with pricing
+ *
+ * Note: Done at 2024-05-25
+ *
+ * @see https://docs.anthropic.com/en/docs/models-overview
+ */
+export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * Note: [🤖] Add models of new variant
+ * TODO: !!!! 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: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ */

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

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

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

@@ -0,0 +1,47 @@
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { PromptChatResult } from '../../execution/PromptResult';
+import type { PromptCompletionResult } 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.
+ */
+export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    /**
+     * OpenAI Azure API client.
+     */
+    private readonly 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;
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    /**
+     * Calls Azure OpenAI API to use a complete model.
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * Changes Azure error (which is not propper Error but object) to propper Error
+     */
+    private transformAzureError;
+    /**
+     * List all available Azure OpenAI models that can be used
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+}
+/**
+ * TODO: Maybe Create some common util for callChatModel and callCompletionModel
+ * TODO: Maybe make custom AzureOpenaiError
+ */

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

@@ -0,0 +1,35 @@
+import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { string_name } from '../../types/typeAliases';
+import type { string_token } from '../../types/typeAliases';
+/**
+ * Options for `AzureOpenAiExecutionTools`
+ *
+ * @see https://oai.azure.com/portal/
+ */
+export type AzureOpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * 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/playground/playground.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

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

@@ -0,0 +1,12 @@
+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.
+ */
+export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+}

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

@@ -0,0 +1,11 @@
+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`.
+ */
+export type LangtailExecutionToolsOptions = OpenAiExecutionToolsOptions;
+/**
+ * TODO: !!! Use or remove
+ */

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

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

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

@@ -0,0 +1,34 @@
+import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { PromptChatResult } from '../../execution/PromptResult';
+import type { PromptCompletionResult } 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.
+ */
+export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    constructor(options?: CommonExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Mocks chat model
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    /**
+     * Mocks completion model
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * List all available mocked-models that can be used
+     */
+    listModels(): Array<AvailableModel>;
+}
+/**
+ * TODO: [🕵️‍♀️] Maybe just remove
+ * 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,38 @@
+import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { PromptChatResult } from '../../execution/PromptResult';
+import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } 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
+ */
+export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    constructor(options?: CommonExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Fakes chat model
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptChatResult & PromptCompletionResult>;
+    /**
+     * Fakes completion model
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptCompletionResult>;
+    /**
+     * Fakes embedding model
+     */
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptEmbeddingResult>;
+    /**
+     * List all available fake-models that can be used
+     */
+    listModels(): Array<AvailableModel>;
+}
+/**
+ * TODO: [🕵️‍♀️] Maybe just remove
+ */

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

@@ -0,0 +1,14 @@
+import type { PostprocessingFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { Expectations } from '../../types/PipelineJson/Expectations';
+/**
+ * Gets the expectations and creates a fake text that meets the expectations
+ *
+ * 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 util for MockedFackedLlmExecutionTools
+ */
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
+/**
+ * TODO: [💝] Unite object for expecting amount and format - use here also a format
+ */

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,50 @@
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { PromptChatResult } from '../../execution/PromptResult';
+import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } 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';
+/**
+ * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
+ *
+ * @private Internal utility of `joinLlmExecutionTools`
+ */
+export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
+    /**
+     * Array of execution tools in order of priority
+     */
+    private 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;
+    /**
+     * Calls the best available chat model
+     */
+    callChatModel(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls the best available completion model
+     */
+    callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Calls the best available embedding model
+     */
+    callEmbeddingModel(prompt: Prompt): Promise<PromptEmbeddingResult>;
+    /**
+     * Calls the best available model
+     */
+    private callModelCommon;
+    /**
+     * List all available models that can be used
+     * This liost is a combination of all available models from all execution tools
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+}
+/**
+ * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first aviable model BUT all of them
+ */

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

@@ -0,0 +1,16 @@
+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`
+ */
+export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;

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

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

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

@@ -0,0 +1,65 @@
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { PromptChatResult } from '../../execution/PromptResult';
+import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } 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.
+ */
+export declare class OpenAiExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    /**
+     * OpenAI API client.
+     */
+    private readonly 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;
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectFormat'>): Promise<PromptChatResult>;
+    /**
+     * Calls OpenAI API to use a complete model.
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * Calls OpenAI API to use a embedding model
+     */
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptEmbeddingResult>;
+    /**
+     * 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;
+    /**
+     * List all available OpenAI models that can be used
+     */
+    listModels(): Array<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
+ */

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

@@ -0,0 +1,18 @@
+import type { ClientOptions } from 'openai';
+import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+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`.
+ */
+export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & 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,14 @@
+import type OpenAI from 'openai';
+import type { PromptResultUsage } from '../../execution/PromptResult';
+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 util 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: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;

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

@@ -0,0 +1,16 @@
+/**
+ * String value found on OpenAI and Anthropic Claude page
+ *
+ * @see https://openai.com/api/pricing/
+ * @see https://docs.anthropic.com/en/docs/models-overview
+ *
+ * @private within the package, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ */
+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
+ *
+ * @private within the package, used only as internal helper for `OPENAI_MODELS`
+ */
+export declare function computeUsage(value: string_model_price): number;
+export {};

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

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

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

@@ -0,0 +1,27 @@
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available OpenAI models with pricing
+ *
+ * Note: Done at 2024-05-20
+ *
+ * @see https://platform.openai.com/docs/models/
+ * @see https://openai.com/api/pricing/
+ */
+export declare const OPENAI_MODELS: Array<AvailableModel & {
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * Note: [🤖] Add models of new variant
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
+ * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
+ * @see https://openai.com/api/pricing/
+ * @see /other/playground/playground.ts
+ * TODO: [🍓] Make better
+ * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ */

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

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};