@promptbook/cli 0.62.2 → 0.63.0-0

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

@@ -1,29 +1,29 @@
-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`
- * TODO: [🛫] `prompt` is NOT fully serializable as JSON, it contains functions which are not serializable, fix it
- */
+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`
+ * TODO: [🛫] `prompt` is NOT fully serializable as JSON, it contains functions which are not serializable, fix it
+ */

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

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

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

@@ -1,19 +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
- */
-export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, options?: Partial<CacheLlmToolsOptions>): TLlmTools;
-/**
- * TODO: [🔼] !!! Export via `@promptbook/core`
- * 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
- */
+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

@@ -1,15 +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
- */
+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

@@ -1,17 +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
- */
-export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
-/**
- * TODO: [🔼] !!! Export via `@promptbookcore/`
- * 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
- */
+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

@@ -1,35 +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>;
-};
-/**
- * @@@
- */
-export declare function limitTotalUsage(llmTools: LlmExecutionTools, options?: Partial<LimitTotalUsageOptions>): LlmExecutionToolsWithTotalUsage;
-export {};
-/**
- * TODO: [🔼] !!! Export via `@promptbookcore/`
- * 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
- */
+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

@@ -1,50 +1,52 @@
-import type { AvailableModel } from '../../execution/LlmExecutionTools';
-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 { 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' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
-    /**
-     * 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
- * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
- * TODO: [🍜] Auto use anonymous server in browser
- */
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+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 { AnthropicClaudeExecutionToolsOptions } from './AnthropicClaudeExecutionToolsOptions';
+/**
+ * Execution Tools for calling Anthropic Claude API.
+ *
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+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' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
+    /**
+     * 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
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🍜] Auto use anonymous server in browser
+ */

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

@@ -1,11 +1,12 @@
-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;
-/**
- * TODO: [🍜] Auto add WebGPT / Promptbook.studio anonymous server in browser
- */ 
+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.
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+export type AnthropicClaudeExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions;
+/**
+ * TODO: [🍜] Auto add WebGPT / Promptbook.studio anonymous server in browser
+ */

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

@@ -1,22 +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
- */
+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

@@ -1,6 +1,6 @@
-#!/usr/bin/env ts-node
-export {};
-/**
- * TODO: [🍜] Playground with WebGPT / Promptbook.studio anonymous server
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
- */
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [🍜] Playground with WebGPT / Promptbook.studio anonymous server
+ * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

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

@@ -1,48 +1,50 @@
-import type { AvailableModel } from '../../execution/LlmExecutionTools';
-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.
- */
-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' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
-    /**
-     * Calls Azure OpenAI API to use a complete model.
-     */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
-    /**
-     * 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
- * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
- */
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+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 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' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
+    /**
+     * Calls Azure OpenAI API to use a complete model.
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+    /**
+     * 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
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ */

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

@@ -1,35 +1,36 @@
-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;
-};
+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/
+ * @public exported from `@promptbook/azure-openai`
+ */
+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;
+};