@promptbook/markitdown 0.84.0-10

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

@@ -0,0 +1,63 @@
+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/core`
+ */
+export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
+    /**
+     * Array of execution tools in order of priority
+     */
+    readonly llmExecutionTools: ReadonlyArray<LlmExecutionTools>;
+    /**
+     * Gets array of execution tools in order of priority
+     */
+    constructor(...llmExecutionTools: ReadonlyArray<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<ReadonlyArray<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: ReadonlyArray<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/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 usefull 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 wizzard for thoose 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 { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * Options for `OpenAiAssistantExecutionTools`
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiAssistantExecutionToolsOptions = OpenAiExecutionToolsOptions & ClientOptions & {
+    /**
+     * Which assistant to use
+     */
+    assistantId: string_token;
+};

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

@@ -0,0 +1,84 @@
+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 { string_token } from '../../types/typeAliases';
+import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
+import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * 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;
+    /**
+     * 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>;
+    /**
+     * Create (sub)tools for calling OpenAI API Assistants
+     *
+     * @param assistantId Which assistant to use
+     * @returns Tools for calling OpenAI API Assistants with same token
+     */
+    createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools;
+    /**
+     * 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
+     */
+    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,11 @@
+import type { ClientOptions } from 'openai';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+/**
+ * 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;

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`
+ */

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 repository, 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 repository, 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/createOpenAiAssistantExecutionTools.d.ts

@@ -0,0 +1,15 @@
+import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
+import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiAssistantExecutionTools: ((options: OpenAiAssistantExecutionToolsOptions) => OpenAiAssistantExecutionTools) & {
+    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/openai/createOpenAiExecutionTools.d.ts

@@ -0,0 +1,15 @@
+import { OpenAiExecutionTools } from './OpenAiExecutionTools';
+import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiExecutionTools: ((options: OpenAiExecutionToolsOptions) => OpenAiExecutionTools) & {
+    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/openai/openai-models.d.ts

@@ -0,0 +1,31 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+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/
+ * @public exported from `@promptbook/openai`
+ */
+export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * Note: [🤖] Add models of new variant
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * 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)"
+ * 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/openai/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/openai/register-configuration.d.ts

@@ -0,0 +1,24 @@
+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/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiMetadataRegistration: Registration;
+/**
+ * @@@ registration1 of default configuration for Open AI
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiAssistantMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,25 @@
+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/openai`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiRegistration: Registration;
+/**
+ * @@@ registration2
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiAssistantRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -0,0 +1,59 @@
+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 { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
+import type { ChatPrompt } from '../../types/Prompt';
+import type { CompletionPrompt } from '../../types/Prompt';
+import type { EmbeddingPrompt } 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';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ * @public exported from `@promptbook/remote-client`
+ */
+export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> implements LlmExecutionTools {
+    protected readonly options: RemoteClientOptions<TCustomOptions>;
+    constructor(options: RemoteClientOptions<TCustomOptions>);
+    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
+     */
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
+    /**
+     * Calls remote proxy server to use a chat model
+     */
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
+    /**
+     * Calls remote proxy server to use a completion model
+     */
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls remote proxy server to use a embedding model
+     */
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
+    /**
+     * Calls remote proxy server to use both completion or chat model
+     */
+    private callCommonModel;
+}
+/**
+ * TODO: Maybe use `$exportJson`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🍓] Allow to list compatible models with each variant
+ * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
+ * TODO: [🧠] Maybe remove `@promptbook/remote-client` and just use `@promptbook/core`
+ */

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+import '../../openai/register-constructor';
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { VercelProvider } from './VercelProvider';
+/**
+ * Options for `createExecutionToolsFromVercelProvider`
+ *
+ * @public exported from `@promptbook/google`
+ */
+export type VercelExecutionToolsOptions = CommonToolsOptions & Pick<LlmExecutionTools, 'title' | 'description'> & {
+    /**
+     * Vercel provider for the execution tools
+     */
+    readonly vercelProvider: VercelProvider;
+    /**
+     * List of available models for given Vercel provider
+     */
+    readonly availableModels: ReadonlyArray<AvailableModel>;
+    /**
+     * Additional settings for chat models when calling `vercelProvider.chat('model-name', settings)`
+     */
+    readonly additionalChatSettings?: Partial<Parameters<VercelProvider['chat']>[1]>;
+};

package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts

@@ -0,0 +1,13 @@
+import type { createGoogleGenerativeAI } from '@ai-sdk/google';
+import type { createOpenAI } from '@ai-sdk/openai';
+/**
+ * This is common interface for all v1 Vercel providers
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export type VercelProvider = ReturnType<typeof createOpenAI> | ReturnType<typeof createGoogleGenerativeAI>;
+/**
+ * ^^^^
+ * TODO: Is there some way to get the type of the provider directly,
+ *       NOT this stupid way via inferring the return type from a specific vercel provider⁉
+ */

package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts

@@ -0,0 +1,8 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { VercelExecutionToolsOptions } from './VercelExecutionToolsOptions';
+/**
+ * Adapter which creates Promptbook execution tools from Vercel provider
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export declare function createExecutionToolsFromVercelProvider(options: VercelExecutionToolsOptions): LlmExecutionTools;

package/esm/typings/src/llm-providers/vercel/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/other/templates/getBookTemplates.d.ts

@@ -0,0 +1,24 @@
+import { SetRequired } from 'type-fest';
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { NonEmptyReadonlyArray } from '../../types/NonEmptyArray';
+/**
+ * @@@
+ *
+ * @singleton
+ * @private internal cache of `getBookTemplate`
+ */
+export declare let pipelines: Array<SetRequired<PipelineJson, 'pipelineUrl'>> | null;
+/**
+ * Get template for new book
+ *
+ * @param formfactorName - optional filter for FORMFACTOR - get only pipelines for this formfactor
+ * @returns list of pipelines
+ * @public exported from `@promptbook/templates`
+ */
+export declare function getBookTemplates(formfactorName?: string_formfactor_name): NonEmptyReadonlyArray<SetRequired<PipelineJson, 'pipelineUrl'>>;
+/**
+ * TODO: Unit test + test that what we guarantee - always return non-empty array is true for e
+ * TODO: [🧠] Which is the best place for this function
+ * TODO: !!6 For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
+ */

package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineCollection } from '../../collection/PipelineCollection';
+/**
+ * Get pipeline collection for Untitled Promptbook project
+ *
+ * ⚠️ WARNING: This code has been generated by `@promptbook/cli` so that any manual changes will be overwritten
+ *
+ * @generated
+ * @returns {PipelineCollection} Library of promptbooks for Untitled Promptbook project
+ */
+export declare function getTemplatesPipelineCollection(): PipelineCollection;

package/esm/typings/src/personas/preparePersona.d.ts

@@ -0,0 +1,17 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PersonaPreparedJson } from '../pipeline/PipelineJson/PersonaJson';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { string_persona_description } from '../types/typeAliases';
+/**
+ * Prepares the persona for the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ * @public exported from `@promptbook/core`
+ */
+export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+/**
+ * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🏢] Check validity of `modelName` in pipeline
+ * TODO: [🏢] Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] Check validity of `temperature` in pipeline
+ */

package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts

@@ -0,0 +1,22 @@
+import type { InputParameterJson } from '../PipelineJson/ParameterJson';
+import type { OutputParameterJson } from '../PipelineJson/ParameterJson';
+/**
+ * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ */
+export type PipelineInterface = {
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly inputParameters: ReadonlyArray<InputParameterJson>;
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly outputParameters: ReadonlyArray<OutputParameterJson>;
+};

package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @@@
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GENERIC_PIPELINE_INTERFACE: {
+    readonly inputParameters: readonly [];
+    readonly outputParameters: readonly [];
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getPipelineInterface(pipeline: PipelineJson): PipelineInterface;