@promptbook/vercel 0.76.0

package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts

@@ -0,0 +1,28 @@
+import type { string_name } from '../../../types/typeAliases';
+import type { string_title } from '../../../types/typeAliases';
+import type { Registered } from '../../../utils/$Register';
+import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
+/**
+ * @@@
+ *
+ * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
+ */
+export type LlmToolsMetadata = Registered & {
+    /**
+     * @@@
+     */
+    readonly title: string_title;
+    /**
+     * @@@
+     */
+    getBoilerplateConfiguration(): LlmToolsConfiguration[number];
+    /**
+     * @@@
+     */
+    createConfigurationFromEnv(env: Record<string_name, string>): LlmToolsConfiguration[number] | null;
+};
+/**
+ * TODO: Add configuration schema and maybe some documentation link
+ * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
+ * TODO: [®] DRY Register logic
+ */

package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts

@@ -0,0 +1,10 @@
+import type { TODO_object } from '../../../utils/organization/TODO_object';
+/**
+ * @@@
+ *
+ * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
+ */
+export type LlmToolsOptions = TODO_object;
+/**
+ * TODO: [®] DRY Register logic
+ */

package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts

@@ -0,0 +1,40 @@
+import type { string_user_id } from '../../../types/typeAliases';
+import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
+import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
+/**
+ * Options for `$provideLlmToolsFromEnv`
+ *
+ * @private internal type for `$provideLlmToolsFromEnv` and `$provideLlmToolsForTestingAndScriptsAndPlayground`
+ */
+export type CreateLlmToolsFromConfigurationOptions = {
+    /**
+     * This will will be passed to the created `LlmExecutionTools`
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * Identifier of the end user
+     *
+     * Note: This is passed to the LLM tools providers to identify misuse
+     */
+    readonly userId?: string_user_id | null;
+};
+/**
+ * @@@
+ *
+ * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
+ *
+ * @returns @@@
+ * @public exported from `@promptbook/core`
+ */
+export declare function createLlmToolsFromConfiguration(configuration: LlmToolsConfiguration, options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
+/**
+ * TODO: [🎌] Together with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
+ * TODO: [🧠][🎌] Dynamically install required providers
+ * TODO: @@@ write discussion about this - wizzard
+ * TODO: [🧠][🍛] Which name is better `createLlmToolsFromConfig` or `createLlmToolsFromConfiguration`?
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: This should be maybe not under `_common` but under `utils`
+ * TODO: [®] DRY Register logic
+ */

package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts

@@ -0,0 +1,28 @@
+import type { PromptResult } from '../../../../execution/PromptResult';
+import type { Prompt } from '../../../../types/Prompt';
+import type { string_date_iso8601 } from '../../../../types/typeAliases';
+import type { string_promptbook_version } from '../../../../version';
+/**
+ * @@@
+ */
+export type CacheItem = {
+    /**
+     * @@@
+     */
+    date: string_date_iso8601;
+    /**
+     * @@@
+     */
+    promptbookVersion?: string_promptbook_version;
+    /**
+     * @@@
+     */
+    prompt: Prompt;
+    /**
+     * @@@
+     */
+    promptResult: PromptResult;
+};
+/**
+ * TODO: [🧠] Should be this exported alongsite `cacheLlmTools` through `@promptbook/utils` OR through `@promptbook/types`
+ */

package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts

@@ -0,0 +1,19 @@
+import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
+import type { CacheItem } from './CacheItem';
+/**
+ * @@@
+ */
+export type CacheLlmToolsOptions = {
+    /**
+     * @@@
+     *
+     * @default MemoryStorage
+     */
+    storage: PromptbookStorage<CacheItem>;
+    /**
+     * @@@
+     *
+     * @default false
+     */
+    isCacheReloaded?: boolean;
+};

package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -0,0 +1,19 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * Note: It can take extended `LlmExecutionTools` and cache the
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting, it can contain extra methods like `totalUsage`
+ * @returns LLM tools with same functionality with added total cost counting
+ * @public exported from `@promptbook/core`
+ */
+export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, options?: Partial<CacheLlmToolsOptions>): TLlmTools;
+/**
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ *            @@@ write discussion about this and storages
+ *            @@@ write how to combine multiple interceptors
+ */

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts

@@ -0,0 +1,15 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+/**
+ * LLM tools with option to get total usage of the execution
+ */
+export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
+    /**
+     * Get total cost of the execution up to this point
+     */
+    getTotalUsage(): PromptResultUsage;
+};
+/**
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * Note: [🥫] Not using getter `get totalUsage` but `getTotalUsage` to allow this object to be proxied
+ */

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts

@@ -0,0 +1,17 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting
+ * @returns LLM tools with same functionality with added total cost counting
+ * @public exported from `@promptbook/core`
+ */
+export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
+/**
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
+ *     > const [llmToolsWithUsage,getUsage] = countTotalUsage(llmTools);
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ */

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts

@@ -0,0 +1,36 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
+import type { TODO_any } from '../../../../utils/organization/TODO_any';
+import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
+/**
+ * Options for `limitTotalUsage`
+ */
+type LimitTotalUsageOptions = {
+    /**
+     * @@@
+     *
+     * @default ZERO_USAGE
+     */
+    maxTotalUsage: PromptResultUsage;
+    /**
+     * @@@
+     *
+     * @default MemoryStorage
+     */
+    storage: PromptbookStorage<TODO_any>;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function limitTotalUsage(llmTools: LlmExecutionTools, options?: Partial<LimitTotalUsageOptions>): LlmExecutionToolsWithTotalUsage;
+export {};
+/**
+ * TODO: Maybe internally use `countTotalUsage`
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ */

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

@@ -0,0 +1,60 @@
+import Anthropic from '@anthropic-ai/sdk';
+import type { AvailableModel } from '../../execution/AvailableModel';
+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 { AnthropicClaudeExecutionToolsDirectOptions } from './AnthropicClaudeExecutionToolsOptions';
+/**
+ * Execution Tools for calling Anthropic Claude API.
+ *
+ * @public exported from `@promptbook/anthropic-claude`
+ * @deprecated use `createAnthropicClaudeExecutionTools` instead
+ */
+export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools {
+    protected readonly options: AnthropicClaudeExecutionToolsDirectOptions;
+    /**
+     * Anthropic Claude API client.
+     */
+    private client;
+    /**
+     * Creates Anthropic Claude Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the Anthropic Claude client
+     */
+    constructor(options?: AnthropicClaudeExecutionToolsDirectOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    getClient(): Promise<Anthropic>;
+    /**
+     * Check the `options` passed to `constructor`
+     */
+    checkConfiguration(): Promise<void>;
+    /**
+     * List all available Anthropic Claude models that can be used
+     */
+    listModels(): ReadonlyArray<AvailableModel>;
+    /**
+     * Calls Anthropic Claude API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
+    /**
+     * Get the model that should be used as default
+     */
+    private getDefaultModel;
+    /**
+     * Default model for chat variant.
+     */
+    private getDefaultChatModel;
+}
+/**
+ * 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
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
+ * TODO: [📅] Maybe instead of `RemoteLlmExecutionToolsOptions` use `proxyWithAnonymousRemoteServer` (if implemented)
+ */

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

@@ -0,0 +1,31 @@
+import type { ClientOptions } from '@anthropic-ai/sdk';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { RemoteLlmExecutionToolsOptions } from '../remote/interfaces/RemoteLlmExecutionToolsOptions';
+/**
+ * Options for `AnthropicClaudeExecutionTools`
+ *
+ * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+export type AnthropicClaudeExecutionToolsOptions = AnthropicClaudeExecutionToolsDirectOptions | AnthropicClaudeExecutionToolsProxiedOptions;
+/**
+ * Options for directly used `AnthropicClaudeExecutionTools`
+ *
+ * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & ClientOptions & {
+    isProxied?: false;
+};
+/**
+ * Options for proxied `AnthropicClaudeExecutionTools`
+ *
+ * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
+    isProxied: true;
+} & Pick<RemoteLlmExecutionToolsOptions<undefined>, 'remoteUrl' | 'path'>;
+/**
+ * TODO: [🧠][🤺] Pass `userId`
+ */

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

@@ -0,0 +1,24 @@
+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: ReadonlyArray<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
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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,13 @@
+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;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -0,0 +1,14 @@
+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"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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 {
+    protected readonly options: AzureOpenAiExecutionToolsOptions;
+    /**
+     * 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<ReadonlyArray<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,37 @@
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { string_name } from '../../types/typeAliases';
+import type { string_token } from '../../types/typeAliases';
+import type { string_user_id } 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 userId: string_user_id | null;
+};

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,13 @@
+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;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -0,0 +1,14 @@
+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"
+ * 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
+ */