@promptbook/azure-openai 0.100.0-4 → 0.100.0-40

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

@@ -281,6 +281,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_IS_AUTO_INSTALLED = false;
+/**
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_TASK_SIMULATED_DURATION_MS: number;
 /**
  * Function name for generated function via `ptbk make` to get the pipeline collection
  *

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

@@ -40,6 +40,10 @@ export type AvailableModel = {
         readonly prompt: number_usd;
         readonly output: number_usd;
     };
+    /**
+     * If the model is deprecated, it should not be used for new tasks
+     */
+    readonly isDeprecated?: boolean;
 };
 /**
  * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`

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

@@ -1,5 +1,6 @@
 import type { Observable } from 'rxjs';
 import { PartialDeep } from 'type-fest';
+import type { number_percent } from '../types/typeAliases';
 import type { task_id } from '../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_promptbook_version } from '../version';
@@ -28,6 +29,19 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
          */
         readonly title?: AbstractTask<TTaskResult>['title'];
     }) => void): Promise<TTaskResult>;
+    /**
+     * Optional callback to provide custom tldr information
+     * @param createdAt When the task was created
+     * @param status Current task status
+     * @param currentValue Current partial result
+     * @param errors Current errors
+     * @param warnings Current warnings
+     * @returns Custom tldr information
+     */
+    tldrProvider?(createdAt: Date, status: task_status, currentValue: PartialDeep<TTaskResult>, errors: Array<Error>, warnings: Array<Error>): {
+        readonly percent: number_percent;
+        readonly message: string;
+    };
 };
 /**
  * Helper to create a new task
@@ -80,6 +94,19 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Status of the task
      */
     readonly status: task_status;
+    /**
+     * Short summary of the task status for quick overview in the UI
+     */
+    readonly tldr: {
+        /**
+         * Progress in percentage from 0 to 1 (100%) that can be used to display a progress bar
+         */
+        readonly percent: number_percent;
+        /**
+         * Short summary message of the task status that can be displayed in the UI
+         */
+        readonly message: string;
+    };
     /**
      * Date when the task was created
      */

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,10 +1,11 @@
-import type { ReadonlyDeep, WritableDeep } from 'type-fest';
+import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters } from '../../types/typeAliases';
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * Options for executing attempts of a pipeline task, including configuration for jokers, priority,
@@ -46,6 +47,10 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
      * The pipeline structure prepared for execution, as a deeply immutable PipelineJson object.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * Callback invoked with partial results as the execution progresses.
+     */
+    onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
     /**
      * The execution report object, which is updated during execution.
      */

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

@@ -2,7 +2,6 @@ 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 { 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';
@@ -42,10 +41,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
      * Calls Anthropic Claude API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
-    /**
-     * Calls Anthropic Claude API to use a completion model.
-     */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * Get the model that should be used as default
      */

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

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Anthropic Claude models with pricing
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`

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

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Deepseek models with descriptions
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://www.deepseek.com/models
  * @public exported from `@promptbook/deepseek`

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

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Google models with descriptions
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://ai.google.dev/models/gemini
  * @public exported from `@promptbook/google`

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

@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
 /**
  * List of available models in Ollama library
  *
- * Note: Done at 2025-05-19
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://ollama.com/library
  * @public exported from `@promptbook/ollama`

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

@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
 /**
  * List of available OpenAI models with pricing
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://platform.openai.com/docs/models/
  * @see https://openai.com/api/pricing/

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -1,3 +1,4 @@
+import type { string_book } from '../book-2.0/agent-source/string_book';
 import type { PipelineString } from './PipelineString';
 /**
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
@@ -12,7 +13,7 @@ import type { PipelineString } from './PipelineString';
  * @returns the pipeline string
  * @public exported from `@promptbook/core`
  */
-export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): string_book & PipelineString;
 /**
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/types/ModelRequirements.d.ts

@@ -87,8 +87,6 @@ export type CommonModelRequirements = {
     readonly seed?: number_seed;
     /**
      * Maximum number of tokens that can be generated by the model
-     *
-     * Note: [🌾]
      */
     readonly maxTokens?: number;
 };

package/esm/typings/src/types/typeAliases.d.ts

@@ -136,6 +136,12 @@ export type ReservedParameters = Record<string_reserved_parameter_name, string_p
  * For example `"Ai*nautes"`
  */
 export type string_title = string;
+/**
+ * Semantic helper
+ *
+ * For example `"My AI Assistant"`
+ */
+export type string_agent_name = string;
 /**
  * Unstructured description of the persona
  *

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

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.100.0-3`).
+ * It follows semantic versioning (e.g., `0.100.0-39`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/azure-openai",
-    "version": "0.100.0-4",
+    "version": "0.100.0-40",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -105,7 +105,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/azure-openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0-4"
+        "@promptbook/core": "0.100.0-40"
     },
     "dependencies": {
         "@azure/openai": "1.0.0-beta.12",

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-4';
+    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-40';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1212,7 +1212,7 @@
     /**
      * List of available OpenAI models with pricing
      *
-     * Note: Done at 2025-05-06
+     * Note: Synced with official API docs at 2025-08-20
      *
      * @see https://platform.openai.com/docs/models/
      * @see https://openai.com/api/pricing/
@@ -1221,6 +1221,138 @@
     const OPENAI_MODELS = exportJson({
         name: 'OPENAI_MODELS',
         value: [
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'gpt-5',
+                modelName: 'gpt-5',
+                modelDescription: "OpenAI's most advanced language model with unprecedented reasoning capabilities and 200K context window. Features revolutionary improvements in complex problem-solving, scientific reasoning, and creative tasks. Demonstrates human-level performance across diverse domains with enhanced safety measures and alignment. Represents the next generation of AI with superior understanding, nuanced responses, and advanced multimodal capabilities.",
+                pricing: {
+                    prompt: pricing(`$1.25 / 1M tokens`),
+                    output: pricing(`$10.00 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'gpt-5-mini',
+                modelName: 'gpt-5-mini',
+                modelDescription: "A faster, cost-efficient version of GPT-5 for well-defined tasks with 200K context window. Maintains core GPT-5 capabilities while offering 5x faster inference and significantly lower costs. Features enhanced instruction following and reduced latency for production applications requiring quick responses with high quality.",
+                pricing: {
+                    prompt: pricing(`$0.25 / 1M tokens`),
+                    output: pricing(`$2.00 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'gpt-5-nano',
+                modelName: 'gpt-5-nano',
+                modelDescription: "The fastest, most cost-efficient version of GPT-5 with 200K context window. Optimized for summarization, classification, and simple reasoning tasks. Features 10x faster inference than base GPT-5 while maintaining good quality for straightforward applications. Ideal for high-volume, cost-sensitive deployments.",
+                pricing: {
+                    prompt: pricing(`$0.05 / 1M tokens`),
+                    output: pricing(`$0.40 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'gpt-4.1',
+                modelName: 'gpt-4.1',
+                modelDescription: "Smartest non-reasoning model with 128K context window. Enhanced version of GPT-4 with improved instruction following, better factual accuracy, and reduced hallucinations. Features advanced function calling capabilities and superior performance on coding tasks. Ideal for applications requiring high intelligence without reasoning overhead.",
+                pricing: {
+                    prompt: pricing(`$3.00 / 1M tokens`),
+                    output: pricing(`$12.00 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'gpt-4.1-mini',
+                modelName: 'gpt-4.1-mini',
+                modelDescription: "Smaller, faster version of GPT-4.1 with 128K context window. Balances intelligence and efficiency with 3x faster inference than base GPT-4.1. Maintains strong capabilities across text generation, reasoning, and coding while offering better cost-performance ratio for most applications.",
+                pricing: {
+                    prompt: pricing(`$0.80 / 1M tokens`),
+                    output: pricing(`$3.20 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'gpt-4.1-nano',
+                modelName: 'gpt-4.1-nano',
+                modelDescription: "Fastest, most cost-efficient version of GPT-4.1 with 128K context window. Optimized for high-throughput applications requiring good quality at minimal cost. Features 5x faster inference than GPT-4.1 while maintaining adequate performance for most general-purpose tasks.",
+                pricing: {
+                    prompt: pricing(`$0.20 / 1M tokens`),
+                    output: pricing(`$0.80 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'o3',
+                modelName: 'o3',
+                modelDescription: "Advanced reasoning model with 128K context window specializing in complex logical, mathematical, and analytical tasks. Successor to o1 with enhanced step-by-step problem-solving capabilities and superior performance on STEM-focused problems. Ideal for professional applications requiring deep analytical thinking and precise reasoning.",
+                pricing: {
+                    prompt: pricing(`$15.00 / 1M tokens`),
+                    output: pricing(`$60.00 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'o3-pro',
+                modelName: 'o3-pro',
+                modelDescription: "Enhanced version of o3 with more compute allocated for better responses on the most challenging problems. Features extended reasoning time and improved accuracy on complex analytical tasks. Designed for applications where maximum reasoning quality is more important than response speed.",
+                pricing: {
+                    prompt: pricing(`$30.00 / 1M tokens`),
+                    output: pricing(`$120.00 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'o4-mini',
+                modelName: 'o4-mini',
+                modelDescription: "Fast, cost-efficient reasoning model with 128K context window. Successor to o1-mini with improved analytical capabilities while maintaining speed advantages. Features enhanced mathematical reasoning and logical problem-solving at significantly lower cost than full reasoning models.",
+                pricing: {
+                    prompt: pricing(`$4.00 / 1M tokens`),
+                    output: pricing(`$16.00 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'o3-deep-research',
+                modelName: 'o3-deep-research',
+                modelDescription: "Most powerful deep research model with 128K context window. Specialized for comprehensive research tasks, literature analysis, and complex information synthesis. Features advanced citation capabilities and enhanced factual accuracy for academic and professional research applications.",
+                pricing: {
+                    prompt: pricing(`$25.00 / 1M tokens`),
+                    output: pricing(`$100.00 / 1M tokens`),
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'o4-mini-deep-research',
+                modelName: 'o4-mini-deep-research',
+                modelDescription: "Faster, more affordable deep research model with 128K context window. Balances research capabilities with cost efficiency, offering good performance on literature review, fact-checking, and information synthesis tasks at a more accessible price point.",
+                pricing: {
+                    prompt: pricing(`$12.00 / 1M tokens`),
+                    output: pricing(`$48.00 / 1M tokens`),
+                },
+            },
+            /**/
             /*/
               {
                   modelTitle: 'dall-e-3',
@@ -1741,7 +1873,6 @@
                 const modelName = prompt.modelRequirements.modelName || this.options.deploymentName;
                 const modelSettings = {
                     maxTokens: modelRequirements.maxTokens,
-                    //                                      <- TODO: [🌾] Make some global max cap for maxTokens
                     temperature: modelRequirements.temperature,
                     user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
                     // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
@@ -1847,8 +1978,7 @@
             try {
                 const modelName = prompt.modelRequirements.modelName || this.options.deploymentName;
                 const modelSettings = {
-                    maxTokens: modelRequirements.maxTokens || 2000,
-                    //                                                  <- TODO: [🌾] Make some global max cap for maxTokens
+                    maxTokens: modelRequirements.maxTokens,
                     temperature: modelRequirements.temperature,
                     user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
                     // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools