ai 5.0.0-canary.13 → 5.0.0-canary.14

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # ai
 
+## 5.0.0-canary.14
+
+### Patch Changes
+
+- 9bf7291: chore(providers/openai): enable structuredOutputs by default & switch to provider option
+- 4617fab: chore(embedding-models): remove remaining settings
+- a76a62b: feat (ai): add experimental prepareStep callback to generateText
+- Updated dependencies [9bf7291]
+- Updated dependencies [4617fab]
+- Updated dependencies [e030615]
+  - @ai-sdk/provider@2.0.0-canary.11
+  - @ai-sdk/provider-utils@3.0.0-canary.12
+
 ## 5.0.0-canary.13
 
 ### Patch Changes

package/dist/index.d.mts

@@ -3092,7 +3092,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, providerOptions, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, providerOptions, experimental_activeTools: activeTools, experimental_prepareStep: prepareStep, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -3143,6 +3143,28 @@ Optional specification for parsing structured outputs from the LLM response.
      */
     experimental_output?: Output$1<OUTPUT, OUTPUT_PARTIAL>;
     /**
+Optional function that you can use to provide different settings for a step.
+
+@param options - The options for the step.
+@param options.steps - The steps that have been executed so far.
+@param options.stepNumber - The number of the step that is being executed.
+@param options.maxSteps - The maximum number of steps.
+@param options.model - The model that is being used.
+
+@returns An object that contains the settings for the step.
+If you return undefined (or for undefined settings), the settings from the outer level will be used.
+    */
+    experimental_prepareStep?: (options: {
+        steps: Array<StepResult<TOOLS>>;
+        stepNumber: number;
+        maxSteps: number;
+        model: LanguageModel;
+    }) => PromiseLike<{
+        model?: LanguageModel;
+        toolChoice?: ToolChoice<TOOLS>;
+        experimental_activeTools?: Array<keyof TOOLS>;
+    } | undefined>;
+    /**
 A function that attempts to repair a tool call that failed to parse.
      */
     experimental_repairToolCall?: ToolCallRepairFunction<TOOLS>;
@@ -3850,11 +3872,11 @@ This function does not stream the output. If you want to stream the output, use
 @returns
 A result object that contains the generated object, the finish reason, the token usage, and additional information.
  */
-declare function generateObject<TYPE extends SCHEMA extends z.Schema ? Output extends 'array' ? Array<z.infer<SCHEMA>> : z.infer<SCHEMA> : SCHEMA extends Schema<infer T> ? Output extends 'array' ? Array<T> : T : never, SCHEMA extends z.Schema | Schema = z.Schema<JSONValue$1>, Output extends 'object' | 'array' | 'enum' | 'no-schema' = TYPE extends string ? 'enum' : 'object'>(options: Omit<CallSettings, 'stopSequences'> & Prompt & (Output extends 'enum' ? {
+declare function generateObject<RESULT extends SCHEMA extends z.Schema ? Output extends 'array' ? Array<z.infer<SCHEMA>> : z.infer<SCHEMA> : SCHEMA extends Schema<infer T> ? Output extends 'array' ? Array<T> : T : never, SCHEMA extends z.Schema | Schema = z.Schema<JSONValue$1>, Output extends 'object' | 'array' | 'enum' | 'no-schema' = RESULT extends string ? 'enum' : 'object'>(options: Omit<CallSettings, 'stopSequences'> & Prompt & (Output extends 'enum' ? {
     /**
 The enum values that the model should use.
   */
-    enum: Array<TYPE>;
+    enum: Array<RESULT>;
     mode?: 'json';
     output: 'enum';
 } : Output extends 'no-schema' ? {} : {
@@ -3916,7 +3938,7 @@ functionality that can be fully encapsulated in the provider.
         generateId?: () => string;
         currentDate?: () => Date;
     };
-}): Promise<GenerateObjectResult<TYPE>>;
+}): Promise<GenerateObjectResult<RESULT>>;
 
 /**
 The result of a `streamObject` call that contains the partial object stream and additional information.
@@ -4048,27 +4070,20 @@ type StreamObjectOnFinishCallback<RESULT> = (event: {
 }) => Promise<void> | void;
 /**
 Generate a structured, typed object for a given prompt and schema 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<OBJECT>(options: Omit<CallSettings, 'stopSequences'> & Prompt & {
-    output?: 'object' | undefined;
-    /**
-The language model to use.
-   */
-    model: LanguageModel;
+declare function streamObject<RESULT extends SCHEMA extends z.Schema ? Output extends 'array' ? Array<z.infer<SCHEMA>> : z.infer<SCHEMA> : SCHEMA extends Schema<infer T> ? Output extends 'array' ? Array<T> : T : never, SCHEMA extends z.Schema | Schema = z.Schema<JSONValue$1>, Output extends 'object' | 'array' | 'no-schema' = 'object'>(options: Omit<CallSettings, 'stopSequences'> & Prompt & (Output extends 'no-schema' ? {} : {
     /**
 The schema of the object that the model should generate.
 */
-    schema: z.Schema<OBJECT, z.ZodTypeDef, any> | Schema<OBJECT>;
+    schema: SCHEMA;
     /**
 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.
@@ -4088,131 +4103,17 @@ The schema is converted into 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;
-    /**
-Additional provider-specific options. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
 */
-    providerOptions?: ProviderOptions;
-    /**
-Callback that is invoked when an error occurs during streaming.
-You can use it to log errors.
-The stream processing will pause until the callback promise is resolved.
-   */
-    onError?: StreamObjectOnErrorCallback;
-    /**
-Callback that is called when the LLM response and the final object validation are finished.
-   */
-    onFinish?: StreamObjectOnFinishCallback<OBJECT>;
-    /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        generateId?: () => string;
-        currentDate?: () => Date;
-        now?: () => number;
-    };
-}): StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>;
-/**
-Generate an array with structured, typed elements for a given prompt and element schema 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<ELEMENT>(options: Omit<CallSettings, 'stopSequences'> & Prompt & {
-    output: 'array';
-    /**
-The language model to use.
-   */
-    model: LanguageModel;
-    /**
-The element schema of the array that the model should generate.
-*/
-    schema: z.Schema<ELEMENT, z.ZodTypeDef, any> | Schema<ELEMENT>;
-    /**
-Optional name of the array 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 array 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.
-
-The schema is converted into a JSON schema and used in one of the following ways
-
-- 'auto': The provider will choose the best mode for the model.
-- 'tool': A tool with the JSON schema as parameters is provided and the provider is instructed to use it.
-- 'json': The JSON schema and an instruction are injected into the prompt. If the provider supports JSON mode, it is enabled. If the provider supports JSON grammars, the grammar is used.
-
-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;
-    /**
-Additional provider-specific options. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
-*/
-    providerOptions?: ProviderOptions;
-    /**
-Callback that is invoked when an error occurs during streaming.
-You can use it to log errors.
-The stream processing will pause until the callback promise is resolved.
-   */
-    onError?: StreamObjectOnErrorCallback;
-    /**
-Callback that is called when the LLM response and the final object validation are finished.
-   */
-    onFinish?: StreamObjectOnFinishCallback<Array<ELEMENT>>;
-    /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        generateId?: () => string;
-        currentDate?: () => Date;
-        now?: () => number;
-    };
-}): StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>;
-/**
-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';
+}) & {
+    output?: Output;
     /**
 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;
     /**
 Additional provider-specific options. They are passed through
@@ -4228,8 +4129,8 @@ The stream processing will pause until the callback promise is resolved.
     onError?: StreamObjectOnErrorCallback;
     /**
 Callback that is called when the LLM response and the final object validation are finished.
-   */
-    onFinish?: StreamObjectOnFinishCallback<JSONValue$1>;
+*/
+    onFinish?: StreamObjectOnFinishCallback<RESULT>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -4238,7 +4139,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): StreamObjectResult<JSONValue$1, JSONValue$1, never>;
+}): StreamObjectResult<Output extends 'array' ? RESULT : DeepPartial<RESULT>, Output extends 'array' ? RESULT : RESULT, Output extends 'array' ? RESULT extends Array<infer U> ? AsyncIterableStream<U> : never : never>;
 
 /**
  * A generated audio file.

package/dist/index.d.ts

@@ -3092,7 +3092,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, providerOptions, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, providerOptions, experimental_activeTools: activeTools, experimental_prepareStep: prepareStep, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -3143,6 +3143,28 @@ Optional specification for parsing structured outputs from the LLM response.
      */
     experimental_output?: Output$1<OUTPUT, OUTPUT_PARTIAL>;
     /**
+Optional function that you can use to provide different settings for a step.
+
+@param options - The options for the step.
+@param options.steps - The steps that have been executed so far.
+@param options.stepNumber - The number of the step that is being executed.
+@param options.maxSteps - The maximum number of steps.
+@param options.model - The model that is being used.
+
+@returns An object that contains the settings for the step.
+If you return undefined (or for undefined settings), the settings from the outer level will be used.
+    */
+    experimental_prepareStep?: (options: {
+        steps: Array<StepResult<TOOLS>>;
+        stepNumber: number;
+        maxSteps: number;
+        model: LanguageModel;
+    }) => PromiseLike<{
+        model?: LanguageModel;
+        toolChoice?: ToolChoice<TOOLS>;
+        experimental_activeTools?: Array<keyof TOOLS>;
+    } | undefined>;
+    /**
 A function that attempts to repair a tool call that failed to parse.
      */
     experimental_repairToolCall?: ToolCallRepairFunction<TOOLS>;
@@ -3850,11 +3872,11 @@ This function does not stream the output. If you want to stream the output, use
 @returns
 A result object that contains the generated object, the finish reason, the token usage, and additional information.
  */
-declare function generateObject<TYPE extends SCHEMA extends z.Schema ? Output extends 'array' ? Array<z.infer<SCHEMA>> : z.infer<SCHEMA> : SCHEMA extends Schema<infer T> ? Output extends 'array' ? Array<T> : T : never, SCHEMA extends z.Schema | Schema = z.Schema<JSONValue$1>, Output extends 'object' | 'array' | 'enum' | 'no-schema' = TYPE extends string ? 'enum' : 'object'>(options: Omit<CallSettings, 'stopSequences'> & Prompt & (Output extends 'enum' ? {
+declare function generateObject<RESULT extends SCHEMA extends z.Schema ? Output extends 'array' ? Array<z.infer<SCHEMA>> : z.infer<SCHEMA> : SCHEMA extends Schema<infer T> ? Output extends 'array' ? Array<T> : T : never, SCHEMA extends z.Schema | Schema = z.Schema<JSONValue$1>, Output extends 'object' | 'array' | 'enum' | 'no-schema' = RESULT extends string ? 'enum' : 'object'>(options: Omit<CallSettings, 'stopSequences'> & Prompt & (Output extends 'enum' ? {
     /**
 The enum values that the model should use.
   */
-    enum: Array<TYPE>;
+    enum: Array<RESULT>;
     mode?: 'json';
     output: 'enum';
 } : Output extends 'no-schema' ? {} : {
@@ -3916,7 +3938,7 @@ functionality that can be fully encapsulated in the provider.
         generateId?: () => string;
         currentDate?: () => Date;
     };
-}): Promise<GenerateObjectResult<TYPE>>;
+}): Promise<GenerateObjectResult<RESULT>>;
 
 /**
 The result of a `streamObject` call that contains the partial object stream and additional information.
@@ -4048,27 +4070,20 @@ type StreamObjectOnFinishCallback<RESULT> = (event: {
 }) => Promise<void> | void;
 /**
 Generate a structured, typed object for a given prompt and schema 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<OBJECT>(options: Omit<CallSettings, 'stopSequences'> & Prompt & {
-    output?: 'object' | undefined;
-    /**
-The language model to use.
-   */
-    model: LanguageModel;
+declare function streamObject<RESULT extends SCHEMA extends z.Schema ? Output extends 'array' ? Array<z.infer<SCHEMA>> : z.infer<SCHEMA> : SCHEMA extends Schema<infer T> ? Output extends 'array' ? Array<T> : T : never, SCHEMA extends z.Schema | Schema = z.Schema<JSONValue$1>, Output extends 'object' | 'array' | 'no-schema' = 'object'>(options: Omit<CallSettings, 'stopSequences'> & Prompt & (Output extends 'no-schema' ? {} : {
     /**
 The schema of the object that the model should generate.
 */
-    schema: z.Schema<OBJECT, z.ZodTypeDef, any> | Schema<OBJECT>;
+    schema: SCHEMA;
     /**
 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.
@@ -4088,131 +4103,17 @@ The schema is converted into 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;
-    /**
-Additional provider-specific options. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
 */
-    providerOptions?: ProviderOptions;
-    /**
-Callback that is invoked when an error occurs during streaming.
-You can use it to log errors.
-The stream processing will pause until the callback promise is resolved.
-   */
-    onError?: StreamObjectOnErrorCallback;
-    /**
-Callback that is called when the LLM response and the final object validation are finished.
-   */
-    onFinish?: StreamObjectOnFinishCallback<OBJECT>;
-    /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        generateId?: () => string;
-        currentDate?: () => Date;
-        now?: () => number;
-    };
-}): StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>;
-/**
-Generate an array with structured, typed elements for a given prompt and element schema 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<ELEMENT>(options: Omit<CallSettings, 'stopSequences'> & Prompt & {
-    output: 'array';
-    /**
-The language model to use.
-   */
-    model: LanguageModel;
-    /**
-The element schema of the array that the model should generate.
-*/
-    schema: z.Schema<ELEMENT, z.ZodTypeDef, any> | Schema<ELEMENT>;
-    /**
-Optional name of the array 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 array 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.
-
-The schema is converted into a JSON schema and used in one of the following ways
-
-- 'auto': The provider will choose the best mode for the model.
-- 'tool': A tool with the JSON schema as parameters is provided and the provider is instructed to use it.
-- 'json': The JSON schema and an instruction are injected into the prompt. If the provider supports JSON mode, it is enabled. If the provider supports JSON grammars, the grammar is used.
-
-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;
-    /**
-Additional provider-specific options. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
-*/
-    providerOptions?: ProviderOptions;
-    /**
-Callback that is invoked when an error occurs during streaming.
-You can use it to log errors.
-The stream processing will pause until the callback promise is resolved.
-   */
-    onError?: StreamObjectOnErrorCallback;
-    /**
-Callback that is called when the LLM response and the final object validation are finished.
-   */
-    onFinish?: StreamObjectOnFinishCallback<Array<ELEMENT>>;
-    /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        generateId?: () => string;
-        currentDate?: () => Date;
-        now?: () => number;
-    };
-}): StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>;
-/**
-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';
+}) & {
+    output?: Output;
     /**
 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;
     /**
 Additional provider-specific options. They are passed through
@@ -4228,8 +4129,8 @@ The stream processing will pause until the callback promise is resolved.
     onError?: StreamObjectOnErrorCallback;
     /**
 Callback that is called when the LLM response and the final object validation are finished.
-   */
-    onFinish?: StreamObjectOnFinishCallback<JSONValue$1>;
+*/
+    onFinish?: StreamObjectOnFinishCallback<RESULT>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -4238,7 +4139,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): StreamObjectResult<JSONValue$1, JSONValue$1, never>;
+}): StreamObjectResult<Output extends 'array' ? RESULT : DeepPartial<RESULT>, Output extends 'array' ? RESULT : RESULT, Output extends 'array' ? RESULT extends Array<infer U> ? AsyncIterableStream<U> : never : never>;
 
 /**
  * A generated audio file.