ai 3.3.15 → 3.3.16

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { Schema, DeepPartial, Attachment, JSONValue, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
+import { Schema, DeepPartial, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseComplexResponse, parseStreamPart, readDataStream } from '@ai-sdk/ui-utils';
 import { AttributeValue, Span } from '@opentelemetry/api';
-import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, LanguageModelV1StreamPart, AISDKError } from '@ai-sdk/provider';
+import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1StreamPart, AISDKError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ServerResponse } from 'http';
@@ -592,63 +592,30 @@ Generate a structured, typed object for a given prompt and schema using a langua
 
 This function does not stream the output. If you want to stream the output, use `streamObject` instead.
 
-@param model - The language model to use.
-
-@param schema - The schema of the object that the model should generate.
-@param schemaName - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
-@param schemaDescription - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
-@param mode - The mode to use for object generation. Not all models support all modes. Defaults to 'auto'.
-
-@param system - A system message that will be part of the prompt.
-@param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
-@param messages - A list of messages. You can either use `prompt` or `messages` but not both.
-
-@param maxTokens - Maximum number of tokens to generate.
-@param temperature - Temperature setting.
-The value is passed through to the provider. The range depends on the provider and model.
-It is recommended to set either `temperature` or `topP`, but not both.
-@param topP - Nucleus sampling.
-The value is passed through to the provider. The range depends on the provider and model.
-It is recommended to set either `temperature` or `topP`, but not both.
-@param topK - Only sample from the top K options for each subsequent token.
-Used to remove "long tail" low probability responses.
-Recommended for advanced use cases only. You usually only need to use temperature.
-@param presencePenalty - Presence penalty setting.
-It affects the likelihood of the model to repeat information that is already in the prompt.
-The value is passed through to the provider. The range depends on the provider and model.
-@param frequencyPenalty - Frequency penalty setting.
-It affects the likelihood of the model to repeatedly use the same words or phrases.
-The value is passed through to the provider. The range depends on the provider and model.
-@param seed - The seed (integer) to use for random sampling.
-If set and supported by the model, calls will generate deterministic results.
-
-@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
-@param abortSignal - An optional abort signal that can be used to cancel the call.
-@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
-
 @returns
 A result object that contains the generated object, the finish reason, the token usage, and additional information.
  */
-declare function generateObject<T>({ model, schema: inputSchema, schemaName, schemaDescription, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
+declare function generateObject<T>(options: Omit<CallSettings, 'stopSequences'> & Prompt & {
+    output?: 'object' | undefined;
     /**
 The language model to use.
-     */
+   */
     model: LanguageModel;
     /**
 The schema of the object that the model should generate.
-     */
+   */
     schema: z.Schema<T, z.ZodTypeDef, any> | Schema<T>;
     /**
 Optional name of the output that should be generated.
 Used by some providers for additional LLM guidance, e.g.
 via tool or schema name.
-     */
+   */
     schemaName?: string;
     /**
 Optional description of the output that should be generated.
 Used by some providers for additional LLM guidance, e.g.
 via tool or schema description.
-     */
+   */
     schemaDescription?: string;
     /**
 The mode to use for object generation.
@@ -662,13 +629,36 @@ The schema is converted in a JSON schema and used in one of the following ways
 Please note that most providers do not support all modes.
 
 Default and recommended: 'auto' (best mode for the model).
-     */
+   */
     mode?: 'auto' | 'json' | 'tool';
     /**
-     * Optional telemetry configuration (experimental).
+Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
 }): Promise<DefaultGenerateObjectResult<T>>;
+/**
+Generate JSON with any schema for a given prompt using a language model.
+
+This function does not stream the output. If you want to stream the output, use `streamObject` instead.
+
+@returns
+A result object that contains the generated object, the finish reason, the token usage, and additional information.
+ */
+declare function generateObject(options: Omit<CallSettings, 'stopSequences'> & Prompt & {
+    output: 'no-schema';
+    /**
+The language model to use.
+   */
+    model: LanguageModel;
+    /**
+The mode to use for object generation. Must be "json" for no-schema output.
+   */
+    mode?: 'json';
+    /**
+Optional telemetry configuration (experimental).
+     */
+    experimental_telemetry?: TelemetrySettings;
+}): Promise<DefaultGenerateObjectResult<JSONValue>>;
 declare class DefaultGenerateObjectResult<T> implements GenerateObjectResult<T> {
     readonly object: GenerateObjectResult<T>['object'];
     readonly finishReason: GenerateObjectResult<T>['finishReason'];
@@ -792,63 +782,29 @@ Generate a structured, typed object for a given prompt and schema using a langua
 
 This function streams the output. If you do not want to stream the output, use `generateObject` instead.
 
-@param model - The language model to use.
-
-@param schema - The schema of the object that the model should generate.
-@param schemaName - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
-@param schemaDescription - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
-@param mode - The mode to use for object generation. Not all models support all modes. Defaults to 'auto'.
-
-@param system - A system message that will be part of the prompt.
-@param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
-@param messages - A list of messages. You can either use `prompt` or `messages` but not both.
-
-@param maxTokens - Maximum number of tokens to generate.
-@param temperature - Temperature setting.
-The value is passed through to the provider. The range depends on the provider and model.
-It is recommended to set either `temperature` or `topP`, but not both.
-@param topP - Nucleus sampling.
-The value is passed through to the provider. The range depends on the provider and model.
-It is recommended to set either `temperature` or `topP`, but not both.
-@param topK - Only sample from the top K options for each subsequent token.
-Used to remove "long tail" low probability responses.
-Recommended for advanced use cases only. You usually only need to use temperature.
-@param presencePenalty - Presence penalty setting.
-It affects the likelihood of the model to repeat information that is already in the prompt.
-The value is passed through to the provider. The range depends on the provider and model.
-@param frequencyPenalty - Frequency penalty setting.
-It affects the likelihood of the model to repeatedly use the same words or phrases.
-The value is passed through to the provider. The range depends on the provider and model.
-@param seed - The seed (integer) to use for random sampling.
-If set and supported by the model, calls will generate deterministic results.
-
-@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
-@param abortSignal - An optional abort signal that can be used to cancel the call.
-@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
-
 @return
 A result object for accessing the partial object stream and additional information.
  */
-declare function streamObject<T>({ model, schema: inputSchema, schemaName, schemaDescription, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, onFinish, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
+declare function streamObject<T>(options: Omit<CallSettings, 'stopSequences'> & Prompt & {
     /**
 The language model to use.
-     */
+   */
     model: LanguageModel;
     /**
 The schema of the object that the model should generate.
- */
+*/
     schema: z.Schema<T, z.ZodTypeDef, any> | Schema<T>;
     /**
 Optional name of the output that should be generated.
 Used by some providers for additional LLM guidance, e.g.
 via tool or schema name.
-     */
+   */
     schemaName?: string;
     /**
 Optional description of the output that should be generated.
 Used by some providers for additional LLM guidance, e.g.
 via tool or schema description.
- */
+*/
     schemaDescription?: string;
     /**
 The mode to use for object generation.
@@ -862,49 +818,108 @@ The schema is converted in a JSON schema and used in one of the following ways
 Please note that most providers do not support all modes.
 
 Default and recommended: 'auto' (best mode for the model).
-     */
+   */
     mode?: 'auto' | 'json' | 'tool';
     /**
 Optional telemetry configuration (experimental).
-     */
+   */
     experimental_telemetry?: TelemetrySettings;
     /**
 Callback that is called when the LLM response and the final object validation are finished.
-     */
+   */
     onFinish?: (event: {
         /**
-  The token usage of the generated response.
-  */
+The token usage of the generated response.
+*/
         usage: CompletionTokenUsage$1;
         /**
-  The generated object (typed according to the schema). Can be undefined if the final object does not match the schema.
-     */
+The generated object (typed according to the schema). Can be undefined if the final object does not match the schema.
+   */
         object: T | undefined;
         /**
-  Optional error object. This is e.g. a TypeValidationError when the final object does not match the schema.
-     */
+Optional error object. This is e.g. a TypeValidationError when the final object does not match the schema.
+   */
         error: unknown | undefined;
         /**
-  Optional raw response data.
-     */
+Optional raw response data.
+   */
         rawResponse?: {
             /**
-    Response headers.
-         */
+  Response headers.
+       */
             headers?: Record<string, string>;
         };
         /**
-  Warnings from the model provider (e.g. unsupported settings).
-         */
+Warnings from the model provider (e.g. unsupported settings).
+       */
         warnings?: CallWarning[];
         /**
-  Additional provider-specific metadata. They are passed through
-  from the provider to the AI SDK and enable provider-specific
-  results that can be fully encapsulated in the provider.
-     */
+Additional provider-specific metadata. They are passed through
+from the provider to the AI SDK and enable provider-specific
+results that can be fully encapsulated in the provider.
+   */
         experimental_providerMetadata: ProviderMetadata | undefined;
     }) => Promise<void> | void;
 }): Promise<DefaultStreamObjectResult<T>>;
+/**
+Generate JSON with any schema for a given prompt using a language model.
+
+This function streams the output. If you do not want to stream the output, use `generateObject` instead.
+
+@return
+A result object for accessing the partial object stream and additional information.
+ */
+declare function streamObject(options: Omit<CallSettings, 'stopSequences'> & Prompt & {
+    output: 'no-schema';
+    /**
+The language model to use.
+   */
+    model: LanguageModel;
+    /**
+The mode to use for object generation. Must be "json" for no-schema output.
+   */
+    mode?: 'json';
+    /**
+Optional telemetry configuration (experimental).
+   */
+    experimental_telemetry?: TelemetrySettings;
+    /**
+Callback that is called when the LLM response and the final object validation are finished.
+   */
+    onFinish?: (event: {
+        /**
+The token usage of the generated response.
+*/
+        usage: CompletionTokenUsage$1;
+        /**
+The generated object (typed according to the schema). Can be undefined if the final object does not match the schema.
+   */
+        object: JSONValue | undefined;
+        /**
+Optional error object. This is e.g. a TypeValidationError when the final object does not match the schema.
+   */
+        error: unknown | undefined;
+        /**
+Optional raw response data.
+   */
+        rawResponse?: {
+            /**
+  Response headers.
+       */
+            headers?: Record<string, string>;
+        };
+        /**
+Warnings from the model provider (e.g. unsupported settings).
+       */
+        warnings?: CallWarning[];
+        /**
+Additional provider-specific metadata. They are passed through
+from the provider to the AI SDK and enable provider-specific
+results that can be fully encapsulated in the provider.
+   */
+        experimental_providerMetadata: ProviderMetadata | undefined;
+    }) => Promise<void> | void;
+}): Promise<DefaultStreamObjectResult<JSONValue>>;
 declare class DefaultStreamObjectResult<T> implements StreamObjectResult<T> {
     private readonly originalStream;
     private readonly objectPromise;
@@ -2083,7 +2098,7 @@ type OpenAIStreamCallbacks = AIStreamCallbacksAndOptions & {
      * })
      * ```
      */
-    experimental_onFunctionCall?: (functionCallPayload: FunctionCallPayload, createFunctionCallMessages: (functionCallResult: JSONValue) => CreateMessage[]) => Promise<Response | undefined | void | string | AsyncIterableOpenAIStreamReturnTypes>;
+    experimental_onFunctionCall?: (functionCallPayload: FunctionCallPayload, createFunctionCallMessages: (functionCallResult: JSONValue$1) => CreateMessage[]) => Promise<Response | undefined | void | string | AsyncIterableOpenAIStreamReturnTypes>;
     /**
      * @example
      * ```js
@@ -2122,7 +2137,7 @@ type OpenAIStreamCallbacks = AIStreamCallbacksAndOptions & {
     experimental_onToolCall?: (toolCallPayload: ToolCallPayload, appendToolCallMessage: (result?: {
         tool_call_id: string;
         function_name: string;
-        tool_call_result: JSONValue;
+        tool_call_result: JSONValue$1;
     }) => CreateMessage[]) => Promise<Response | undefined | void | string | AsyncIterableOpenAIStreamReturnTypes>;
 };
 interface ChatCompletionChunk {
@@ -2583,8 +2598,8 @@ declare class StreamData {
     private warningTimeout;
     constructor();
     close(): Promise<void>;
-    append(value: JSONValue): void;
-    appendMessageAnnotation(value: JSONValue): void;
+    append(value: JSONValue$1): void;
+    appendMessageAnnotation(value: JSONValue$1): void;
 }
 /**
  * A TransformStream for LLMs that do not have their own transform stream handlers managing encoding (e.g. OpenAIStream has one for function call handling).

package/dist/index.js

@@ -1411,21 +1411,22 @@ function prepareResponseHeaders(init, {
   return headers;
 }
 
-// core/generate-object/inject-json-schema-into-system.ts
+// core/generate-object/inject-json-instruction.ts
 var DEFAULT_SCHEMA_PREFIX = "JSON schema:";
 var DEFAULT_SCHEMA_SUFFIX = "You MUST answer with a JSON object that matches the JSON schema above.";
-function injectJsonSchemaIntoSystem({
-  system,
+var DEFAULT_GENERIC_SUFFIX = "You MUST answer with JSON.";
+function injectJsonInstruction({
+  prompt,
   schema,
-  schemaPrefix = DEFAULT_SCHEMA_PREFIX,
-  schemaSuffix = DEFAULT_SCHEMA_SUFFIX
+  schemaPrefix = schema != null ? DEFAULT_SCHEMA_PREFIX : void 0,
+  schemaSuffix = schema != null ? DEFAULT_SCHEMA_SUFFIX : DEFAULT_GENERIC_SUFFIX
 }) {
   return [
-    system,
-    system != null ? "" : null,
-    // add a newline if system is not null
+    prompt != null && prompt.length > 0 ? prompt : void 0,
+    prompt != null && prompt.length > 0 ? "" : void 0,
+    // add a newline if prompt is not null
     schemaPrefix,
-    JSON.stringify(schema),
+    schema != null ? JSON.stringify(schema) : void 0,
     schemaSuffix
   ].filter((line) => line != null).join("\n");
 }
@@ -1465,6 +1466,62 @@ var NoObjectGeneratedError = class extends import_provider8.AISDKError {
 };
 _a6 = symbol6;
 
+// core/generate-object/validate-object-generation-input.ts
+function validateObjectGenerationInput({
+  output,
+  mode,
+  schema,
+  schemaName,
+  schemaDescription
+}) {
+  if (output != null && output !== "object" && output !== "no-schema") {
+    throw new InvalidArgumentError({
+      parameter: "output",
+      value: output,
+      message: "Invalid output type."
+    });
+  }
+  if (output === "no-schema") {
+    if (mode === "auto" || mode === "tool") {
+      throw new InvalidArgumentError({
+        parameter: "mode",
+        value: mode,
+        message: 'Mode must be "json" for no-schema output.'
+      });
+    }
+    if (schema != null) {
+      throw new InvalidArgumentError({
+        parameter: "schema",
+        value: schema,
+        message: "Schema is not supported for no-schema output."
+      });
+    }
+    if (schemaDescription != null) {
+      throw new InvalidArgumentError({
+        parameter: "schemaDescription",
+        value: schemaDescription,
+        message: "Schema description is not supported for no-schema output."
+      });
+    }
+    if (schemaName != null) {
+      throw new InvalidArgumentError({
+        parameter: "schemaName",
+        value: schemaName,
+        message: "Schema name is not supported for no-schema output."
+      });
+    }
+  }
+  if (output === "object") {
+    if (schema == null) {
+      throw new InvalidArgumentError({
+        parameter: "schema",
+        value: schema,
+        message: "Schema is required for object output."
+      });
+    }
+  }
+}
+
 // core/generate-object/generate-object.ts
 async function generateObject({
   model,
@@ -1472,6 +1529,7 @@ async function generateObject({
   schemaName,
   schemaDescription,
   mode,
+  output = "object",
   system,
   prompt,
   messages,
@@ -1482,13 +1540,23 @@ async function generateObject({
   ...settings
 }) {
   var _a12;
+  validateObjectGenerationInput({
+    output,
+    mode,
+    schema: inputSchema,
+    schemaName,
+    schemaDescription
+  });
+  if (output === "no-schema" && mode === void 0) {
+    mode = "json";
+  }
   const baseTelemetryAttributes = getBaseTelemetryAttributes({
     model,
     telemetry,
     headers,
     settings: { ...settings, maxRetries }
   });
-  const schema = (0, import_ui_utils.asSchema)(inputSchema);
+  const schema = inputSchema != null ? (0, import_ui_utils.asSchema)(inputSchema) : void 0;
   const tracer = getTracer({ isEnabled: (_a12 = telemetry == null ? void 0 : telemetry.isEnabled) != null ? _a12 : false });
   return recordSpan({
     name: "ai.generateObject",
@@ -1504,11 +1572,10 @@ async function generateObject({
         "ai.prompt": {
           input: () => JSON.stringify({ system, prompt, messages })
         },
-        "ai.schema": {
-          input: () => JSON.stringify(schema.jsonSchema)
-        },
+        "ai.schema": schema != null ? { input: () => JSON.stringify(schema.jsonSchema) } : void 0,
         "ai.schema.name": schemaName,
         "ai.schema.description": schemaDescription,
+        "ai.settings.output": output,
         "ai.settings.mode": mode
       }
     }),
@@ -1528,8 +1595,8 @@ async function generateObject({
       switch (mode) {
         case "json": {
           const validatedPrompt = validatePrompt({
-            system: model.supportsStructuredOutputs ? system : injectJsonSchemaIntoSystem({
-              system,
+            system: schema == null ? injectJsonInstruction({ prompt: system }) : model.supportsStructuredOutputs && schema != null ? system : injectJsonInstruction({
+              prompt: system,
               schema: schema.jsonSchema
             }),
             prompt,
@@ -1571,7 +1638,7 @@ async function generateObject({
                 const result2 = await model.doGenerate({
                   mode: {
                     type: "object-json",
-                    schema: schema.jsonSchema,
+                    schema: schema == null ? void 0 : schema.jsonSchema,
                     name: schemaName,
                     description: schemaDescription
                   },
@@ -1710,7 +1777,12 @@ async function generateObject({
           throw new Error(`Unsupported mode: ${_exhaustiveCheck}`);
         }
       }
-      const parseResult = (0, import_provider_utils5.safeParseJSON)({ text: result, schema });
+      const parseResult = (0, import_provider_utils5.safeParseJSON)({
+        text: result,
+        // type casting required for `undefined` schema (no-schema mode),
+        // in which case <T> is <JSONValue> as desired.
+        schema
+      });
       if (!parseResult.success) {
         throw parseResult.error;
       }
@@ -1842,6 +1914,7 @@ async function streamObject({
   schemaName,
   schemaDescription,
   mode,
+  output = "object",
   system,
   prompt,
   messages,
@@ -1853,6 +1926,16 @@ async function streamObject({
   ...settings
 }) {
   var _a12;
+  validateObjectGenerationInput({
+    output,
+    mode,
+    schema: inputSchema,
+    schemaName,
+    schemaDescription
+  });
+  if (output === "no-schema" && mode === void 0) {
+    mode = "json";
+  }
   const baseTelemetryAttributes = getBaseTelemetryAttributes({
     model,
     telemetry,
@@ -1861,7 +1944,7 @@ async function streamObject({
   });
   const tracer = getTracer({ isEnabled: (_a12 = telemetry == null ? void 0 : telemetry.isEnabled) != null ? _a12 : false });
   const retry = retryWithExponentialBackoff({ maxRetries });
-  const schema = (0, import_ui_utils2.asSchema)(inputSchema);
+  const schema = inputSchema != null ? (0, import_ui_utils2.asSchema)(inputSchema) : void 0;
   return recordSpan({
     name: "ai.streamObject",
     attributes: selectTelemetryAttributes({
@@ -1876,9 +1959,10 @@ async function streamObject({
         "ai.prompt": {
           input: () => JSON.stringify({ system, prompt, messages })
         },
-        "ai.schema": { input: () => JSON.stringify(schema.jsonSchema) },
+        "ai.schema": schema != null ? { input: () => JSON.stringify(schema.jsonSchema) } : void 0,
         "ai.schema.name": schemaName,
         "ai.schema.description": schemaDescription,
+        "ai.settings.output": output,
         "ai.settings.mode": mode
       }
     }),
@@ -1893,8 +1977,8 @@ async function streamObject({
       switch (mode) {
         case "json": {
           const validatedPrompt = validatePrompt({
-            system: model.supportsStructuredOutputs ? system : injectJsonSchemaIntoSystem({
-              system,
+            system: schema == null ? injectJsonInstruction({ prompt: system }) : model.supportsStructuredOutputs && schema != null ? system : injectJsonInstruction({
+              prompt: system,
               schema: schema.jsonSchema
             }),
             prompt,
@@ -1903,7 +1987,7 @@ async function streamObject({
           callOptions = {
             mode: {
               type: "object-json",
-              schema: schema.jsonSchema,
+              schema: schema == null ? void 0 : schema.jsonSchema,
               name: schemaName,
               description: schemaDescription
             },
@@ -2025,6 +2109,8 @@ async function streamObject({
         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,