ai 0.0.0-156c9f7b-20250115085202 → 0.0.0-677c097b-20250505090413

package/rsc/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { LanguageModelV1FinishReason, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, LanguageModelV1 } from '@ai-sdk/provider';
 import { ReactNode } from 'react';
 import { z } from 'zod';
-import { ToolInvocation, Attachment } from '@ai-sdk/ui-utils';
+import { Message } from '@ai-sdk/ui-utils';
 
 type AIAction<T = any, R = any> = (...args: T[]) => Promise<R>;
 type AIActions<T = any, R = any> = Record<string, AIAction<T, R>>;
@@ -199,17 +199,25 @@ Tool choice for the generation. It supports the following settings:
 - `none`: the model must not call tools
 - `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
  */
-type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
     type: 'tool';
     toolName: keyof TOOLS;
 };
 
 /**
-Additional provider-specific metadata. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
+Additional provider-specific metadata that is returned from the provider.
+
+This is needed to enable provider-specific functionality that can be
+fully encapsulated in the provider.
  */
 type ProviderMetadata = LanguageModelV1ProviderMetadata;
+/**
+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.
+ */
+type ProviderOptions = LanguageModelV1ProviderMetadata;
 
 /**
 Represents the number of tokens used in a prompt and completion.
@@ -256,6 +264,10 @@ interface TextPart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -279,6 +291,10 @@ interface ImagePart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -295,6 +311,10 @@ interface FilePart {
      */
     data: DataContent | URL;
     /**
+  Optional filename of the file.
+     */
+    filename?: string;
+    /**
   Mime type of the file.
      */
     mimeType: string;
@@ -302,6 +322,54 @@ interface FilePart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
+   */
+    experimental_providerMetadata?: ProviderMetadata;
+}
+/**
+ * Reasoning content part of a prompt. It contains a reasoning.
+ */
+interface ReasoningPart {
+    type: 'reasoning';
+    /**
+  The reasoning text.
+     */
+    text: string;
+    /**
+  An optional signature for verifying that the reasoning originated from the model.
+     */
+    signature?: string;
+    /**
+  Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
+   */
+    experimental_providerMetadata?: ProviderMetadata;
+}
+/**
+Redacted reasoning content part of a prompt.
+ */
+interface RedactedReasoningPart {
+    type: 'redacted-reasoning';
+    /**
+  Redacted reasoning data.
+     */
+    data: string;
+    /**
+  Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -326,6 +394,10 @@ interface ToolCallPart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -358,6 +430,10 @@ interface ToolResultPart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -376,6 +452,10 @@ type CoreSystemMessage = {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 };
@@ -390,6 +470,10 @@ type CoreUserMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -407,12 +491,17 @@ type CoreAssistantMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
-Content of an assistant message. It can be a string or an array of text and tool call parts.
+Content of an assistant message.
+It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
  */
-type AssistantContent = string | Array<TextPart | ToolCallPart>;
+type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | RedactedReasoningPart | ToolCallPart>;
 /**
 A tool message. It contains the result of one or more tool calls.
  */
@@ -424,6 +513,10 @@ type CoreToolMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -436,13 +529,6 @@ It can be a user message, an assistant message, or a tool message.
  */
 type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
 
-type UIMessage = {
-    role: 'system' | 'user' | 'assistant' | 'data';
-    content: string;
-    toolInvocations?: ToolInvocation[];
-    experimental_attachments?: Attachment[];
-};
-
 /**
 Prompt part of the AI function options.
 It contains a system message, a simple text prompt, or a list of messages.
@@ -459,7 +545,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage> | Array<UIMessage>;
+    messages?: Array<CoreMessage> | Array<Omit<Message, 'id'>>;
 };
 
 type Streamable = ReactNode | Promise<ReactNode>;
@@ -500,7 +586,7 @@ type RenderResult = {
  */
 declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
-} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, initial, text, experimental_providerMetadata: providerMetadata, onFinish, ...settings }: CallSettings & Prompt & {
+} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, initial, text, experimental_providerMetadata, providerOptions, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -514,14 +600,18 @@ declare function streamUI<TOOLS extends {
     /**
      * The tool choice strategy. Default: 'auto'.
      */
-    toolChoice?: CoreToolChoice<TOOLS>;
+    toolChoice?: ToolChoice<TOOLS>;
     text?: RenderText;
     initial?: ReactNode;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
+*/
     experimental_providerMetadata?: ProviderMetadata;
     /**
      * Callback that is called when the LLM response and the final object validation are finished.

package/rsc/dist/rsc-server.d.mts

@@ -1,7 +1,7 @@
 import { LanguageModelV1FinishReason, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, LanguageModelV1 } from '@ai-sdk/provider';
 import { ReactNode } from 'react';
 import { z } from 'zod';
-import { ToolInvocation, Attachment } from '@ai-sdk/ui-utils';
+import { Message } from '@ai-sdk/ui-utils';
 
 type AIAction<T = any, R = any> = (...args: T[]) => Promise<R>;
 type AIActions<T = any, R = any> = Record<string, AIAction<T, R>>;
@@ -197,17 +197,25 @@ Tool choice for the generation. It supports the following settings:
 - `none`: the model must not call tools
 - `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
  */
-type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
     type: 'tool';
     toolName: keyof TOOLS;
 };
 
 /**
-Additional provider-specific metadata. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
+Additional provider-specific metadata that is returned from the provider.
+
+This is needed to enable provider-specific functionality that can be
+fully encapsulated in the provider.
  */
 type ProviderMetadata = LanguageModelV1ProviderMetadata;
+/**
+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.
+ */
+type ProviderOptions = LanguageModelV1ProviderMetadata;
 
 /**
 Represents the number of tokens used in a prompt and completion.
@@ -254,6 +262,10 @@ interface TextPart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -277,6 +289,10 @@ interface ImagePart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -293,6 +309,10 @@ interface FilePart {
      */
     data: DataContent | URL;
     /**
+  Optional filename of the file.
+     */
+    filename?: string;
+    /**
   Mime type of the file.
      */
     mimeType: string;
@@ -300,6 +320,54 @@ interface FilePart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
+   */
+    experimental_providerMetadata?: ProviderMetadata;
+}
+/**
+ * Reasoning content part of a prompt. It contains a reasoning.
+ */
+interface ReasoningPart {
+    type: 'reasoning';
+    /**
+  The reasoning text.
+     */
+    text: string;
+    /**
+  An optional signature for verifying that the reasoning originated from the model.
+     */
+    signature?: string;
+    /**
+  Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
+   */
+    experimental_providerMetadata?: ProviderMetadata;
+}
+/**
+Redacted reasoning content part of a prompt.
+ */
+interface RedactedReasoningPart {
+    type: 'redacted-reasoning';
+    /**
+  Redacted reasoning data.
+     */
+    data: string;
+    /**
+  Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -324,6 +392,10 @@ interface ToolCallPart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -356,6 +428,10 @@ interface ToolResultPart {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -374,6 +450,10 @@ type CoreSystemMessage = {
   Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 };
@@ -388,6 +468,10 @@ type CoreUserMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -405,12 +489,17 @@ type CoreAssistantMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
-Content of an assistant message. It can be a string or an array of text and tool call parts.
+Content of an assistant message.
+It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
  */
-type AssistantContent = string | Array<TextPart | ToolCallPart>;
+type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | RedactedReasoningPart | ToolCallPart>;
 /**
 A tool message. It contains the result of one or more tool calls.
  */
@@ -422,6 +511,10 @@ type CoreToolMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -434,13 +527,6 @@ It can be a user message, an assistant message, or a tool message.
  */
 type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
 
-type UIMessage = {
-    role: 'system' | 'user' | 'assistant' | 'data';
-    content: string;
-    toolInvocations?: ToolInvocation[];
-    experimental_attachments?: Attachment[];
-};
-
 /**
 Prompt part of the AI function options.
 It contains a system message, a simple text prompt, or a list of messages.
@@ -457,7 +543,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage> | Array<UIMessage>;
+    messages?: Array<CoreMessage> | Array<Omit<Message, 'id'>>;
 };
 
 type Streamable = ReactNode | Promise<ReactNode>;
@@ -498,7 +584,7 @@ type RenderResult = {
  */
 declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
-} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, initial, text, experimental_providerMetadata: providerMetadata, onFinish, ...settings }: CallSettings & Prompt & {
+} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, initial, text, experimental_providerMetadata, providerOptions, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -512,14 +598,18 @@ declare function streamUI<TOOLS extends {
     /**
      * The tool choice strategy. Default: 'auto'.
      */
-    toolChoice?: CoreToolChoice<TOOLS>;
+    toolChoice?: ToolChoice<TOOLS>;
     text?: RenderText;
     initial?: ReactNode;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
+*/
     experimental_providerMetadata?: ProviderMetadata;
     /**
      * Callback that is called when the LLM response and the final object validation are finished.