ai 5.0.0-canary.16 → 5.0.0-canary.18

package/dist/internal/index.d.mts

@@ -1,20 +1,7 @@
-import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { SharedV2ProviderOptions, JSONValue as JSONValue$1, LanguageModelV2Source, LanguageModelV2Usage, LanguageModelV2FinishReason, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
+import { ToolResultContent, ToolCall, ToolResult, Schema } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
-import { ToolCall, ToolResult, Schema } from '@ai-sdk/provider-utils';
-
-type ToolResultContent = Array<{
-    type: 'text';
-    text: string;
-} | {
-    type: 'image';
-    data: string;
-    mediaType?: string;
-    /**
-     * @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
-}>;
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { SharedV2ProviderOptions, JSONValue as JSONValue$1, LanguageModelV2Source, LanguageModelV2FinishReason, LanguageModelV2Usage, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
 
 /**
 Additional provider-specific options.
@@ -64,10 +51,6 @@ interface ImagePart {
      */
     mediaType?: string;
     /**
-  @deprecated Use `mediaType` instead.
-     */
-    mimeType?: 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.
@@ -97,10 +80,6 @@ interface FilePart {
      */
     mediaType: string;
     /**
-  @deprecated Use `mediaType` instead.
-     */
-    mimeType?: 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.
@@ -187,7 +166,7 @@ interface ToolResultPart {
  to increase the resilience against prompt injection attacks,
  and because not all providers support several system messages.
  */
-type CoreSystemMessage = {
+type SystemModelMessage = {
     role: 'system';
     content: string;
     /**
@@ -200,7 +179,7 @@ type CoreSystemMessage = {
 /**
 A user message. It can contain text or a combination of text and images.
  */
-type CoreUserMessage = {
+type UserModelMessage = {
     role: 'user';
     content: UserContent;
     /**
@@ -217,7 +196,7 @@ type UserContent = string | Array<TextPart | ImagePart | FilePart>;
 /**
 An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
  */
-type CoreAssistantMessage = {
+type AssistantModelMessage = {
     role: 'assistant';
     content: AssistantContent;
     /**
@@ -235,7 +214,7 @@ type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | Too
 /**
 A tool message. It contains the result of one or more tool calls.
  */
-type CoreToolMessage = {
+type ToolModelMessage = {
     role: 'tool';
     content: ToolContent;
     /**
@@ -253,7 +232,7 @@ type ToolContent = Array<ToolResultPart>;
 A message that can be used in the `messages` field of a prompt.
 It can be a user message, an assistant message, or a tool message.
  */
-type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
+type ModelMessage = SystemModelMessage | UserModelMessage | AssistantModelMessage | ToolModelMessage;
 
 type JSONValue = JSONValue$1;
 
@@ -293,24 +272,6 @@ type ToolInvocation = ({
     state: 'result';
     step?: number;
 } & ToolResult<string, any, any>);
-/**
- * An attachment that can be sent along with a message.
- */
-interface Attachment {
-    /**
-     * The name of the attachment, usually the file name.
-     */
-    name?: string;
-    /**
-     * A string indicating the [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).
-     * By default, it's extracted from the pathname's extension.
-     */
-    contentType?: string;
-    /**
-     * The URL of the attachment. It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
-     */
-    url: string;
-}
 /**
  * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
  */
@@ -328,10 +289,6 @@ interface UIMessage {
      */
     content: string;
     /**
-  Additional attachments to be sent along with the message.
-     */
-    experimental_attachments?: Attachment[];
-    /**
   The role of the message.
      */
     role: 'system' | 'user' | 'assistant';
@@ -342,8 +299,12 @@ interface UIMessage {
     /**
   The parts of the message. Use this for rendering the message in the UI.
   
-  Assistant messages can have text, reasoning and tool invocation parts.
-  User messages can have text parts.
+  System messages should be avoided (set the system prompt on the server instead).
+  They can have text parts.
+  
+  User messages can have text parts and file parts.
+  
+  Assistant messages can have text, reasoning, tool invocation, and file parts.
      */
     parts: Array<UIMessagePart>;
 }
@@ -404,9 +365,14 @@ type FileUIPart = {
      */
     mediaType: string;
     /**
-     * The base64 encoded data.
+     * Optional filename of the file.
+     */
+    filename?: string;
+    /**
+     * The URL of the file.
+     * It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
      */
-    data: string;
+    url: string;
 };
 /**
  * A step boundary part of a message.
@@ -415,25 +381,6 @@ type StepStartUIPart = {
     type: 'step-start';
 };
 
-/**
-Represents the number of tokens used in a prompt and completion.
- */
-type LanguageModelUsage = {
-    /**
-  The number of tokens used in the prompt.
-     */
-    promptTokens: number;
-    /**
-  The number of tokens used in the completion.
-   */
-    completionTokens: number;
-    /**
-  The total number of tokens used (promptTokens + completionTokens).
-     */
-    totalTokens: number;
-};
-declare function calculateLanguageModelUsage({ inputTokens, outputTokens, }: LanguageModelV2Usage): LanguageModelUsage;
-
 type DataStreamString = `${(typeof DataStreamStringPrefixes)[keyof typeof DataStreamStringPrefixes]}:${string}\n`;
 interface DataStreamPart<CODE extends string, NAME extends string, TYPE> {
     code: CODE;
@@ -451,25 +398,19 @@ declare const dataStreamParts: readonly [DataStreamPart<"0", "text", string>, Da
     argsTextDelta: string;
 }>, DataStreamPart<"d", "finish_message", {
     finishReason: LanguageModelV2FinishReason;
-    usage?: {
-        promptTokens: number;
-        completionTokens: number;
-    };
+    usage?: LanguageModelV2Usage;
 }>, DataStreamPart<"e", "finish_step", {
     isContinued: boolean;
     finishReason: LanguageModelV2FinishReason;
-    usage?: {
-        promptTokens: number;
-        completionTokens: number;
-    };
+    usage?: LanguageModelV2Usage;
 }>, DataStreamPart<"f", "start_step", {
     messageId: string;
 }>, DataStreamPart<"g", "reasoning", {
     text: string;
     providerMetadata?: Record<string, any> | undefined;
 }>, DataStreamPart<"h", "source", LanguageModelV2Source>, DataStreamPart<"l", "reasoning_part_finish", {}>, DataStreamPart<"k", "file", {
-    data: string;
-    mimeType: string;
+    url: string;
+    mediaType: string;
 }>];
 type DataStreamParts = (typeof dataStreamParts)[number];
 /**
@@ -502,7 +443,7 @@ type DataStreamPartValueType = {
  */
 declare const DataStreamStringPrefixes: { [K in DataStreamParts["name"]]: (typeof dataStreamParts)[number]["code"]; };
 /**
-Prepends a string with a prefix from the `StreamChunkPrefixes`, JSON-ifies it,
+Prepends a string with a prefix from the `StreamChunkPrefixes`, converts it to JSON,
 and appends a new line.
 
 It ensures type-safety for the part type and value.
@@ -519,7 +460,7 @@ interface ToolExecutionOptions {
      * Messages that were sent to the language model to initiate the response that contained the tool call.
      * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
      */
-    messages: CoreMessage[];
+    messages: ModelMessage[];
     /**
      * An optional abort signal that indicates that the overall operation should be aborted.
      */
@@ -597,7 +538,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage> | Array<Omit<UIMessage, 'id'>>;
+    messages?: Array<ModelMessage> | Array<Omit<UIMessage, 'id'>>;
 };
 
 type StandardizedPrompt = {
@@ -608,7 +549,7 @@ type StandardizedPrompt = {
     /**
      * Messages.
      */
-    messages: CoreMessage[];
+    messages: ModelMessage[];
 };
 declare function standardizePrompt<TOOLS extends ToolSet>({ prompt, tools, }: {
     prompt: Prompt;
@@ -846,4 +787,4 @@ declare function createCallbacksTransformer(callbacks?: StreamCallbacks | undefi
  */
 declare const HANGING_STREAM_WARNING_TIME_MS: number;
 
-export { DataStreamWriter, HANGING_STREAM_WARNING_TIME_MS, StreamCallbacks, StreamData, calculateLanguageModelUsage, convertToLanguageModelPrompt, createCallbacksTransformer, formatDataStreamPart, mergeStreams, prepareCallSettings, prepareResponseHeaders, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };
+export { DataStreamWriter, HANGING_STREAM_WARNING_TIME_MS, StreamCallbacks, StreamData, convertToLanguageModelPrompt, createCallbacksTransformer, formatDataStreamPart, mergeStreams, prepareCallSettings, prepareResponseHeaders, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };

package/dist/internal/index.d.ts

@@ -1,20 +1,7 @@
-import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { SharedV2ProviderOptions, JSONValue as JSONValue$1, LanguageModelV2Source, LanguageModelV2Usage, LanguageModelV2FinishReason, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
+import { ToolResultContent, ToolCall, ToolResult, Schema } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
-import { ToolCall, ToolResult, Schema } from '@ai-sdk/provider-utils';
-
-type ToolResultContent = Array<{
-    type: 'text';
-    text: string;
-} | {
-    type: 'image';
-    data: string;
-    mediaType?: string;
-    /**
-     * @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
-}>;
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { SharedV2ProviderOptions, JSONValue as JSONValue$1, LanguageModelV2Source, LanguageModelV2FinishReason, LanguageModelV2Usage, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
 
 /**
 Additional provider-specific options.
@@ -64,10 +51,6 @@ interface ImagePart {
      */
     mediaType?: string;
     /**
-  @deprecated Use `mediaType` instead.
-     */
-    mimeType?: 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.
@@ -97,10 +80,6 @@ interface FilePart {
      */
     mediaType: string;
     /**
-  @deprecated Use `mediaType` instead.
-     */
-    mimeType?: 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.
@@ -187,7 +166,7 @@ interface ToolResultPart {
  to increase the resilience against prompt injection attacks,
  and because not all providers support several system messages.
  */
-type CoreSystemMessage = {
+type SystemModelMessage = {
     role: 'system';
     content: string;
     /**
@@ -200,7 +179,7 @@ type CoreSystemMessage = {
 /**
 A user message. It can contain text or a combination of text and images.
  */
-type CoreUserMessage = {
+type UserModelMessage = {
     role: 'user';
     content: UserContent;
     /**
@@ -217,7 +196,7 @@ type UserContent = string | Array<TextPart | ImagePart | FilePart>;
 /**
 An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
  */
-type CoreAssistantMessage = {
+type AssistantModelMessage = {
     role: 'assistant';
     content: AssistantContent;
     /**
@@ -235,7 +214,7 @@ type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | Too
 /**
 A tool message. It contains the result of one or more tool calls.
  */
-type CoreToolMessage = {
+type ToolModelMessage = {
     role: 'tool';
     content: ToolContent;
     /**
@@ -253,7 +232,7 @@ type ToolContent = Array<ToolResultPart>;
 A message that can be used in the `messages` field of a prompt.
 It can be a user message, an assistant message, or a tool message.
  */
-type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
+type ModelMessage = SystemModelMessage | UserModelMessage | AssistantModelMessage | ToolModelMessage;
 
 type JSONValue = JSONValue$1;
 
@@ -293,24 +272,6 @@ type ToolInvocation = ({
     state: 'result';
     step?: number;
 } & ToolResult<string, any, any>);
-/**
- * An attachment that can be sent along with a message.
- */
-interface Attachment {
-    /**
-     * The name of the attachment, usually the file name.
-     */
-    name?: string;
-    /**
-     * A string indicating the [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).
-     * By default, it's extracted from the pathname's extension.
-     */
-    contentType?: string;
-    /**
-     * The URL of the attachment. It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
-     */
-    url: string;
-}
 /**
  * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
  */
@@ -328,10 +289,6 @@ interface UIMessage {
      */
     content: string;
     /**
-  Additional attachments to be sent along with the message.
-     */
-    experimental_attachments?: Attachment[];
-    /**
   The role of the message.
      */
     role: 'system' | 'user' | 'assistant';
@@ -342,8 +299,12 @@ interface UIMessage {
     /**
   The parts of the message. Use this for rendering the message in the UI.
   
-  Assistant messages can have text, reasoning and tool invocation parts.
-  User messages can have text parts.
+  System messages should be avoided (set the system prompt on the server instead).
+  They can have text parts.
+  
+  User messages can have text parts and file parts.
+  
+  Assistant messages can have text, reasoning, tool invocation, and file parts.
      */
     parts: Array<UIMessagePart>;
 }
@@ -404,9 +365,14 @@ type FileUIPart = {
      */
     mediaType: string;
     /**
-     * The base64 encoded data.
+     * Optional filename of the file.
+     */
+    filename?: string;
+    /**
+     * The URL of the file.
+     * It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
      */
-    data: string;
+    url: string;
 };
 /**
  * A step boundary part of a message.
@@ -415,25 +381,6 @@ type StepStartUIPart = {
     type: 'step-start';
 };
 
-/**
-Represents the number of tokens used in a prompt and completion.
- */
-type LanguageModelUsage = {
-    /**
-  The number of tokens used in the prompt.
-     */
-    promptTokens: number;
-    /**
-  The number of tokens used in the completion.
-   */
-    completionTokens: number;
-    /**
-  The total number of tokens used (promptTokens + completionTokens).
-     */
-    totalTokens: number;
-};
-declare function calculateLanguageModelUsage({ inputTokens, outputTokens, }: LanguageModelV2Usage): LanguageModelUsage;
-
 type DataStreamString = `${(typeof DataStreamStringPrefixes)[keyof typeof DataStreamStringPrefixes]}:${string}\n`;
 interface DataStreamPart<CODE extends string, NAME extends string, TYPE> {
     code: CODE;
@@ -451,25 +398,19 @@ declare const dataStreamParts: readonly [DataStreamPart<"0", "text", string>, Da
     argsTextDelta: string;
 }>, DataStreamPart<"d", "finish_message", {
     finishReason: LanguageModelV2FinishReason;
-    usage?: {
-        promptTokens: number;
-        completionTokens: number;
-    };
+    usage?: LanguageModelV2Usage;
 }>, DataStreamPart<"e", "finish_step", {
     isContinued: boolean;
     finishReason: LanguageModelV2FinishReason;
-    usage?: {
-        promptTokens: number;
-        completionTokens: number;
-    };
+    usage?: LanguageModelV2Usage;
 }>, DataStreamPart<"f", "start_step", {
     messageId: string;
 }>, DataStreamPart<"g", "reasoning", {
     text: string;
     providerMetadata?: Record<string, any> | undefined;
 }>, DataStreamPart<"h", "source", LanguageModelV2Source>, DataStreamPart<"l", "reasoning_part_finish", {}>, DataStreamPart<"k", "file", {
-    data: string;
-    mimeType: string;
+    url: string;
+    mediaType: string;
 }>];
 type DataStreamParts = (typeof dataStreamParts)[number];
 /**
@@ -502,7 +443,7 @@ type DataStreamPartValueType = {
  */
 declare const DataStreamStringPrefixes: { [K in DataStreamParts["name"]]: (typeof dataStreamParts)[number]["code"]; };
 /**
-Prepends a string with a prefix from the `StreamChunkPrefixes`, JSON-ifies it,
+Prepends a string with a prefix from the `StreamChunkPrefixes`, converts it to JSON,
 and appends a new line.
 
 It ensures type-safety for the part type and value.
@@ -519,7 +460,7 @@ interface ToolExecutionOptions {
      * Messages that were sent to the language model to initiate the response that contained the tool call.
      * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
      */
-    messages: CoreMessage[];
+    messages: ModelMessage[];
     /**
      * An optional abort signal that indicates that the overall operation should be aborted.
      */
@@ -597,7 +538,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage> | Array<Omit<UIMessage, 'id'>>;
+    messages?: Array<ModelMessage> | Array<Omit<UIMessage, 'id'>>;
 };
 
 type StandardizedPrompt = {
@@ -608,7 +549,7 @@ type StandardizedPrompt = {
     /**
      * Messages.
      */
-    messages: CoreMessage[];
+    messages: ModelMessage[];
 };
 declare function standardizePrompt<TOOLS extends ToolSet>({ prompt, tools, }: {
     prompt: Prompt;
@@ -846,4 +787,4 @@ declare function createCallbacksTransformer(callbacks?: StreamCallbacks | undefi
  */
 declare const HANGING_STREAM_WARNING_TIME_MS: number;
 
-export { DataStreamWriter, HANGING_STREAM_WARNING_TIME_MS, StreamCallbacks, StreamData, calculateLanguageModelUsage, convertToLanguageModelPrompt, createCallbacksTransformer, formatDataStreamPart, mergeStreams, prepareCallSettings, prepareResponseHeaders, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };
+export { DataStreamWriter, HANGING_STREAM_WARNING_TIME_MS, StreamCallbacks, StreamData, convertToLanguageModelPrompt, createCallbacksTransformer, formatDataStreamPart, mergeStreams, prepareCallSettings, prepareResponseHeaders, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };