ai 4.0.17 → 4.0.18

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ai
 
+## 4.0.18
+
+### Patch Changes
+
+- 304e6d3: feat (ai/core): standardize generateObject, streamObject, and output errors to NoObjectGeneratedError
+- 304e6d3: feat (ai/core): add additional information to NoObjectGeneratedError
+
 ## 4.0.17
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1608,6 +1608,9 @@ interface Output<OUTPUT> {
     }) => LanguageModelV1CallOptions['responseFormat'];
     parseOutput(options: {
         text: string;
+    }, context: {
+        response: LanguageModelResponseMetadata;
+        usage: LanguageModelUsage;
     }): OUTPUT;
 }
 declare const text: () => Output<string>;
@@ -2274,8 +2277,44 @@ declare class InvalidArgumentError extends AISDKError {
 }
 
 declare const symbol$7: unique symbol;
-declare class ToolCallRepairError extends AISDKError {
+/**
+Thrown when no object could be generated. This can have several causes:
+
+- The model failed to generate a response.
+- The model generated a response that could not be parsed.
+- The model generated a response that could not be validated against the schema.
+
+The error contains the following properties:
+
+- `text`: The text that was generated by the model. This can be the raw text or the tool call text, depending on the model.
+ */
+declare class NoObjectGeneratedError extends AISDKError {
     private readonly [symbol$7];
+    /**
+    The text that was generated by the model. This can be the raw text or the tool call text, depending on the model.
+     */
+    readonly text: string | undefined;
+    /**
+    The response metadata.
+     */
+    readonly response: LanguageModelResponseMetadata | undefined;
+    /**
+    The usage of the model.
+     */
+    readonly usage: LanguageModelUsage | undefined;
+    constructor({ message, cause, text, response, usage, }: {
+        message?: string;
+        cause?: Error;
+        text?: string;
+        response: LanguageModelResponseMetadata;
+        usage: LanguageModelUsage;
+    });
+    static isInstance(error: unknown): error is NoObjectGeneratedError;
+}
+
+declare const symbol$6: unique symbol;
+declare class ToolCallRepairError extends AISDKError {
+    private readonly [symbol$6];
     readonly originalError: NoSuchToolError | InvalidToolArgumentsError;
     constructor({ cause, originalError, message, }: {
         message?: string;
@@ -2285,9 +2324,9 @@ declare class ToolCallRepairError extends AISDKError {
     static isInstance(error: unknown): error is ToolCallRepairError;
 }
 
-declare const symbol$6: unique symbol;
+declare const symbol$5: unique symbol;
 declare class ToolExecutionError extends AISDKError {
-    private readonly [symbol$6];
+    private readonly [symbol$5];
     readonly toolName: string;
     readonly toolArgs: JSONValue;
     constructor({ toolArgs, toolName, cause, message, }: {
@@ -2299,18 +2338,6 @@ declare class ToolExecutionError extends AISDKError {
     static isInstance(error: unknown): error is ToolExecutionError;
 }
 
-declare const symbol$5: unique symbol;
-/**
-Thrown when the AI provider fails to generate a parsable object.
- */
-declare class NoObjectGeneratedError extends AISDKError {
-    private readonly [symbol$5];
-    constructor({ message }?: {
-        message?: string;
-    });
-    static isInstance(error: unknown): error is NoObjectGeneratedError;
-}
-
 declare const symbol$4: unique symbol;
 declare class InvalidDataContentError extends AISDKError {
     private readonly [symbol$4];

package/dist/index.d.ts

@@ -1608,6 +1608,9 @@ interface Output<OUTPUT> {
     }) => LanguageModelV1CallOptions['responseFormat'];
     parseOutput(options: {
         text: string;
+    }, context: {
+        response: LanguageModelResponseMetadata;
+        usage: LanguageModelUsage;
     }): OUTPUT;
 }
 declare const text: () => Output<string>;
@@ -2274,8 +2277,44 @@ declare class InvalidArgumentError extends AISDKError {
 }
 
 declare const symbol$7: unique symbol;
-declare class ToolCallRepairError extends AISDKError {
+/**
+Thrown when no object could be generated. This can have several causes:
+
+- The model failed to generate a response.
+- The model generated a response that could not be parsed.
+- The model generated a response that could not be validated against the schema.
+
+The error contains the following properties:
+
+- `text`: The text that was generated by the model. This can be the raw text or the tool call text, depending on the model.
+ */
+declare class NoObjectGeneratedError extends AISDKError {
     private readonly [symbol$7];
+    /**
+    The text that was generated by the model. This can be the raw text or the tool call text, depending on the model.
+     */
+    readonly text: string | undefined;
+    /**
+    The response metadata.
+     */
+    readonly response: LanguageModelResponseMetadata | undefined;
+    /**
+    The usage of the model.
+     */
+    readonly usage: LanguageModelUsage | undefined;
+    constructor({ message, cause, text, response, usage, }: {
+        message?: string;
+        cause?: Error;
+        text?: string;
+        response: LanguageModelResponseMetadata;
+        usage: LanguageModelUsage;
+    });
+    static isInstance(error: unknown): error is NoObjectGeneratedError;
+}
+
+declare const symbol$6: unique symbol;
+declare class ToolCallRepairError extends AISDKError {
+    private readonly [symbol$6];
     readonly originalError: NoSuchToolError | InvalidToolArgumentsError;
     constructor({ cause, originalError, message, }: {
         message?: string;
@@ -2285,9 +2324,9 @@ declare class ToolCallRepairError extends AISDKError {
     static isInstance(error: unknown): error is ToolCallRepairError;
 }
 
-declare const symbol$6: unique symbol;
+declare const symbol$5: unique symbol;
 declare class ToolExecutionError extends AISDKError {
-    private readonly [symbol$6];
+    private readonly [symbol$5];
     readonly toolName: string;
     readonly toolArgs: JSONValue;
     constructor({ toolArgs, toolName, cause, message, }: {
@@ -2299,18 +2338,6 @@ declare class ToolExecutionError extends AISDKError {
     static isInstance(error: unknown): error is ToolExecutionError;
 }
 
-declare const symbol$5: unique symbol;
-/**
-Thrown when the AI provider fails to generate a parsable object.
- */
-declare class NoObjectGeneratedError extends AISDKError {
-    private readonly [symbol$5];
-    constructor({ message }?: {
-        message?: string;
-    });
-    static isInstance(error: unknown): error is NoObjectGeneratedError;
-}
-
 declare const symbol$4: unique symbol;
 declare class InvalidDataContentError extends AISDKError {
     private readonly [symbol$4];

package/dist/index.js

@@ -900,13 +900,39 @@ var DefaultGenerateImageResult = class {
 // core/generate-object/generate-object.ts
 var import_provider_utils6 = require("@ai-sdk/provider-utils");
 
-// util/download-error.ts
+// errors/no-object-generated-error.ts
 var import_provider4 = require("@ai-sdk/provider");
-var name3 = "AI_DownloadError";
+var name3 = "AI_NoObjectGeneratedError";
 var marker3 = `vercel.ai.error.${name3}`;
 var symbol3 = Symbol.for(marker3);
 var _a3;
-var DownloadError = class extends import_provider4.AISDKError {
+var NoObjectGeneratedError = class extends import_provider4.AISDKError {
+  constructor({
+    message = "No object generated.",
+    cause,
+    text: text2,
+    response,
+    usage
+  }) {
+    super({ name: name3, message, cause });
+    this[_a3] = true;
+    this.text = text2;
+    this.response = response;
+    this.usage = usage;
+  }
+  static isInstance(error) {
+    return import_provider4.AISDKError.hasMarker(error, marker3);
+  }
+};
+_a3 = symbol3;
+
+// util/download-error.ts
+var import_provider5 = require("@ai-sdk/provider");
+var name4 = "AI_DownloadError";
+var marker4 = `vercel.ai.error.${name4}`;
+var symbol4 = Symbol.for(marker4);
+var _a4;
+var DownloadError = class extends import_provider5.AISDKError {
   constructor({
     url,
     statusCode,
@@ -914,17 +940,17 @@ var DownloadError = class extends import_provider4.AISDKError {
     cause,
     message = cause == null ? `Failed to download ${url}: ${statusCode} ${statusText}` : `Failed to download ${url}: ${cause}`
   }) {
-    super({ name: name3, message, cause });
-    this[_a3] = true;
+    super({ name: name4, message, cause });
+    this[_a4] = true;
     this.url = url;
     this.statusCode = statusCode;
     this.statusText = statusText;
   }
   static isInstance(error) {
-    return import_provider4.AISDKError.hasMarker(error, marker3);
+    return import_provider5.AISDKError.hasMarker(error, marker4);
   }
 };
-_a3 = symbol3;
+_a4 = symbol4;
 
 // util/download.ts
 async function download({
@@ -974,26 +1000,26 @@ function detectImageMimeType(image) {
 var import_provider_utils3 = require("@ai-sdk/provider-utils");
 
 // core/prompt/invalid-data-content-error.ts
-var import_provider5 = require("@ai-sdk/provider");
-var name4 = "AI_InvalidDataContentError";
-var marker4 = `vercel.ai.error.${name4}`;
-var symbol4 = Symbol.for(marker4);
-var _a4;
-var InvalidDataContentError = class extends import_provider5.AISDKError {
+var import_provider6 = require("@ai-sdk/provider");
+var name5 = "AI_InvalidDataContentError";
+var marker5 = `vercel.ai.error.${name5}`;
+var symbol5 = Symbol.for(marker5);
+var _a5;
+var InvalidDataContentError = class extends import_provider6.AISDKError {
   constructor({
     content,
     cause,
     message = `Invalid data content. Expected a base64 string, Uint8Array, ArrayBuffer, or Buffer, but got ${typeof content}.`
   }) {
-    super({ name: name4, message, cause });
-    this[_a4] = true;
+    super({ name: name5, message, cause });
+    this[_a5] = true;
     this.content = content;
   }
   static isInstance(error) {
-    return import_provider5.AISDKError.hasMarker(error, marker4);
+    return import_provider6.AISDKError.hasMarker(error, marker5);
   }
 };
-_a4 = symbol4;
+_a5 = symbol5;
 
 // core/prompt/data-content.ts
 var import_zod = require("zod");
@@ -1048,25 +1074,25 @@ function convertUint8ArrayToText(uint8Array) {
 }
 
 // core/prompt/invalid-message-role-error.ts
-var import_provider6 = require("@ai-sdk/provider");
-var name5 = "AI_InvalidMessageRoleError";
-var marker5 = `vercel.ai.error.${name5}`;
-var symbol5 = Symbol.for(marker5);
-var _a5;
-var InvalidMessageRoleError = class extends import_provider6.AISDKError {
+var import_provider7 = require("@ai-sdk/provider");
+var name6 = "AI_InvalidMessageRoleError";
+var marker6 = `vercel.ai.error.${name6}`;
+var symbol6 = Symbol.for(marker6);
+var _a6;
+var InvalidMessageRoleError = class extends import_provider7.AISDKError {
   constructor({
     role,
     message = `Invalid message role: '${role}'. Must be one of: "system", "user", "assistant", "tool".`
   }) {
-    super({ name: name5, message });
-    this[_a5] = true;
+    super({ name: name6, message });
+    this[_a6] = true;
     this.role = role;
   }
   static isInstance(error) {
-    return import_provider6.AISDKError.hasMarker(error, marker5);
+    return import_provider7.AISDKError.hasMarker(error, marker6);
   }
 };
-_a5 = symbol5;
+_a6 = symbol6;
 
 // core/prompt/split-data-url.ts
 function splitDataUrl(dataUrl) {
@@ -1363,7 +1389,7 @@ function prepareCallSettings({
 }
 
 // core/prompt/standardize-prompt.ts
-var import_provider8 = require("@ai-sdk/provider");
+var import_provider9 = require("@ai-sdk/provider");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 var import_zod7 = require("zod");
 
@@ -1589,25 +1615,25 @@ function attachmentsToParts(attachments) {
 }
 
 // core/prompt/message-conversion-error.ts
-var import_provider7 = require("@ai-sdk/provider");
-var name6 = "AI_MessageConversionError";
-var marker6 = `vercel.ai.error.${name6}`;
-var symbol6 = Symbol.for(marker6);
-var _a6;
-var MessageConversionError = class extends import_provider7.AISDKError {
+var import_provider8 = require("@ai-sdk/provider");
+var name7 = "AI_MessageConversionError";
+var marker7 = `vercel.ai.error.${name7}`;
+var symbol7 = Symbol.for(marker7);
+var _a7;
+var MessageConversionError = class extends import_provider8.AISDKError {
   constructor({
     originalMessage,
     message
   }) {
-    super({ name: name6, message });
-    this[_a6] = true;
+    super({ name: name7, message });
+    this[_a7] = true;
     this.originalMessage = originalMessage;
   }
   static isInstance(error) {
-    return import_provider7.AISDKError.hasMarker(error, marker6);
+    return import_provider8.AISDKError.hasMarker(error, marker7);
   }
 };
-_a6 = symbol6;
+_a7 = symbol7;
 
 // core/prompt/convert-to-core-messages.ts
 function convertToCoreMessages(messages, options) {
@@ -1701,26 +1727,26 @@ function standardizePrompt({
   tools
 }) {
   if (prompt.prompt == null && prompt.messages == null) {
-    throw new import_provider8.InvalidPromptError({
+    throw new import_provider9.InvalidPromptError({
       prompt,
       message: "prompt or messages must be defined"
     });
   }
   if (prompt.prompt != null && prompt.messages != null) {
-    throw new import_provider8.InvalidPromptError({
+    throw new import_provider9.InvalidPromptError({
       prompt,
       message: "prompt and messages cannot be defined at the same time"
     });
   }
   if (prompt.system != null && typeof prompt.system !== "string") {
-    throw new import_provider8.InvalidPromptError({
+    throw new import_provider9.InvalidPromptError({
       prompt,
       message: "system must be a string"
     });
   }
   if (prompt.prompt != null) {
     if (typeof prompt.prompt !== "string") {
-      throw new import_provider8.InvalidPromptError({
+      throw new import_provider9.InvalidPromptError({
         prompt,
         message: "prompt must be a string"
       });
@@ -1739,7 +1765,7 @@ function standardizePrompt({
   if (prompt.messages != null) {
     const promptType = detectPromptType(prompt.messages);
     if (promptType === "other") {
-      throw new import_provider8.InvalidPromptError({
+      throw new import_provider9.InvalidPromptError({
         prompt,
         message: "messages must be an array of CoreMessage or UIMessage"
       });
@@ -1752,7 +1778,7 @@ function standardizePrompt({
       schema: import_zod7.z.array(coreMessageSchema)
     });
     if (!validationResult.success) {
-      throw new import_provider8.InvalidPromptError({
+      throw new import_provider9.InvalidPromptError({
         prompt,
         message: "messages must be an array of CoreMessage or UIMessage",
         cause: validationResult.error
@@ -1799,24 +1825,6 @@ function injectJsonInstruction({
   ].filter((line) => line != null).join("\n");
 }
 
-// core/generate-object/no-object-generated-error.ts
-var import_provider9 = require("@ai-sdk/provider");
-var name7 = "AI_NoObjectGeneratedError";
-var marker7 = `vercel.ai.error.${name7}`;
-var symbol7 = Symbol.for(marker7);
-var _a7;
-var NoObjectGeneratedError = class extends import_provider9.AISDKError {
-  // used in isInstance
-  constructor({ message = "No object generated." } = {}) {
-    super({ name: name7, message });
-    this[_a7] = true;
-  }
-  static isInstance(error) {
-    return import_provider9.AISDKError.hasMarker(error, marker7);
-  }
-};
-_a7 = symbol7;
-
 // core/generate-object/output-strategy.ts
 var import_provider10 = require("@ai-sdk/provider");
 var import_provider_utils5 = require("@ai-sdk/provider-utils");
@@ -1846,8 +1854,16 @@ var noSchemaOutputStrategy = {
   validatePartialResult({ value, textDelta }) {
     return { success: true, value: { partial: value, textDelta } };
   },
-  validateFinalResult(value) {
-    return value === void 0 ? { success: false, error: new NoObjectGeneratedError() } : { success: true, value };
+  validateFinalResult(value, context) {
+    return value === void 0 ? {
+      success: false,
+      error: new NoObjectGeneratedError({
+        message: "No object generated: response did not match schema.",
+        text: context.text,
+        response: context.response,
+        usage: context.usage
+      })
+    } : { success: true, value };
   },
   createElementStream() {
     throw new import_provider10.UnsupportedFunctionalityError({
@@ -2326,14 +2342,18 @@ async function generateObject({
                   abortSignal,
                   headers
                 });
-                if (result2.text === void 0) {
-                  throw new NoObjectGeneratedError();
-                }
                 const responseData = {
                   id: (_b2 = (_a14 = result2.response) == null ? void 0 : _a14.id) != null ? _b2 : generateId3(),
                   timestamp: (_d = (_c = result2.response) == null ? void 0 : _c.timestamp) != null ? _d : currentDate(),
                   modelId: (_f = (_e = result2.response) == null ? void 0 : _e.modelId) != null ? _f : model.modelId
                 };
+                if (result2.text === void 0) {
+                  throw new NoObjectGeneratedError({
+                    message: "No object generated: the model did not return a response.",
+                    response: responseData,
+                    usage: calculateLanguageModelUsage(result2.usage)
+                  });
+                }
                 span2.setAttributes(
                   selectTelemetryAttributes({
                     telemetry,
@@ -2430,14 +2450,18 @@ async function generateObject({
                   headers
                 });
                 const objectText = (_b2 = (_a14 = result2.toolCalls) == null ? void 0 : _a14[0]) == null ? void 0 : _b2.args;
-                if (objectText === void 0) {
-                  throw new NoObjectGeneratedError();
-                }
                 const responseData = {
                   id: (_d = (_c = result2.response) == null ? void 0 : _c.id) != null ? _d : generateId3(),
                   timestamp: (_f = (_e = result2.response) == null ? void 0 : _e.timestamp) != null ? _f : currentDate(),
                   modelId: (_h = (_g = result2.response) == null ? void 0 : _g.modelId) != null ? _h : model.modelId
                 };
+                if (objectText === void 0) {
+                  throw new NoObjectGeneratedError({
+                    message: "No object generated: the tool was not called.",
+                    response: responseData,
+                    usage: calculateLanguageModelUsage(result2.usage)
+                  });
+                }
                 span2.setAttributes(
                   selectTelemetryAttributes({
                     telemetry,
@@ -2485,13 +2509,30 @@ async function generateObject({
       }
       const parseResult = (0, import_provider_utils6.safeParseJSON)({ text: result });
       if (!parseResult.success) {
-        throw parseResult.error;
+        throw new NoObjectGeneratedError({
+          message: "No object generated: could not parse the response.",
+          cause: parseResult.error,
+          text: result,
+          response,
+          usage: calculateLanguageModelUsage(usage)
+        });
       }
       const validationResult = outputStrategy.validateFinalResult(
-        parseResult.value
+        parseResult.value,
+        {
+          text: result,
+          response,
+          usage: calculateLanguageModelUsage(usage)
+        }
       );
       if (!validationResult.success) {
-        throw validationResult.error;
+        throw new NoObjectGeneratedError({
+          message: "No object generated: response did not match schema.",
+          cause: validationResult.error,
+          text: result,
+          response,
+          usage: calculateLanguageModelUsage(usage)
+        });
       }
       span.setAttributes(
         selectTelemetryAttributes({
@@ -3026,12 +3067,25 @@ var DefaultStreamObjectResult = class {
                     ...response,
                     headers: rawResponse == null ? void 0 : rawResponse.headers
                   });
-                  const validationResult = outputStrategy.validateFinalResult(latestObjectJson);
+                  const validationResult = outputStrategy.validateFinalResult(
+                    latestObjectJson,
+                    {
+                      text: accumulatedText,
+                      response,
+                      usage
+                    }
+                  );
                   if (validationResult.success) {
                     object2 = validationResult.value;
                     self.objectPromise.resolve(object2);
                   } else {
-                    error = validationResult.error;
+                    error = new NoObjectGeneratedError({
+                      message: "No object generated: response did not match schema.",
+                      cause: validationResult.error,
+                      text: accumulatedText,
+                      response,
+                      usage
+                    });
                     self.objectPromise.reject(error);
                   }
                   break;
@@ -3777,7 +3831,13 @@ async function generateText({
       );
       return new DefaultGenerateTextResult({
         text: text2,
-        output: output == null ? void 0 : output.parseOutput({ text: text2 }),
+        output: output == null ? void 0 : output.parseOutput(
+          { text: text2 },
+          {
+            response: currentModelResponse.response,
+            usage
+          }
+        ),
         toolCalls: currentToolCalls,
         toolResults: currentToolResults,
         finishReason: currentModelResponse.finishReason,
@@ -3920,8 +3980,31 @@ var object = ({
         schema: schema.jsonSchema
       });
     },
-    parseOutput({ text: text2 }) {
-      return (0, import_provider_utils10.parseJSON)({ text: text2, schema });
+    parseOutput({ text: text2 }, context) {
+      const parseResult = (0, import_provider_utils10.safeParseJSON)({ text: text2 });
+      if (!parseResult.success) {
+        throw new NoObjectGeneratedError({
+          message: "No object generated: could not parse the response.",
+          cause: parseResult.error,
+          text: text2,
+          response: context.response,
+          usage: context.usage
+        });
+      }
+      const validationResult = (0, import_provider_utils10.safeValidateTypes)({
+        value: parseResult.value,
+        schema
+      });
+      if (!validationResult.success) {
+        throw new NoObjectGeneratedError({
+          message: "No object generated: response did not match schema.",
+          cause: validationResult.error,
+          text: text2,
+          response: context.response,
+          usage: context.usage
+        });
+      }
+      return validationResult.value;
     }
   };
 };