ai 3.4.25 → 3.4.27

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ai
 
+## 3.4.27
+
+### Patch Changes
+
+- fa772ae: feat (ai/core): automatically convert ui messages to core messages
+
+## 3.4.26
+
+### Patch Changes
+
+- 57f39ea: feat (ai/core): support multi-modal tool results in convertToCoreMessages
+
 ## 3.4.25
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Schema, DeepPartial, ToolInvocation, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
+import { ToolInvocation, Attachment, Schema, DeepPartial, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1CallOptions, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
@@ -634,6 +634,13 @@ 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' | 'function' | 'data' | 'tool';
+    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.
@@ -650,7 +657,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage>;
+    messages?: Array<CoreMessage> | Array<UIMessage>;
 };
 
 /**
@@ -1321,17 +1328,13 @@ declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARA
  */
 type ExperimentalTool = CoreTool;
 
-type ConvertibleMessage = {
-    role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
-    content: string;
-    toolInvocations?: ToolInvocation[];
-    experimental_attachments?: Attachment[];
-};
 /**
 Converts an array of messages from useChat into an array of CoreMessages that can be used
 with the AI core functions (e.g. `streamText`).
  */
-declare function convertToCoreMessages(messages: Array<ConvertibleMessage>): CoreMessage[];
+declare function convertToCoreMessages<TOOLS extends Record<string, CoreTool> = never>(messages: Array<UIMessage>, options?: {
+    tools?: TOOLS;
+}): CoreMessage[];
 
 /**
 Create a union of the given object's values, and optionally specify which keys to get the values from.
@@ -2427,9 +2430,9 @@ declare class InvalidMessageRoleError extends AISDKError {
 declare const symbol$2: unique symbol;
 declare class MessageConversionError extends AISDKError {
     private readonly [symbol$2];
-    readonly originalMessage: ConvertibleMessage;
+    readonly originalMessage: UIMessage;
     constructor({ originalMessage, message, }: {
-        originalMessage: ConvertibleMessage;
+        originalMessage: UIMessage;
         message: string;
     });
     static isInstance(error: unknown): error is MessageConversionError;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Schema, DeepPartial, ToolInvocation, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
+import { ToolInvocation, Attachment, Schema, DeepPartial, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1CallOptions, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
@@ -634,6 +634,13 @@ 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' | 'function' | 'data' | 'tool';
+    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.
@@ -650,7 +657,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage>;
+    messages?: Array<CoreMessage> | Array<UIMessage>;
 };
 
 /**
@@ -1321,17 +1328,13 @@ declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARA
  */
 type ExperimentalTool = CoreTool;
 
-type ConvertibleMessage = {
-    role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
-    content: string;
-    toolInvocations?: ToolInvocation[];
-    experimental_attachments?: Attachment[];
-};
 /**
 Converts an array of messages from useChat into an array of CoreMessages that can be used
 with the AI core functions (e.g. `streamText`).
  */
-declare function convertToCoreMessages(messages: Array<ConvertibleMessage>): CoreMessage[];
+declare function convertToCoreMessages<TOOLS extends Record<string, CoreTool> = never>(messages: Array<UIMessage>, options?: {
+    tools?: TOOLS;
+}): CoreMessage[];
 
 /**
 Create a union of the given object's values, and optionally specify which keys to get the values from.
@@ -2427,9 +2430,9 @@ declare class InvalidMessageRoleError extends AISDKError {
 declare const symbol$2: unique symbol;
 declare class MessageConversionError extends AISDKError {
     private readonly [symbol$2];
-    readonly originalMessage: ConvertibleMessage;
+    readonly originalMessage: UIMessage;
     constructor({ originalMessage, message, }: {
-        originalMessage: ConvertibleMessage;
+        originalMessage: UIMessage;
         message: string;
     });
     static isInstance(error: unknown): error is MessageConversionError;