ai 4.1.1 → 4.1.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # ai
 
+## 4.1.2
+
+### Patch Changes
+
+- 3c5fafa: chore (ai/core): move streamText toolCallStreaming option to stable
+- 3a58a2e: feat (ai/core): throw NoImageGeneratedError from generateImage when no predictions are returned.
+- Updated dependencies [ed012d2]
+- Updated dependencies [6f4d063]
+- Updated dependencies [3a58a2e]
+  - @ai-sdk/provider-utils@2.1.2
+  - @ai-sdk/react@1.1.2
+  - @ai-sdk/provider@1.0.6
+  - @ai-sdk/ui-utils@1.1.2
+
 ## 4.1.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -100,6 +100,21 @@ some settings might not be supported, which can lead to suboptimal results.
   */
 type ImageGenerationWarning = ImageModelV1CallWarning;
 
+type ImageModelResponseMetadata = {
+    /**
+  Timestamp for the start of the generated response.
+     */
+    timestamp: Date;
+    /**
+  The ID of the response model that was used to generate the response.
+     */
+    modelId: string;
+    /**
+  Response headers.
+     */
+    headers?: Record<string, string>;
+};
+
 /**
 Language model that is used by the AI SDK Core functions.
 */
@@ -380,6 +395,10 @@ interface GenerateImageResult {
   Warnings for the call, e.g. unsupported settings.
        */
     readonly warnings: Array<ImageGenerationWarning>;
+    /**
+  Response metadata from the provider. There may be multiple responses if we made multiple calls to the model.
+     */
+    readonly responses: Array<ImageModelResponseMetadata>;
 }
 interface GeneratedImage {
     /**
@@ -409,7 +428,7 @@ as body parameters.
 
 @returns A result object that contains the generated images.
  */
-declare function generateImage({ model, prompt, n, size, aspectRatio, seed, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, }: {
+declare function generateImage({ model, prompt, n, size, aspectRatio, seed, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, _internal, }: {
     /**
   The image model to use.
        */
@@ -464,6 +483,12 @@ declare function generateImage({ model, prompt, n, size, aspectRatio, seed, prov
   Only applicable for HTTP-based providers.
    */
     headers?: Record<string, string>;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        currentDate?: () => Date;
+    };
 }): Promise<GenerateImageResult>;
 
 type CallSettings = {
@@ -1691,9 +1716,9 @@ declare namespace output {
   };
 }
 
-declare const symbol$c: unique symbol;
+declare const symbol$d: unique symbol;
 declare class InvalidToolArgumentsError extends AISDKError {
-    private readonly [symbol$c];
+    private readonly [symbol$d];
     readonly toolName: string;
     readonly toolArgs: string;
     constructor({ toolArgs, toolName, cause, message, }: {
@@ -1705,9 +1730,9 @@ declare class InvalidToolArgumentsError extends AISDKError {
     static isInstance(error: unknown): error is InvalidToolArgumentsError;
 }
 
-declare const symbol$b: unique symbol;
+declare const symbol$c: unique symbol;
 declare class NoSuchToolError extends AISDKError {
-    private readonly [symbol$b];
+    private readonly [symbol$c];
     readonly toolName: string;
     readonly availableTools: string[] | undefined;
     constructor({ toolName, availableTools, message, }: {
@@ -2169,7 +2194,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming, toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2226,6 +2251,10 @@ A function that attempts to repair a tool call that failed to parse.
     /**
 Enable streaming of tool call deltas as they are generated. Disabled by default.
      */
+    toolCallStreaming?: boolean;
+    /**
+@deprecated Use `toolCallStreaming` instead.
+     */
     experimental_toolCallStreaming?: boolean;
     /**
 Optional stream transformations.
@@ -2350,9 +2379,9 @@ declare function experimental_customProvider({ languageModels, textEmbeddingMode
     fallbackProvider?: Provider;
 }): Provider;
 
-declare const symbol$a: unique symbol;
+declare const symbol$b: unique symbol;
 declare class NoSuchProviderError extends NoSuchModelError {
-    private readonly [symbol$a];
+    private readonly [symbol$b];
     readonly providerId: string;
     readonly availableProviders: string[];
     constructor({ modelId, modelType, providerId, availableProviders, message, }: {
@@ -2406,9 +2435,9 @@ declare function simulateReadableStream<T>({ chunks, initialDelayInMs, chunkDela
     };
 }): ReadableStream<T>;
 
-declare const symbol$9: unique symbol;
+declare const symbol$a: unique symbol;
 declare class InvalidArgumentError extends AISDKError {
-    private readonly [symbol$9];
+    private readonly [symbol$a];
     readonly parameter: string;
     readonly value: unknown;
     constructor({ parameter, value, message, }: {
@@ -2419,6 +2448,27 @@ declare class InvalidArgumentError extends AISDKError {
     static isInstance(error: unknown): error is InvalidArgumentError;
 }
 
+declare const symbol$9: unique symbol;
+/**
+Thrown when no image could be generated. This can have multiple causes:
+
+- The model failed to generate a response.
+- The model generated a response that could not be parsed.
+ */
+declare class NoImageGeneratedError extends AISDKError {
+    private readonly [symbol$9];
+    /**
+  The response metadata for each call.
+     */
+    readonly responses: Array<ImageModelResponseMetadata> | undefined;
+    constructor({ message, cause, responses, }: {
+        message?: string;
+        cause?: Error;
+        responses?: Array<ImageModelResponseMetadata>;
+    });
+    static isInstance(error: unknown): error is NoImageGeneratedError;
+}
+
 declare const symbol$8: unique symbol;
 /**
 Thrown when no object could be generated. This can have several causes:
@@ -2693,4 +2743,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamTextTransform, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, appendResponseMessages, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamTextTransform, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, appendResponseMessages, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool };

package/dist/index.d.ts

@@ -100,6 +100,21 @@ some settings might not be supported, which can lead to suboptimal results.
   */
 type ImageGenerationWarning = ImageModelV1CallWarning;
 
+type ImageModelResponseMetadata = {
+    /**
+  Timestamp for the start of the generated response.
+     */
+    timestamp: Date;
+    /**
+  The ID of the response model that was used to generate the response.
+     */
+    modelId: string;
+    /**
+  Response headers.
+     */
+    headers?: Record<string, string>;
+};
+
 /**
 Language model that is used by the AI SDK Core functions.
 */
@@ -380,6 +395,10 @@ interface GenerateImageResult {
   Warnings for the call, e.g. unsupported settings.
        */
     readonly warnings: Array<ImageGenerationWarning>;
+    /**
+  Response metadata from the provider. There may be multiple responses if we made multiple calls to the model.
+     */
+    readonly responses: Array<ImageModelResponseMetadata>;
 }
 interface GeneratedImage {
     /**
@@ -409,7 +428,7 @@ as body parameters.
 
 @returns A result object that contains the generated images.
  */
-declare function generateImage({ model, prompt, n, size, aspectRatio, seed, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, }: {
+declare function generateImage({ model, prompt, n, size, aspectRatio, seed, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, _internal, }: {
     /**
   The image model to use.
        */
@@ -464,6 +483,12 @@ declare function generateImage({ model, prompt, n, size, aspectRatio, seed, prov
   Only applicable for HTTP-based providers.
    */
     headers?: Record<string, string>;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        currentDate?: () => Date;
+    };
 }): Promise<GenerateImageResult>;
 
 type CallSettings = {
@@ -1691,9 +1716,9 @@ declare namespace output {
   };
 }
 
-declare const symbol$c: unique symbol;
+declare const symbol$d: unique symbol;
 declare class InvalidToolArgumentsError extends AISDKError {
-    private readonly [symbol$c];
+    private readonly [symbol$d];
     readonly toolName: string;
     readonly toolArgs: string;
     constructor({ toolArgs, toolName, cause, message, }: {
@@ -1705,9 +1730,9 @@ declare class InvalidToolArgumentsError extends AISDKError {
     static isInstance(error: unknown): error is InvalidToolArgumentsError;
 }
 
-declare const symbol$b: unique symbol;
+declare const symbol$c: unique symbol;
 declare class NoSuchToolError extends AISDKError {
-    private readonly [symbol$b];
+    private readonly [symbol$c];
     readonly toolName: string;
     readonly availableTools: string[] | undefined;
     constructor({ toolName, availableTools, message, }: {
@@ -2169,7 +2194,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming, toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2226,6 +2251,10 @@ A function that attempts to repair a tool call that failed to parse.
     /**
 Enable streaming of tool call deltas as they are generated. Disabled by default.
      */
+    toolCallStreaming?: boolean;
+    /**
+@deprecated Use `toolCallStreaming` instead.
+     */
     experimental_toolCallStreaming?: boolean;
     /**
 Optional stream transformations.
@@ -2350,9 +2379,9 @@ declare function experimental_customProvider({ languageModels, textEmbeddingMode
     fallbackProvider?: Provider;
 }): Provider;
 
-declare const symbol$a: unique symbol;
+declare const symbol$b: unique symbol;
 declare class NoSuchProviderError extends NoSuchModelError {
-    private readonly [symbol$a];
+    private readonly [symbol$b];
     readonly providerId: string;
     readonly availableProviders: string[];
     constructor({ modelId, modelType, providerId, availableProviders, message, }: {
@@ -2406,9 +2435,9 @@ declare function simulateReadableStream<T>({ chunks, initialDelayInMs, chunkDela
     };
 }): ReadableStream<T>;
 
-declare const symbol$9: unique symbol;
+declare const symbol$a: unique symbol;
 declare class InvalidArgumentError extends AISDKError {
-    private readonly [symbol$9];
+    private readonly [symbol$a];
     readonly parameter: string;
     readonly value: unknown;
     constructor({ parameter, value, message, }: {
@@ -2419,6 +2448,27 @@ declare class InvalidArgumentError extends AISDKError {
     static isInstance(error: unknown): error is InvalidArgumentError;
 }
 
+declare const symbol$9: unique symbol;
+/**
+Thrown when no image could be generated. This can have multiple causes:
+
+- The model failed to generate a response.
+- The model generated a response that could not be parsed.
+ */
+declare class NoImageGeneratedError extends AISDKError {
+    private readonly [symbol$9];
+    /**
+  The response metadata for each call.
+     */
+    readonly responses: Array<ImageModelResponseMetadata> | undefined;
+    constructor({ message, cause, responses, }: {
+        message?: string;
+        cause?: Error;
+        responses?: Array<ImageModelResponseMetadata>;
+    });
+    static isInstance(error: unknown): error is NoImageGeneratedError;
+}
+
 declare const symbol$8: unique symbol;
 /**
 Thrown when no object could be generated. This can have several causes:
@@ -2693,4 +2743,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamTextTransform, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, appendResponseMessages, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamTextTransform, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, appendResponseMessages, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool };