@juspay/neurolink 8.5.0 → 8.6.0

package/dist/lib/core/modules/MessageBuilder.js

@@ -63,6 +63,8 @@ export class MessageBuilder {
                 enableEvaluation: options.enableEvaluation,
                 context: options.context,
                 conversationHistory: options.conversationMessages,
+                schema: options.schema,
+                output: options.output,
             };
             messages = await buildMultimodalMessagesArray(multimodalOptions, this.providerName, this.modelName);
         }
@@ -143,6 +145,8 @@ export class MessageBuilder {
                 context: options.context,
                 conversationHistory: options
                     .conversationMessages,
+                schema: options.schema,
+                output: options.output,
             };
             messages = await buildMultimodalMessagesArray(multimodalOptions, this.providerName, this.modelName);
         }

package/dist/lib/core/modules/TelemetryHandler.js

@@ -120,12 +120,17 @@ export class TelemetryHandler {
         if (!this.neurolink?.isTelemetryEnabled()) {
             return undefined;
         }
-        const functionId = `${this.providerName}-${operationType}-${nanoid()}`;
+        const context = options.context;
+        const traceName = context?.traceName;
+        const userId = context?.userId;
+        const functionId = traceName ? traceName : userId ? userId : "guest";
         const metadata = {
             provider: this.providerName,
             model: this.modelName,
             toolsEnabled: !options.disableTools,
             neurolink: true,
+            operationType,
+            originalProvider: this.providerName,
         };
         // Add sessionId if available
         if ("sessionId" in options && options.sessionId) {

package/dist/lib/middleware/builtin/guardrails.js

@@ -69,8 +69,10 @@ export function createGuardrailsMiddleware(config = {}) {
                 };
             }
             const { stream, ...rest } = await doStream();
+            let hasYieldedChunks = false;
             const transformStream = new TransformStream({
                 transform(chunk, controller) {
+                    hasYieldedChunks = true;
                     let filteredChunk = chunk;
                     if (typeof filteredChunk === "object" &&
                         "textDelta" in filteredChunk) {
@@ -84,6 +86,11 @@ export function createGuardrailsMiddleware(config = {}) {
                     }
                     controller.enqueue(filteredChunk);
                 },
+                flush() {
+                    if (!hasYieldedChunks) {
+                        logger.warn(`[GuardrailsMiddleware] Stream ended without yielding any chunks`);
+                    }
+                },
             });
             return {
                 stream: stream.pipeThrough(transformStream),

package/dist/lib/models/modelRegistry.js

@@ -188,6 +188,99 @@ export const MODEL_REGISTRY = {
         category: "general",
     },
     // Anthropic Models
+    [AnthropicModels.CLAUDE_OPUS_4_5]: {
+        id: AnthropicModels.CLAUDE_OPUS_4_5,
+        name: "Claude Opus 4.5",
+        provider: AIProviderName.ANTHROPIC,
+        description: "Anthropic's most capable model with exceptional reasoning, coding, and multimodal capabilities",
+        capabilities: {
+            vision: true,
+            functionCalling: true,
+            codeGeneration: true,
+            reasoning: true,
+            multimodal: true,
+            streaming: true,
+            jsonMode: false,
+        },
+        pricing: {
+            inputCostPer1K: 0.015,
+            outputCostPer1K: 0.075,
+            currency: "USD",
+        },
+        performance: {
+            speed: "medium",
+            quality: "high",
+            accuracy: "high",
+        },
+        limits: {
+            maxContextTokens: 200000,
+            maxOutputTokens: 64000,
+            maxRequestsPerMinute: 50,
+        },
+        useCases: {
+            coding: 10,
+            creative: 10,
+            analysis: 10,
+            conversation: 9,
+            reasoning: 10,
+            translation: 9,
+            summarization: 9,
+        },
+        aliases: [
+            "claude-4.5-opus",
+            "claude-opus-latest",
+            "opus-4.5",
+            "anthropic-flagship",
+        ],
+        deprecated: false,
+        isLocal: false,
+        releaseDate: "2025-11-24",
+        category: "reasoning",
+    },
+    [AnthropicModels.CLAUDE_SONNET_4_5]: {
+        id: AnthropicModels.CLAUDE_SONNET_4_5,
+        name: "Claude Sonnet 4.5",
+        provider: AIProviderName.ANTHROPIC,
+        description: "Balanced Claude model with excellent performance across all tasks including vision and reasoning",
+        capabilities: {
+            vision: true,
+            functionCalling: true,
+            codeGeneration: true,
+            reasoning: true,
+            multimodal: true,
+            streaming: true,
+            jsonMode: false,
+        },
+        pricing: {
+            inputCostPer1K: 0.003,
+            outputCostPer1K: 0.015,
+            currency: "USD",
+        },
+        performance: {
+            speed: "medium",
+            quality: "high",
+            accuracy: "high",
+        },
+        limits: {
+            maxContextTokens: 200000,
+            maxOutputTokens: 64000,
+            maxRequestsPerMinute: 100,
+        },
+        useCases: {
+            coding: 10,
+            creative: 9,
+            analysis: 9,
+            conversation: 9,
+            reasoning: 10,
+            translation: 8,
+            summarization: 8,
+        },
+        aliases: ["claude-4.5-sonnet", "claude-sonnet-latest", "sonnet-4.5"],
+        deprecated: false,
+        isLocal: false,
+        releaseDate: "2025-09-29",
+        category: "coding",
+    },
     [AnthropicModels.CLAUDE_4_5_HAIKU]: {
         id: AnthropicModels.CLAUDE_4_5_HAIKU,
         name: "Claude 4.5 Haiku",

package/dist/lib/neurolink.js

@@ -1998,19 +1998,85 @@ Current user's request: ${currentInput}`;
                     }
                 }
                 const { stream: mcpStream, provider: providerName } = await this.createMCPStream(enhancedOptions);
-                // Create a wrapper around the stream that accumulates content
                 let accumulatedContent = "";
+                let chunkCount = 0;
+                const metadata = {
+                    fallbackAttempted: false,
+                    guardrailsBlocked: false,
+                    error: undefined,
+                };
                 const processedStream = (async function* (self) {
                     try {
                         for await (const chunk of mcpStream) {
+                            chunkCount++;
                             if (chunk &&
                                 "content" in chunk &&
                                 typeof chunk.content === "string") {
                                 accumulatedContent += chunk.content;
-                                // Emit chunk event for compatibility
                                 self.emitter.emit("response:chunk", chunk.content);
                             }
-                            yield chunk; // Preserve original streaming behavior
+                            yield chunk;
+                        }
+                        if (chunkCount === 0 && !metadata.fallbackAttempted) {
+                            metadata.fallbackAttempted = true;
+                            const errorMsg = "Stream completed with 0 chunks (possible guardrails block)";
+                            metadata.error = errorMsg;
+                            const fallbackRoute = ModelRouter.getFallbackRoute(originalPrompt || enhancedOptions.input.text || "", {
+                                provider: providerName,
+                                model: enhancedOptions.model || "gpt-4o",
+                                reasoning: "primary failed",
+                                confidence: 0.5,
+                            }, { fallbackStrategy: "auto" });
+                            logger.warn("Retrying with fallback provider", {
+                                originalProvider: providerName,
+                                fallbackProvider: fallbackRoute.provider,
+                                reason: errorMsg,
+                            });
+                            try {
+                                const fallbackProvider = await AIProviderFactory.createProvider(fallbackRoute.provider, fallbackRoute.model);
+                                // Ensure fallback provider can execute tools
+                                fallbackProvider.setupToolExecutor({
+                                    customTools: self.getCustomTools(),
+                                    executeTool: self.executeTool.bind(self),
+                                }, "NeuroLink.fallbackStream");
+                                // Get conversation messages for context (same as primary stream)
+                                const conversationMessages = await getConversationMessages(self.conversationMemory, {
+                                    prompt: enhancedOptions.input.text,
+                                    context: enhancedOptions.context,
+                                });
+                                const fallbackResult = await fallbackProvider.stream({
+                                    ...enhancedOptions,
+                                    model: fallbackRoute.model,
+                                    conversationMessages,
+                                });
+                                let fallbackChunkCount = 0;
+                                for await (const fallbackChunk of fallbackResult.stream) {
+                                    fallbackChunkCount++;
+                                    if (fallbackChunk &&
+                                        "content" in fallbackChunk &&
+                                        typeof fallbackChunk.content === "string") {
+                                        accumulatedContent += fallbackChunk.content;
+                                        self.emitter.emit("response:chunk", fallbackChunk.content);
+                                    }
+                                    yield fallbackChunk;
+                                }
+                                if (fallbackChunkCount === 0) {
+                                    throw new Error(`Fallback provider ${fallbackRoute.provider} also returned 0 chunks`);
+                                }
+                                // Fallback succeeded - likely guardrails blocked primary
+                                metadata.guardrailsBlocked = true;
+                            }
+                            catch (fallbackError) {
+                                const fallbackErrorMsg = fallbackError instanceof Error
+                                    ? fallbackError.message
+                                    : String(fallbackError);
+                                metadata.error = `${errorMsg}; Fallback failed: ${fallbackErrorMsg}`;
+                                logger.error("Fallback provider failed", {
+                                    fallbackProvider: fallbackRoute.provider,
+                                    error: fallbackErrorMsg,
+                                });
+                                throw fallbackError;
+                            }
                         }
                     }
                     finally {
@@ -2053,7 +2119,7 @@ Current user's request: ${currentInput}`;
                         }
                     }
                 })(this);
-                const streamResult = await this.processStreamResult(mcpStream, enhancedOptions, factoryResult);
+                const streamResult = await this.processStreamResult(processedStream, enhancedOptions, factoryResult);
                 const responseTime = Date.now() - startTime;
                 this.emitStreamEndEvents(streamResult);
                 return this.createStreamResponse(streamResult, processedStream, {
@@ -2062,7 +2128,9 @@ Current user's request: ${currentInput}`;
                     startTime,
                     responseTime,
                     streamId,
-                    fallback: false,
+                    fallback: metadata.fallbackAttempted,
+                    guardrailsBlocked: metadata.guardrailsBlocked,
+                    error: metadata.error,
                 });
             }
             catch (error) {
@@ -2181,6 +2249,8 @@ Current user's request: ${currentInput}`;
                 startTime: config.startTime,
                 responseTime: config.responseTime,
                 fallback: config.fallback || false,
+                guardrailsBlocked: config.guardrailsBlocked,
+                error: config.error,
             },
         };
     }

package/dist/lib/providers/googleAiStudio.d.ts

@@ -6,6 +6,33 @@ import { BaseProvider } from "../core/baseProvider.js";
 /**
  * Google AI Studio provider implementation using BaseProvider
  * Migrated from original GoogleAIStudio class to new factory pattern
+ *
+ * @important Structured Output Limitation
+ * Google Gemini models cannot combine function calling (tools) with structured
+ * output (JSON schema). When using schemas with output.format: "json", you MUST
+ * set disableTools: true.
+ *
+ * Error without disableTools:
+ * "Function calling with a response mime type: 'application/json' is unsupported"
+ *
+ * This is a Google API limitation documented at:
+ * https://ai.google.dev/gemini-api/docs/function-calling
+ *
+ * @example
+ * ```typescript
+ * // ✅ Correct usage with schemas
+ * const provider = new GoogleAIStudioProvider("gemini-2.5-flash");
+ * const result = await provider.generate({
+ *   input: { text: "Analyze data" },
+ *   schema: MySchema,
+ *   output: { format: "json" },
+ *   disableTools: true  // Required
+ * });
+ * ```
+ *
+ * @note Gemini 3 Pro Preview (November 2025) will support combining tools + schemas
+ * @note "Too many states for serving" errors can occur with complex schemas + tools.
+ *       Solution: Simplify schema or use disableTools: true
  */
 export declare class GoogleAIStudioProvider extends BaseProvider {
     constructor(modelName?: string, sdk?: unknown);

package/dist/lib/providers/googleAiStudio.js

@@ -27,6 +27,33 @@ if (!process.env.GOOGLE_GENERATIVE_AI_API_KEY &&
 /**
  * Google AI Studio provider implementation using BaseProvider
  * Migrated from original GoogleAIStudio class to new factory pattern
+ *
+ * @important Structured Output Limitation
+ * Google Gemini models cannot combine function calling (tools) with structured
+ * output (JSON schema). When using schemas with output.format: "json", you MUST
+ * set disableTools: true.
+ *
+ * Error without disableTools:
+ * "Function calling with a response mime type: 'application/json' is unsupported"
+ *
+ * This is a Google API limitation documented at:
+ * https://ai.google.dev/gemini-api/docs/function-calling
+ *
+ * @example
+ * ```typescript
+ * // ✅ Correct usage with schemas
+ * const provider = new GoogleAIStudioProvider("gemini-2.5-flash");
+ * const result = await provider.generate({
+ *   input: { text: "Analyze data" },
+ *   schema: MySchema,
+ *   output: { format: "json" },
+ *   disableTools: true  // Required
+ * });
+ * ```
+ *
+ * @note Gemini 3 Pro Preview (November 2025) will support combining tools + schemas
+ * @note "Too many states for serving" errors can occur with complex schemas + tools.
+ *       Solution: Simplify schema or use disableTools: true
  */
 export class GoogleAIStudioProvider extends BaseProvider {
     constructor(modelName, sdk) {

package/dist/lib/providers/googleVertex.d.ts

@@ -13,6 +13,41 @@ import { BaseProvider } from "../core/baseProvider.js";
  * - Fresh model creation for each request
  * - Enhanced error handling with setup guidance
  * - Tool registration and context management
+ *
+ * @important Structured Output Limitation (Gemini Models Only)
+ * Google Gemini models on Vertex AI cannot combine function calling (tools) with
+ * structured output (JSON schema). When using schemas, you MUST set disableTools: true.
+ *
+ * Error without disableTools:
+ * "Function calling with a response mime type: 'application/json' is unsupported"
+ *
+ * This limitation ONLY affects Gemini models. Anthropic Claude models via Vertex
+ * AI do NOT have this limitation and support both tools + schemas simultaneously.
+ *
+ * @example Gemini models with schemas
+ * ```typescript
+ * const provider = new GoogleVertexProvider("gemini-2.5-flash");
+ * const result = await provider.generate({
+ *   input: { text: "Analyze data" },
+ *   schema: MySchema,
+ *   output: { format: "json" },
+ *   disableTools: true  // Required for Gemini models
+ * });
+ * ```
+ *
+ * @example Claude models (no limitation)
+ * ```typescript
+ * const provider = new GoogleVertexProvider("claude-3-5-sonnet-20241022");
+ * const result = await provider.generate({
+ *   input: { text: "Analyze data" },
+ *   schema: MySchema,
+ *   output: { format: "json" }
+ *   // No disableTools needed - Claude supports both
+ * });
+ * ```
+ *
+ * @note Gemini 3 Pro Preview (November 2025) will support combining tools + schemas
+ * @see https://cloud.google.com/vertex-ai/docs/generative-ai/learn/models
  */
 export declare class GoogleVertexProvider extends BaseProvider {
     private projectId;

package/dist/lib/providers/googleVertex.js

@@ -234,6 +234,41 @@ const isAnthropicModel = (modelName) => {
  * - Fresh model creation for each request
  * - Enhanced error handling with setup guidance
  * - Tool registration and context management
+ *
+ * @important Structured Output Limitation (Gemini Models Only)
+ * Google Gemini models on Vertex AI cannot combine function calling (tools) with
+ * structured output (JSON schema). When using schemas, you MUST set disableTools: true.
+ *
+ * Error without disableTools:
+ * "Function calling with a response mime type: 'application/json' is unsupported"
+ *
+ * This limitation ONLY affects Gemini models. Anthropic Claude models via Vertex
+ * AI do NOT have this limitation and support both tools + schemas simultaneously.
+ *
+ * @example Gemini models with schemas
+ * ```typescript
+ * const provider = new GoogleVertexProvider("gemini-2.5-flash");
+ * const result = await provider.generate({
+ *   input: { text: "Analyze data" },
+ *   schema: MySchema,
+ *   output: { format: "json" },
+ *   disableTools: true  // Required for Gemini models
+ * });
+ * ```
+ *
+ * @example Claude models (no limitation)
+ * ```typescript
+ * const provider = new GoogleVertexProvider("claude-3-5-sonnet-20241022");
+ * const result = await provider.generate({
+ *   input: { text: "Analyze data" },
+ *   schema: MySchema,
+ *   output: { format: "json" }
+ *   // No disableTools needed - Claude supports both
+ * });
+ * ```
+ *
+ * @note Gemini 3 Pro Preview (November 2025) will support combining tools + schemas
+ * @see https://cloud.google.com/vertex-ai/docs/generative-ai/learn/models
  */
 export class GoogleVertexProvider extends BaseProvider {
     projectId;
@@ -1363,11 +1398,14 @@ export class GoogleVertexProvider extends BaseProvider {
     getModelSuggestions(requestedModel) {
         const availableModels = {
             google: [
+                "gemini-3-pro-preview-11-2025",
+                "gemini-3-pro-latest",
                 "gemini-3-pro-preview",
                 "gemini-2.5-pro",
                 "gemini-2.5-flash",
                 "gemini-2.5-flash-lite",
                 "gemini-2.0-flash-001",
+                "gemini-2.0-flash-lite",
                 "gemini-1.5-pro",
                 "gemini-1.5-flash",
             ],

package/dist/lib/telemetry/telemetryService.d.ts

@@ -31,7 +31,7 @@ export declare class TelemetryService {
     private initializeTelemetry;
     private initializeMetrics;
     initialize(): Promise<void>;
-    traceAIRequest<T>(provider: string, operation: () => Promise<T>): Promise<T>;
+    traceAIRequest<T>(provider: string, operation: () => Promise<T>, operationType?: string): Promise<T>;
     recordAIRequest(provider: string, model: string, tokens: number, duration: number): void;
     recordAIError(provider: string, error: Error): void;
     recordMCPToolCall(toolName: string, duration: number, success: boolean): void;

package/dist/lib/telemetry/telemetryService.js

@@ -108,14 +108,14 @@ export class TelemetryService {
         }
     }
     // AI Operation Tracing (NO-OP when disabled)
-    async traceAIRequest(provider, operation) {
+    async traceAIRequest(provider, operation, operationType = "generate_text") {
         if (!this.enabled || !this.tracer) {
-            return await operation(); // Direct execution when disabled
+            return await operation();
         }
-        const span = this.tracer.startSpan(`ai.${provider}.generate_text`, {
+        const span = this.tracer.startSpan(`ai.${provider}.${operationType}`, {
             attributes: {
                 "ai.provider": provider,
-                "ai.operation": "generate_text",
+                "ai.operation": operationType,
             },
         });
         try {

package/dist/lib/types/common.d.ts

@@ -129,3 +129,8 @@ export type TypedEventEmitter<TEvents extends Record<string, unknown>> = {
     listenerCount<K extends keyof TEvents>(event: K): number;
     listeners<K extends keyof TEvents>(event: K): Array<(...args: unknown[]) => void>;
 };
+export type Context = {
+    traceName?: string;
+    userId?: string;
+    sessionId?: string;
+};

package/dist/lib/types/content.d.ts

@@ -14,5 +14,5 @@
  * import type { MultimodalInput } from './types/multimodal.js';
  * ```
  */
-export type { TextContent, ImageContent, CSVContent, PDFContent, AudioContent, VideoContent, Content, MultimodalInput, MultimodalMessage, VisionCapability, ProviderImageFormat, ProcessedImage, ProviderMultimodalPayload, } from "./multimodal.js";
+export type { TextContent, ImageContent, CSVContent, PDFContent, AudioContent, VideoContent, Content, ImageWithAltText, MultimodalInput, MultimodalMessage, VisionCapability, ProviderImageFormat, ProcessedImage, ProviderMultimodalPayload, } from "./multimodal.js";
 export { isTextContent, isImageContent, isCSVContent, isPDFContent, isAudioContent, isVideoContent, isMultimodalInput, } from "./multimodal.js";

package/dist/lib/types/generateTypes.d.ts

@@ -6,7 +6,7 @@ import type { EvaluationData } from "./evaluation.js";
 import type { ChatMessage, ConversationMemoryConfig } from "./conversation.js";
 import type { MiddlewareFactoryOptions } from "./middlewareTypes.js";
 import type { JsonValue } from "./common.js";
-import type { Content } from "./content.js";
+import type { Content, ImageWithAltText } from "./content.js";
 /**
  * Generate function options type - Primary method for content generation
  * Supports multimodal content while maintaining backward compatibility
@@ -14,7 +14,24 @@ import type { Content } from "./content.js";
 export type GenerateOptions = {
     input: {
         text: string;
-        images?: Array<Buffer | string>;
+        /**
+         * Images to include in the request.
+         * Supports simple image data (Buffer, string) or objects with alt text for accessibility.
+         *
+         * @example Simple usage
+         * ```typescript
+         * images: [imageBuffer, "https://example.com/image.jpg"]
+         * ```
+         *
+         * @example With alt text for accessibility
+         * ```typescript
+         * images: [
+         *   { data: imageBuffer, altText: "Product screenshot showing main dashboard" },
+         *   { data: "https://example.com/chart.png", altText: "Sales chart for Q3 2024" }
+         * ]
+         * ```
+         */
+        images?: Array<Buffer | string | ImageWithAltText>;
         csvFiles?: Array<Buffer | string>;
         pdfFiles?: Array<Buffer | string>;
         files?: Array<Buffer | string>;
@@ -34,9 +51,58 @@ export type GenerateOptions = {
     temperature?: number;
     maxTokens?: number;
     systemPrompt?: string;
+    /**
+     * Zod schema for structured output validation
+     *
+     * @important Google Gemini Limitation
+     * Google Vertex AI and Google AI Studio cannot combine function calling with
+     * structured output. You MUST use `disableTools: true` when using schemas with
+     * Google providers.
+     *
+     * Error without disableTools: "Function calling with a response mime type:
+     * 'application/json' is unsupported"
+     *
+     * This is a documented Google API limitation, not a NeuroLink bug.
+     * All frameworks (LangChain, Vercel AI SDK, Agno, Instructor) use this approach.
+     *
+     * @example
+     * ```typescript
+     * // ✅ Correct for Google providers
+     * const result = await neurolink.generate({
+     *   schema: MySchema,
+     *   provider: "vertex",
+     *   disableTools: true  // Required for Google
+     * });
+     *
+     * // ✅ No restriction for other providers
+     * const result = await neurolink.generate({
+     *   schema: MySchema,
+     *   provider: "openai"  // Works without disableTools
+     * });
+     * ```
+     *
+     * @see https://ai.google.dev/gemini-api/docs/function-calling
+     */
     schema?: ValidationSchema;
     tools?: Record<string, Tool>;
     timeout?: number | string;
+    /**
+     * Disable tool execution (including built-in tools)
+     *
+     * @required For Google Gemini providers when using schemas
+     * Google Vertex AI and Google AI Studio require this flag when using
+     * structured output (schemas) due to Google API limitations.
+     *
+     * @example
+     * ```typescript
+     * // Required for Google providers with schemas
+     * await neurolink.generate({
+     *   schema: MySchema,
+     *   provider: "vertex",
+     *   disableTools: true
+     * });
+     * ```
+     */
     disableTools?: boolean;
     enableEvaluation?: boolean;
     enableAnalytics?: boolean;

package/dist/lib/types/multimodal.d.ts

@@ -52,6 +52,8 @@ export type TextContent = {
 export type ImageContent = {
     type: "image";
     data: Buffer | string;
+    /** Alternative text for accessibility (screen readers, SEO) */
+    altText?: string;
     mediaType?: "image/jpeg" | "image/png" | "image/gif" | "image/webp" | "image/bmp" | "image/tiff";
     metadata?: {
         description?: string;
@@ -164,13 +166,48 @@ export type VideoContent = {
  * Covers text, images, documents, and multimedia
  */
 export type Content = TextContent | ImageContent | CSVContent | PDFContent | AudioContent | VideoContent;
+/**
+ * Image data with optional alt text for accessibility
+ * Use this when you need to provide alt text for screen readers and SEO
+ *
+ * @example
+ * ```typescript
+ * const imageWithAlt: ImageWithAltText = {
+ *   data: imageBuffer,
+ *   altText: "A dashboard showing quarterly sales trends"
+ * };
+ * ```
+ */
+export type ImageWithAltText = {
+    /** Image data as Buffer, base64 string, URL, or data URI */
+    data: Buffer | string;
+    /** Alternative text for accessibility (screen readers, SEO) */
+    altText?: string;
+};
 /**
  * Multimodal input type for options that may contain images or content arrays
  * This is the primary interface for users to provide multimodal content
  */
 export type MultimodalInput = {
     text: string;
-    images?: Array<Buffer | string>;
+    /**
+     * Images to include in the request.
+     * Can be simple image data (Buffer, string) or objects with alt text for accessibility.
+     *
+     * @example Simple usage
+     * ```typescript
+     * images: [imageBuffer, "https://example.com/image.jpg"]
+     * ```
+     *
+     * @example With alt text for accessibility
+     * ```typescript
+     * images: [
+     *   { data: imageBuffer, altText: "Product screenshot showing main dashboard" },
+     *   { data: "https://example.com/chart.png", altText: "Sales chart for Q3 2024" }
+     * ]
+     * ```
+     */
+    images?: Array<Buffer | string | ImageWithAltText>;
     content?: Content[];
     csvFiles?: Array<Buffer | string>;
     pdfFiles?: Array<Buffer | string>;