ai 3.3.16 → 3.3.17

package/dist/index.mjs

@@ -589,7 +589,6 @@ var DefaultEmbedManyResult = class {
 
 // core/generate-object/generate-object.ts
 import { safeParseJSON } from "@ai-sdk/provider-utils";
-import { asSchema } from "@ai-sdk/ui-utils";
 
 // core/prompt/convert-to-language-model-prompt.ts
 import { getErrorMessage as getErrorMessage2 } from "@ai-sdk/provider-utils";
@@ -1388,6 +1387,173 @@ var NoObjectGeneratedError = class extends AISDKError6 {
 };
 _a6 = symbol6;
 
+// core/generate-object/output-strategy.ts
+import {
+  isJSONArray,
+  isJSONObject,
+  TypeValidationError,
+  UnsupportedFunctionalityError
+} from "@ai-sdk/provider";
+import { safeValidateTypes as safeValidateTypes2 } from "@ai-sdk/provider-utils";
+import { asSchema } from "@ai-sdk/ui-utils";
+
+// core/util/async-iterable-stream.ts
+function createAsyncIterableStream(source, transformer) {
+  const transformedStream = source.pipeThrough(
+    new TransformStream(transformer)
+  );
+  transformedStream[Symbol.asyncIterator] = () => {
+    const reader = transformedStream.getReader();
+    return {
+      async next() {
+        const { done, value } = await reader.read();
+        return done ? { done: true, value: void 0 } : { done: false, value };
+      }
+    };
+  };
+  return transformedStream;
+}
+
+// core/generate-object/output-strategy.ts
+var noSchemaOutputStrategy = {
+  type: "no-schema",
+  jsonSchema: void 0,
+  validatePartialResult({ value }) {
+    return { success: true, value };
+  },
+  validateFinalResult(value) {
+    return value === void 0 ? { success: false, error: new NoObjectGeneratedError() } : { success: true, value };
+  },
+  createElementStream() {
+    throw new UnsupportedFunctionalityError({
+      functionality: "element streams in no-schema mode"
+    });
+  }
+};
+var objectOutputStrategy = (schema) => ({
+  type: "object",
+  jsonSchema: schema.jsonSchema,
+  validatePartialResult({ value }) {
+    return { success: true, value };
+  },
+  validateFinalResult(value) {
+    return safeValidateTypes2({ value, schema });
+  },
+  createElementStream() {
+    throw new UnsupportedFunctionalityError({
+      functionality: "element streams in object mode"
+    });
+  }
+});
+var arrayOutputStrategy = (schema) => {
+  const { $schema, ...itemSchema } = schema.jsonSchema;
+  return {
+    type: "object",
+    // wrap in object that contains array of elements, since most LLMs will not
+    // be able to generate an array directly:
+    // possible future optimization: use arrays directly when model supports grammar-guided generation
+    jsonSchema: {
+      $schema: "http://json-schema.org/draft-07/schema#",
+      type: "object",
+      properties: {
+        elements: { type: "array", items: itemSchema }
+      },
+      required: ["elements"],
+      additionalProperties: false
+    },
+    validatePartialResult({
+      value,
+      parseState
+    }) {
+      if (!isJSONObject(value) || !isJSONArray(value.elements)) {
+        return {
+          success: false,
+          error: new TypeValidationError({
+            value,
+            cause: "value must be an object that contains an array of elements"
+          })
+        };
+      }
+      const inputArray = value.elements;
+      const resultArray = [];
+      for (let i = 0; i < inputArray.length; i++) {
+        const element = inputArray[i];
+        const result = safeValidateTypes2({ value: element, schema });
+        if (i === inputArray.length - 1 && (!result.success || parseState !== "successful-parse")) {
+          continue;
+        }
+        if (!result.success) {
+          return result;
+        }
+        resultArray.push(result.value);
+      }
+      return { success: true, value: resultArray };
+    },
+    validateFinalResult(value) {
+      if (!isJSONObject(value) || !isJSONArray(value.elements)) {
+        return {
+          success: false,
+          error: new TypeValidationError({
+            value,
+            cause: "value must be an object that contains an array of elements"
+          })
+        };
+      }
+      const inputArray = value.elements;
+      for (const element of inputArray) {
+        const result = safeValidateTypes2({ value: element, schema });
+        if (!result.success) {
+          return result;
+        }
+      }
+      return { success: true, value: inputArray };
+    },
+    createElementStream(originalStream) {
+      let publishedElements = 0;
+      return createAsyncIterableStream(originalStream, {
+        transform(chunk, controller) {
+          switch (chunk.type) {
+            case "object": {
+              const array = chunk.object;
+              for (; publishedElements < array.length; publishedElements++) {
+                controller.enqueue(array[publishedElements]);
+              }
+              break;
+            }
+            case "text-delta":
+            case "finish":
+              break;
+            case "error":
+              controller.error(chunk.error);
+              break;
+            default: {
+              const _exhaustiveCheck = chunk;
+              throw new Error(`Unsupported chunk type: ${_exhaustiveCheck}`);
+            }
+          }
+        }
+      });
+    }
+  };
+};
+function getOutputStrategy({
+  output,
+  schema
+}) {
+  switch (output) {
+    case "object":
+      return objectOutputStrategy(asSchema(schema));
+    case "array":
+      return arrayOutputStrategy(asSchema(schema));
+    case "no-schema":
+      return noSchemaOutputStrategy;
+    default: {
+      const _exhaustiveCheck = output;
+      throw new Error(`Unsupported output: ${_exhaustiveCheck}`);
+    }
+  }
+}
+
 // core/generate-object/validate-object-generation-input.ts
 function validateObjectGenerationInput({
   output,
@@ -1396,7 +1562,7 @@ function validateObjectGenerationInput({
   schemaName,
   schemaDescription
 }) {
-  if (output != null && output !== "object" && output !== "no-schema") {
+  if (output != null && output !== "object" && output !== "array" && output !== "no-schema") {
     throw new InvalidArgumentError({
       parameter: "output",
       value: output,
@@ -1442,6 +1608,15 @@ function validateObjectGenerationInput({
       });
     }
   }
+  if (output === "array") {
+    if (schema == null) {
+      throw new InvalidArgumentError({
+        parameter: "schema",
+        value: schema,
+        message: "Element schema is required for array output."
+      });
+    }
+  }
 }
 
 // core/generate-object/generate-object.ts
@@ -1469,7 +1644,8 @@ async function generateObject({
     schemaName,
     schemaDescription
   });
-  if (output === "no-schema" && mode === void 0) {
+  const outputStrategy = getOutputStrategy({ output, schema: inputSchema });
+  if (outputStrategy.type === "no-schema" && mode === void 0) {
     mode = "json";
   }
   const baseTelemetryAttributes = getBaseTelemetryAttributes({
@@ -1478,7 +1654,6 @@ async function generateObject({
     headers,
     settings: { ...settings, maxRetries }
   });
-  const schema = inputSchema != null ? asSchema(inputSchema) : void 0;
   const tracer = getTracer({ isEnabled: (_a12 = telemetry == null ? void 0 : telemetry.isEnabled) != null ? _a12 : false });
   return recordSpan({
     name: "ai.generateObject",
@@ -1494,10 +1669,10 @@ async function generateObject({
         "ai.prompt": {
           input: () => JSON.stringify({ system, prompt, messages })
         },
-        "ai.schema": schema != null ? { input: () => JSON.stringify(schema.jsonSchema) } : void 0,
+        "ai.schema": outputStrategy.jsonSchema != null ? { input: () => JSON.stringify(outputStrategy.jsonSchema) } : void 0,
         "ai.schema.name": schemaName,
         "ai.schema.description": schemaDescription,
-        "ai.settings.output": output,
+        "ai.settings.output": outputStrategy.type,
         "ai.settings.mode": mode
       }
     }),
@@ -1517,9 +1692,9 @@ async function generateObject({
       switch (mode) {
         case "json": {
           const validatedPrompt = validatePrompt({
-            system: schema == null ? injectJsonInstruction({ prompt: system }) : model.supportsStructuredOutputs && schema != null ? system : injectJsonInstruction({
+            system: outputStrategy.jsonSchema == null ? injectJsonInstruction({ prompt: system }) : model.supportsStructuredOutputs ? system : injectJsonInstruction({
               prompt: system,
-              schema: schema.jsonSchema
+              schema: outputStrategy.jsonSchema
             }),
             prompt,
             messages
@@ -1560,7 +1735,7 @@ async function generateObject({
                 const result2 = await model.doGenerate({
                   mode: {
                     type: "object-json",
-                    schema: schema == null ? void 0 : schema.jsonSchema,
+                    schema: outputStrategy.jsonSchema,
                     name: schemaName,
                     description: schemaDescription
                   },
@@ -1648,7 +1823,7 @@ async function generateObject({
                       type: "function",
                       name: schemaName != null ? schemaName : "json",
                       description: schemaDescription != null ? schemaDescription : "Respond with a JSON object.",
-                      parameters: schema.jsonSchema
+                      parameters: outputStrategy.jsonSchema
                     }
                   },
                   ...prepareCallSettings(settings),
@@ -1699,15 +1874,16 @@ async function generateObject({
           throw new Error(`Unsupported mode: ${_exhaustiveCheck}`);
         }
       }
-      const parseResult = safeParseJSON({
-        text: result,
-        // type casting required for `undefined` schema (no-schema mode),
-        // in which case <T> is <JSONValue> as desired.
-        schema
-      });
+      const parseResult = safeParseJSON({ text: result });
       if (!parseResult.success) {
         throw parseResult.error;
       }
+      const validationResult = outputStrategy.validateFinalResult(
+        parseResult.value
+      );
+      if (!validationResult.success) {
+        throw validationResult.error;
+      }
       span.setAttributes(
         selectTelemetryAttributes({
           telemetry,
@@ -1716,13 +1892,13 @@ async function generateObject({
             "ai.usage.promptTokens": usage.promptTokens,
             "ai.usage.completionTokens": usage.completionTokens,
             "ai.result.object": {
-              output: () => JSON.stringify(parseResult.value)
+              output: () => JSON.stringify(validationResult.value)
             }
           }
         })
       );
       return new DefaultGenerateObjectResult({
-        object: parseResult.value,
+        object: validationResult.value,
         finishReason,
         usage: calculateCompletionTokenUsage(usage),
         warnings,
@@ -1756,9 +1932,7 @@ var DefaultGenerateObjectResult = class {
 var experimental_generateObject = generateObject;
 
 // core/generate-object/stream-object.ts
-import { safeValidateTypes as safeValidateTypes2 } from "@ai-sdk/provider-utils";
 import {
-  asSchema as asSchema2,
   isDeepEqualData,
   parsePartialJson
 } from "@ai-sdk/ui-utils";
@@ -1816,23 +1990,6 @@ var DelayedPromise = class {
   }
 };
 
-// core/util/async-iterable-stream.ts
-function createAsyncIterableStream(source, transformer) {
-  const transformedStream = source.pipeThrough(
-    new TransformStream(transformer)
-  );
-  transformedStream[Symbol.asyncIterator] = () => {
-    const reader = transformedStream.getReader();
-    return {
-      async next() {
-        const { done, value } = await reader.read();
-        return done ? { done: true, value: void 0 } : { done: false, value };
-      }
-    };
-  };
-  return transformedStream;
-}
-
 // core/generate-object/stream-object.ts
 async function streamObject({
   model,
@@ -1859,7 +2016,8 @@ async function streamObject({
     schemaName,
     schemaDescription
   });
-  if (output === "no-schema" && mode === void 0) {
+  const outputStrategy = getOutputStrategy({ output, schema: inputSchema });
+  if (outputStrategy.type === "no-schema" && mode === void 0) {
     mode = "json";
   }
   const baseTelemetryAttributes = getBaseTelemetryAttributes({
@@ -1870,7 +2028,6 @@ async function streamObject({
   });
   const tracer = getTracer({ isEnabled: (_a12 = telemetry == null ? void 0 : telemetry.isEnabled) != null ? _a12 : false });
   const retry = retryWithExponentialBackoff({ maxRetries });
-  const schema = inputSchema != null ? asSchema2(inputSchema) : void 0;
   return recordSpan({
     name: "ai.streamObject",
     attributes: selectTelemetryAttributes({
@@ -1885,10 +2042,10 @@ async function streamObject({
         "ai.prompt": {
           input: () => JSON.stringify({ system, prompt, messages })
         },
-        "ai.schema": schema != null ? { input: () => JSON.stringify(schema.jsonSchema) } : void 0,
+        "ai.schema": outputStrategy.jsonSchema != null ? { input: () => JSON.stringify(outputStrategy.jsonSchema) } : void 0,
         "ai.schema.name": schemaName,
         "ai.schema.description": schemaDescription,
-        "ai.settings.output": output,
+        "ai.settings.output": outputStrategy.type,
         "ai.settings.mode": mode
       }
     }),
@@ -1903,9 +2060,9 @@ async function streamObject({
       switch (mode) {
         case "json": {
           const validatedPrompt = validatePrompt({
-            system: schema == null ? injectJsonInstruction({ prompt: system }) : model.supportsStructuredOutputs && schema != null ? system : injectJsonInstruction({
+            system: outputStrategy.jsonSchema == null ? injectJsonInstruction({ prompt: system }) : model.supportsStructuredOutputs ? system : injectJsonInstruction({
               prompt: system,
-              schema: schema.jsonSchema
+              schema: outputStrategy.jsonSchema
             }),
             prompt,
             messages
@@ -1913,7 +2070,7 @@ async function streamObject({
           callOptions = {
             mode: {
               type: "object-json",
-              schema: schema == null ? void 0 : schema.jsonSchema,
+              schema: outputStrategy.jsonSchema,
               name: schemaName,
               description: schemaDescription
             },
@@ -1954,7 +2111,7 @@ async function streamObject({
                 type: "function",
                 name: schemaName != null ? schemaName : "json",
                 description: schemaDescription != null ? schemaDescription : "Respond with a JSON object.",
-                parameters: schema.jsonSchema
+                parameters: outputStrategy.jsonSchema
               }
             },
             ...prepareCallSettings(settings),
@@ -2032,12 +2189,10 @@ async function streamObject({
         })
       );
       return new DefaultStreamObjectResult({
+        outputStrategy,
         stream: stream.pipeThrough(new TransformStream(transformer)),
         warnings,
         rawResponse,
-        // type casting required for `undefined` schema (no-schema mode),
-        // in which case <T> is <JSONValue> as desired.
-        schema,
         onFinish,
         rootSpan,
         doStreamSpan,
@@ -2052,7 +2207,7 @@ var DefaultStreamObjectResult = class {
     stream,
     warnings,
     rawResponse,
-    schema,
+    outputStrategy,
     onFinish,
     rootSpan,
     doStreamSpan,
@@ -2061,6 +2216,7 @@ var DefaultStreamObjectResult = class {
   }) {
     this.warnings = warnings;
     this.rawResponse = rawResponse;
+    this.outputStrategy = outputStrategy;
     this.objectPromise = new DelayedPromise();
     const { resolve: resolveUsage, promise: usagePromise } = createResolvablePromise();
     this.usage = usagePromise;
@@ -2076,6 +2232,7 @@ var DefaultStreamObjectResult = class {
     let error;
     let accumulatedText = "";
     let delta = "";
+    let latestObjectJson = void 0;
     let latestObject = void 0;
     let firstChunk = true;
     const self = this;
@@ -2095,20 +2252,25 @@ var DefaultStreamObjectResult = class {
           if (typeof chunk === "string") {
             accumulatedText += chunk;
             delta += chunk;
-            const currentObject = parsePartialJson(
-              accumulatedText
-            );
-            if (!isDeepEqualData(latestObject, currentObject)) {
-              latestObject = currentObject;
-              controller.enqueue({
-                type: "object",
-                object: currentObject
-              });
-              controller.enqueue({
-                type: "text-delta",
-                textDelta: delta
+            const { value: currentObjectJson, state: parseState } = parsePartialJson(accumulatedText);
+            if (currentObjectJson !== void 0 && !isDeepEqualData(latestObjectJson, currentObjectJson)) {
+              const validationResult = outputStrategy.validatePartialResult({
+                value: currentObjectJson,
+                parseState
               });
-              delta = "";
+              if (validationResult.success && !isDeepEqualData(latestObject, validationResult.value)) {
+                latestObjectJson = currentObjectJson;
+                latestObject = validationResult.value;
+                controller.enqueue({
+                  type: "object",
+                  object: latestObject
+                });
+                controller.enqueue({
+                  type: "text-delta",
+                  textDelta: delta
+                });
+                delta = "";
+              }
             }
             return;
           }
@@ -2126,10 +2288,7 @@ var DefaultStreamObjectResult = class {
               controller.enqueue({ ...chunk, usage });
               resolveUsage(usage);
               resolveProviderMetadata(providerMetadata);
-              const validationResult = safeValidateTypes2({
-                value: latestObject,
-                schema
-              });
+              const validationResult = outputStrategy.validateFinalResult(latestObjectJson);
               if (validationResult.success) {
                 object = validationResult.value;
                 self.objectPromise.resolve(object);
@@ -2224,6 +2383,9 @@ var DefaultStreamObjectResult = class {
       }
     });
   }
+  get elementStream() {
+    return this.outputStrategy.createElementStream(this.originalStream);
+  }
   get textStream() {
     return createAsyncIterableStream(this.originalStream, {
       transform(chunk, controller) {
@@ -2288,7 +2450,7 @@ var DefaultStreamObjectResult = class {
 var experimental_streamObject = streamObject;
 
 // core/prompt/prepare-tools-and-tool-choice.ts
-import { asSchema as asSchema3 } from "@ai-sdk/ui-utils";
+import { asSchema as asSchema2 } from "@ai-sdk/ui-utils";
 
 // core/util/is-non-empty-object.ts
 function isNonEmptyObject(object) {
@@ -2311,7 +2473,7 @@ function prepareToolsAndToolChoice({
       type: "function",
       name: name12,
       description: tool2.description,
-      parameters: asSchema3(tool2.parameters).jsonSchema
+      parameters: asSchema2(tool2.parameters).jsonSchema
     })),
     toolChoice: toolChoice == null ? { type: "auto" } : typeof toolChoice === "string" ? { type: toolChoice } : { type: "tool", toolName: toolChoice.toolName }
   };
@@ -2319,7 +2481,7 @@ function prepareToolsAndToolChoice({
 
 // core/generate-text/tool-call.ts
 import { safeParseJSON as safeParseJSON2 } from "@ai-sdk/provider-utils";
-import { asSchema as asSchema4 } from "@ai-sdk/ui-utils";
+import { asSchema as asSchema3 } from "@ai-sdk/ui-utils";
 
 // errors/invalid-tool-arguments-error.ts
 import { AISDKError as AISDKError7, getErrorMessage as getErrorMessage3 } from "@ai-sdk/provider";
@@ -2425,7 +2587,7 @@ function parseToolCall({
   }
   const parseResult = safeParseJSON2({
     text: toolCall.args,
-    schema: asSchema4(tool2.parameters)
+    schema: asSchema3(tool2.parameters)
   });
   if (parseResult.success === false) {
     throw new InvalidToolArgumentsError({
@@ -3843,8 +4005,8 @@ import {
   InvalidResponseDataError,
   JSONParseError,
   LoadAPIKeyError,
-  TypeValidationError,
-  UnsupportedFunctionalityError
+  TypeValidationError as TypeValidationError2,
+  UnsupportedFunctionalityError as UnsupportedFunctionalityError2
 } from "@ai-sdk/provider";
 
 // streams/ai-stream.ts
@@ -4937,8 +5099,8 @@ export {
   RetryError,
   StreamData2 as StreamData,
   StreamingTextResponse,
-  TypeValidationError,
-  UnsupportedFunctionalityError,
+  TypeValidationError2 as TypeValidationError,
+  UnsupportedFunctionalityError2 as UnsupportedFunctionalityError,
   convertToCoreMessages,
   cosineSimilarity,
   createCallbacksTransformer,