ai 3.3.15 → 3.3.16

package/dist/index.d.mts

@@ -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).