@promptbook/editable 0.94.0 → 0.98.0-10

package/esm/typings/src/_packages/types.index.d.ts

@@ -61,6 +61,8 @@ import type { Usage } from '../execution/Usage';
 import type { UsageCounts } from '../execution/Usage';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
+import type { ValidatePromptResultOptions } from '../execution/utils/validatePromptResult';
+import type { ValidatePromptResultResult } from '../execution/utils/validatePromptResult';
 import type { FormatSubvalueParser } from '../formats/_common/FormatSubvalueParser';
 import type { FormatSubvalueParserMapValuesOptions } from '../formats/_common/FormatSubvalueParser';
 import type { CsvSettings } from '../formats/csv/CsvSettings';
@@ -74,13 +76,16 @@ import type { CacheItem } from '../llm-providers/_common/utils/cache/CacheItem';
 import type { CacheLlmToolsOptions } from '../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { AnthropicClaudeExecutionToolsOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
-import type { AnthropicClaudeExecutionToolsDirectOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
+import type { AnthropicClaudeExecutionToolsNonProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions';
 import type { DeepseekExecutionToolsOptions } from '../llm-providers/deepseek/DeepseekExecutionToolsOptions';
 import type { GoogleExecutionToolsOptions } from '../llm-providers/google/GoogleExecutionToolsOptions';
 import type { OllamaExecutionToolsOptions } from '../llm-providers/ollama/OllamaExecutionToolsOptions';
 import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from '../llm-providers/openai/OpenAiCompatibleExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from '../llm-providers/openai/OpenAiCompatibleExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsProxiedOptions } from '../llm-providers/openai/OpenAiCompatibleExecutionToolsOptions';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import type { VercelExecutionToolsOptions } from '../llm-providers/vercel/VercelExecutionToolsOptions';
 import type { VercelProvider } from '../llm-providers/vercel/VercelProvider';
@@ -262,7 +267,7 @@ import type { number_percent } from '../types/typeAliases';
 import type { number_model_temperature } from '../types/typeAliases';
 import type { number_seed } from '../types/typeAliases';
 import type { number_likeness } from '../types/typeAliases';
-import type { number_miliseconds } from '../types/typeAliases';
+import type { number_milliseconds } from '../types/typeAliases';
 import type { number_seconds } from '../types/typeAliases';
 import type { number_minutes } from '../types/typeAliases';
 import type { number_hours } from '../types/typeAliases';
@@ -360,6 +365,8 @@ export type { Usage };
 export type { UsageCounts };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
+export type { ValidatePromptResultOptions };
+export type { ValidatePromptResultResult };
 export type { FormatSubvalueParser };
 export type { FormatSubvalueParserMapValuesOptions };
 export type { CsvSettings };
@@ -373,13 +380,16 @@ export type { CacheItem };
 export type { CacheLlmToolsOptions };
 export type { LlmExecutionToolsWithTotalUsage };
 export type { AnthropicClaudeExecutionToolsOptions };
-export type { AnthropicClaudeExecutionToolsDirectOptions };
+export type { AnthropicClaudeExecutionToolsNonProxiedOptions };
 export type { AnthropicClaudeExecutionToolsProxiedOptions };
 export type { AzureOpenAiExecutionToolsOptions };
 export type { DeepseekExecutionToolsOptions };
 export type { GoogleExecutionToolsOptions };
 export type { OllamaExecutionToolsOptions };
 export type { OpenAiAssistantExecutionToolsOptions };
+export type { OpenAiCompatibleExecutionToolsOptions };
+export type { OpenAiCompatibleExecutionToolsNonProxiedOptions };
+export type { OpenAiCompatibleExecutionToolsProxiedOptions };
 export type { OpenAiExecutionToolsOptions };
 export type { VercelExecutionToolsOptions };
 export type { VercelProvider };
@@ -561,7 +571,7 @@ export type { number_percent };
 export type { number_model_temperature };
 export type { number_seed };
 export type { number_likeness };
-export type { number_miliseconds };
+export type { number_milliseconds };
 export type { number_seconds };
 export type { number_minutes };
 export type { number_hours };

package/esm/typings/src/_packages/{wizzard.index.d.ts → wizard.index.d.ts}

@@ -11,8 +11,10 @@ import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-co
 import { _OllamaRegistration } from '../llm-providers/ollama/register-constructor';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { _OpenAiCompatibleMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
 import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
+import { _OpenAiCompatibleRegistration } from '../llm-providers/openai/register-constructor';
 import { _BoilerplateScraperRegistration } from '../scrapers/_boilerplate/register-constructor';
 import { _BoilerplateScraperMetadataRegistration } from '../scrapers/_boilerplate/register-metadata';
 import { _LegacyDocumentScraperRegistration } from '../scrapers/document-legacy/register-constructor';
@@ -27,7 +29,7 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
-import { wizzard } from '../wizzard/wizzard';
+import { wizard } from '../wizard/wizard';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { _AnthropicClaudeMetadataRegistration };
 export { _AnthropicClaudeRegistration };
@@ -41,8 +43,10 @@ export { _OllamaMetadataRegistration };
 export { _OllamaRegistration };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
+export { _OpenAiCompatibleMetadataRegistration };
 export { _OpenAiRegistration };
 export { _OpenAiAssistantRegistration };
+export { _OpenAiCompatibleRegistration };
 export { _BoilerplateScraperRegistration };
 export { _BoilerplateScraperMetadataRegistration };
 export { _LegacyDocumentScraperRegistration };
@@ -57,4 +61,4 @@ export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };
 export { _WebsiteScraperMetadataRegistration };
-export { wizzard };
+export { wizard };

package/esm/typings/src/cli/cli-commands/prettify.d.ts

@@ -8,7 +8,7 @@ import type { Command as Program } from 'commander';
  */
 export declare function $initializePrettifyCommand(program: Program): void;
 /**
- * TODO: [😶] Unite floder listing
+ * TODO: [😶] Unite folder listing
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks

package/esm/typings/src/cli/cli-commands/test-command.d.ts

@@ -8,7 +8,7 @@ import type { Command as Program } from 'commander';
  */
 export declare function $initializeTestCommand(program: Program): void;
 /**
- * TODO: [😶] Unite floder listing
+ * TODO: [😶] Unite folder listing
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks

package/esm/typings/src/config.d.ts

@@ -176,7 +176,7 @@ export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10;
+export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 7;
 /**
  * The maximum depth to which knowledge sources will be scraped when building a knowledge base.
  * This prevents infinite recursion and limits resource usage.

package/esm/typings/src/conversion/archive/loadArchive.d.ts

@@ -8,7 +8,7 @@ import type { string_filename } from '../../types/typeAliases';
  * @param fs Filesystem tools
  * @returns Pipelines loaded from the archive
  *
- * @private utility of Prompbook
+ * @private utility of Promptbook
  */
 export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<ReadonlyArray<PipelineJson>>;
 /**

package/esm/typings/src/conversion/archive/saveArchive.d.ts

@@ -1,6 +1,6 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { string_filename } from '../../types/typeAliases';
-import type { FilesystemTools } from '../../execution/FilesystemTools';
 /**
  * Saves the given books into an archive file with `.bookc` extension
  *
@@ -8,7 +8,7 @@ import type { FilesystemTools } from '../../execution/FilesystemTools';
  * @param books Pipelines to be saved in the archive
  * @param fs Filesystem tools
  *
- * @private utility of Prompbook
+ * @private utility of Promptbook
  */
 export declare function saveArchive(filePath: string_filename, collectionJson: ReadonlyArray<PipelineJson>, fs: FilesystemTools): Promise<void>;
 /**

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -2,7 +2,7 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_href } from '../../types/typeAliases';
 /**
- * Addtional options for rendering Mermaid graph
+ * Additional options for rendering Mermaid graph
  */
 export type renderPipelineMermaidOptions = {
     /**

package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts

@@ -2,7 +2,7 @@ import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
 import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
 /**
- * Delagates the user interaction to a async callback function
+ * Delegates the user interaction to a async callback function
  * You need to provide your own implementation of this callback function and its bind to UI.
  *
  * @public exported from `@promptbook/core`

package/esm/typings/src/execution/AbstractTaskResult.d.ts

@@ -11,11 +11,11 @@ export type AbstractTaskResult = {
      */
     readonly isSuccessful: boolean;
     /**
-     * Errors that occured during the execution, details are available in `executionReport`
+     * Errors that occurred during the execution, details are available in `executionReport`
      */
     readonly errors: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
     /**
-     * Warnings that occured during the execution, details are available in `executionReport`
+     * Warnings that occurred during the execution, details are available in `executionReport`
      */
     readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
 };

package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts

@@ -45,4 +45,12 @@ export type $OngoingTaskResult = {
      * List of errors encountered during script postprocessing or execution.
      */
     $scriptPipelineExecutionErrors: Array<Error>;
+    /**
+     * Array of all failed attempts, storing both the result string and the error for each failure
+     */
+    $failedResults: Array<{
+        attemptIndex: number;
+        result: string | null;
+        error: ExpectError;
+    }>;
 };

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts

@@ -35,7 +35,7 @@ export type CreatePipelineExecutorOptions = PrepareAndScrapeOptions & {
      *
      * @default false
      */
-    readonly isNotPreparedWarningSupressed?: boolean;
+    readonly isNotPreparedWarningSuppressed?: boolean;
 };
 /**
  * TODO: [🧎][🧠] Move `csvSettings` to some better place

package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts

@@ -8,7 +8,7 @@ import type { PromptResult } from '../PromptResult';
  */
 export type ExecutionPromptReportJson = {
     /**
-     * The prompt wich was executed
+     * The prompt which was executed
      */
     readonly prompt: Omit<Prompt, 'pipelineUrl'>;
     /**
@@ -16,7 +16,7 @@ export type ExecutionPromptReportJson = {
      */
     readonly result?: PromptResult;
     /**
-     * The error which occured during LLM execution or during postprocessing or expectation checking
+     * The error which occurred during LLM execution or during postprocessing or expectation checking
      *
      * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
      */

package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts

@@ -7,6 +7,6 @@ export declare function translateMessages({ automaticTranslator, from, to, }: {
     automaticTranslator: AutomaticTranslator;
 } & TranslatorOptions): Promise<void>;
 /**
- * TODO: [😶] Unite floder listing
+ * TODO: [😶] Unite folder listing
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/execution/utils/validatePromptResult.d.ts

@@ -0,0 +1,53 @@
+import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
+import { ExpectError } from '../../errors/ExpectError';
+import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
+/**
+ * Options for validating a prompt result
+ */
+export interface ValidatePromptResultOptions {
+    /**
+     * The result string to validate
+     */
+    resultString: string;
+    /**
+     * Expectations for the result (word count, sentence count, etc.)
+     */
+    expectations?: Expectations;
+    /**
+     * Expected format of the result (e.g., 'JSON')
+     */
+    format?: FormatCommand['format'];
+    /**
+     * List of postprocessing function names that should be applied
+     * Note: This is for validation purposes only - postprocessing should be done before calling this function
+     */
+    postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
+}
+/**
+ * Result of prompt result validation
+ */
+export interface ValidatePromptResultResult {
+    /**
+     * Whether the result is valid (passes all expectations and format checks)
+     */
+    isValid: boolean;
+    /**
+     * The processed result string (may be modified if format extraction was needed)
+     */
+    processedResultString: string;
+    /**
+     * Error that occurred during validation, if any
+     */
+    error?: ExpectError;
+}
+/**
+ * Validates a prompt result against expectations and format requirements.
+ * This function provides a common abstraction for result validation that can be used
+ * by both execution logic and caching logic to ensure consistency.
+ *
+ * @param options - The validation options including result string, expectations, and format
+ * @returns Validation result with processed string and validity status
+ * @private internal function of `createPipelineExecutor` and `cacheLlmTools`
+ */
+export declare function validatePromptResult(options: ValidatePromptResultOptions): ValidatePromptResultResult;

package/esm/typings/src/llm-providers/_common/register/{$provideLlmToolsForWizzardOrCli.d.ts → $provideLlmToolsForWizardOrCli.d.ts}

@@ -5,7 +5,7 @@ import type { string_url } from '../../../types/typeAliases';
 import type { really_any } from '../../../utils/organization/really_any';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
-type ProvideLlmToolsForWizzardOrCliOptions = {
+type ProvideLlmToolsForWizardOrCliOptions = {
     /**
      * If true, user will be always prompted for login
      *
@@ -48,7 +48,7 @@ type ProvideLlmToolsForWizzardOrCliOptions = {
  *
  * @private within the repository - for CLI utils
  */
-export declare function $provideLlmToolsForWizzardOrCli(options?: ProvideLlmToolsForWizzardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
+export declare function $provideLlmToolsForWizardOrCli(options?: ProvideLlmToolsForWizardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
 export {};
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

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

@@ -7,7 +7,7 @@ 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';
+import type { AnthropicClaudeExecutionToolsNonProxiedOptions } from './AnthropicClaudeExecutionToolsOptions';
 /**
  * Execution Tools for calling Anthropic Claude API.
  *
@@ -15,7 +15,7 @@ import type { AnthropicClaudeExecutionToolsDirectOptions } from './AnthropicClau
  * @deprecated use `createAnthropicClaudeExecutionTools` instead
  */
 export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools {
-    protected readonly options: AnthropicClaudeExecutionToolsDirectOptions;
+    protected readonly options: AnthropicClaudeExecutionToolsNonProxiedOptions;
     /**
      * Anthropic Claude API client.
      */
@@ -26,7 +26,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
      *
      * @param options which are relevant are directly passed to the Anthropic Claude client
      */
-    constructor(options?: AnthropicClaudeExecutionToolsDirectOptions);
+    constructor(options?: AnthropicClaudeExecutionToolsNonProxiedOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     getClient(): Promise<Anthropic>;

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

@@ -7,14 +7,14 @@ import type { RemoteClientOptions } from '../../remote-server/types/RemoteClient
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
  * @public exported from `@promptbook/anthropic-claude`
  */
-export type AnthropicClaudeExecutionToolsOptions = AnthropicClaudeExecutionToolsDirectOptions | AnthropicClaudeExecutionToolsProxiedOptions;
+export type AnthropicClaudeExecutionToolsOptions = AnthropicClaudeExecutionToolsNonProxiedOptions | 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 & {
+export type AnthropicClaudeExecutionToolsNonProxiedOptions = CommonToolsOptions & ClientOptions & {
     isProxied?: false;
 };
 /**

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

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AnthropicClaudeMetadataRegistration: Registration;

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

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/wizzard`
+ * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  *
  */

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

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AzureOpenAiMetadataRegistration: Registration;

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

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/wizzard`
+ * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AzureOpenAiRegistration: Registration;

package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _DeepseekMetadataRegistration: Registration;

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

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/deepseek`
- * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _DeepseekRegistration: Registration;

package/esm/typings/src/llm-providers/google/register-configuration.d.ts

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _GoogleMetadataRegistration: Registration;

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

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/google`
- * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _GoogleRegistration: Registration;

package/esm/typings/src/llm-providers/ollama/register-configuration.d.ts

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OllamaMetadataRegistration: Registration;

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

@@ -5,7 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * 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/ollama`
- * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OllamaRegistration: Registration;

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

@@ -29,7 +29,7 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     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 there can be some wizard for those 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

@@ -1,12 +1,12 @@
 import type { ClientOptions } from 'openai';
 import type { string_token } from '../../types/typeAliases';
-import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
  * Options for `createOpenAiAssistantExecutionTools` and `OpenAiAssistantExecutionTools`
  *
  * @public exported from `@promptbook/openai`
  */
-export type OpenAiAssistantExecutionToolsOptions = OpenAiExecutionToolsOptions & ClientOptions & {
+export type OpenAiAssistantExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions & ClientOptions & {
     /**
      * Which assistant to use
      */

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

@@ -11,14 +11,14 @@ import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_model_name } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
 import { computeOpenAiUsage } from './computeOpenAiUsage';
-import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
- * Execution Tools for calling OpenAI API or other OpeenAI compatible provider
+ * Execution Tools for calling OpenAI API or other OpenAI compatible provider
  *
  * @public exported from `@promptbook/openai`
  */
 export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecutionTools {
-    protected readonly options: OpenAiExecutionToolsOptions;
+    protected readonly options: OpenAiCompatibleExecutionToolsNonProxiedOptions;
     /**
      * OpenAI API client.
      */
@@ -32,7 +32,7 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      *
      * @param options which are relevant are directly passed to the OpenAI compatible client
      */
-    constructor(options: OpenAiExecutionToolsOptions);
+    constructor(options: OpenAiCompatibleExecutionToolsNonProxiedOptions);
     abstract get title(): string_title & string_markdown_text;
     abstract get description(): string_markdown;
     getClient(): Promise<OpenAI>;

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

@@ -0,0 +1,52 @@
+import type { ClientOptions } from 'openai';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
+/**
+ * Options for `createOpenAiCompatibleExecutionTools` and `OpenAiCompatibleExecutionTools`
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiCompatibleExecutionTools`.
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiCompatibleExecutionToolsOptions = OpenAiCompatibleExecutionToolsNonProxiedOptions | OpenAiCompatibleExecutionToolsProxiedOptions;
+/**
+ * Options for directly used `OpenAiCompatibleExecutionTools`
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiCompatibleExecutionToolsNonProxiedOptions = CommonToolsOptions & ClientOptions & {
+    /**
+     * Base URL for the OpenAI-compatible API endpoint
+     *
+     * This allows connecting to any OpenAI-compatible LLM service by specifying their API endpoint.
+     *
+     * @example 'https://https://promptbook.s5.ptbk.io/' (Promptbook)
+     * @example 'https://api.openai.com/v1' (OpenAI)
+     * @example 'http://localhost:11434/v1' (Ollama)
+     * @example 'https://api.deepseek.com/v1' (DeepSeek)
+     */
+    baseURL?: string;
+    isProxied?: false;
+};
+/**
+ * Options for proxied `OpenAiCompatibleExecutionTools`
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiCompatibleExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
+    /**
+     * Base URL for the OpenAI-compatible API endpoint
+     *
+     * This allows connecting to any OpenAI-compatible LLM service by specifying their API endpoint.
+     *
+     * @example 'https://https://promptbook.s5.ptbk.io/' (Promptbook)
+     * @example 'https://api.openai.com/v1' (OpenAI)
+     * @example 'http://localhost:11434/v1' (Ollama)
+     * @example 'https://api.deepseek.com/v1' (DeepSeek)
+     */
+    baseURL?: string;
+    isProxied: true;
+} & Pick<RemoteClientOptions<undefined>, 'remoteServerUrl'>;

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

@@ -1,11 +1,9 @@
-import type { ClientOptions } from 'openai';
-import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
  * Options for `createOpenAiExecutionTools` and `OpenAiExecutionTools`
  *
- * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
- * Rest is used by the `OpenAiExecutionTools`.
+ * This extends OpenAiCompatibleExecutionToolsOptions.
  *
  * @public exported from `@promptbook/openai`
  */
-export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions;
+export type OpenAiExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions;