chore (ai): remove sendExtraMessageFields (vercel#6120)

## Background

The message id and createdAt fields are required for any solution that
implements a realistic chatbot. If more control over the request is
needed, filtering can be done using `prepareRequestBody`.

## Summary

Remove `sendExtraMessageFields` (default to true).

Author: lgrammel

.changeset/poor-kids-lick.md

@@ -0,0 +1,5 @@
+---
+'ai': major
+---
+
+chore (ai): remove sendExtraMessageFields

content/docs/04-ai-sdk-ui/03-chatbot-message-persistence.mdx

@@ -96,7 +96,6 @@ export default function Chat({
   const { input, handleInputChange, handleSubmit, messages } = useChat({
     id, // use the provided chat ID
     initialMessages, // initial messages if provided
-    sendExtraMessageFields: true, // send id and createdAt for each message
   });
 
   // simplified rendering code, extend as needed:
@@ -120,8 +119,6 @@ export default function Chat({
 ## Storing messages
 
 `useChat` sends the chat id and the messages to the backend.
-We have enabled the `sendExtraMessageFields` option to send the id and createdAt fields,
-meaning that we store messages in the `useChat` message format.
 
 <Note>
   The `useChat` message format is different from the `ModelMessage` format. The

content/docs/07-reference/02-ai-sdk-ui/01-use-chat.mdx

@@ -152,13 +152,6 @@ Allows you to easily create a conversational user interface for your chatbot app
       description:
         'An optional literal that sets the mode of credentials to be used on the request. Defaults to same-origin.',
     },
-    {
-      name: 'sendExtraMessageFields',
-      type: 'boolean',
-      isOptional: true,
-      description:
-        "An optional boolean that determines whether to send extra fields you've added to `messages`. Defaults to `false` and only the `content` and `role` fields will be sent to the API endpoint. If set to `true`, the `name`, `data`, and `annotations` fields will also be sent.",
-    },
     {
       name: 'maxSteps',
       type: 'number',

content/docs/07-reference/02-ai-sdk-ui/02-use-completion.mdx

@@ -98,12 +98,6 @@ Allows you to create text completion based capabilities for your application. It
       description:
         'An optional literal that sets the mode of credentials to be used on the request. Defaults to same-origin.',
     },
-    {
-      name: 'sendExtraMessageFields',
-      type: 'boolean',
-      description:
-        "An optional boolean that determines whether to send extra fields you've added to `messages`. Defaults to `false` and only the `content` and `role` fields will be sent to the API endpoint.",
-    },
     {
       name: 'streamProtocol',
       type: "'text' | 'data'",
@@ -125,7 +119,8 @@ Allows you to create text completion based capabilities for your application. It
       description:
         'React only. Custom throttle wait time in milliseconds for the completion and data updates. When specified, throttles how often the UI updates during streaming. Default is undefined, which disables throttling.',
     },
-  ]}
+
+]}
 />
 
 ### Returns

examples/next-openai/app/use-chat-persistence-single-message-image-output/[id]/chat.tsx

@@ -11,7 +11,6 @@ export default function Chat({
     api: '/api/use-chat-persistence-single-message-image-output',
     id, // use the provided chatId
     initialMessages, // initial messages if provided
-    sendExtraMessageFields: true, // send id and createdAt for each message
     generateId: createIdGenerator({ prefix: 'msgc', size: 16 }), // id format for client-side messages
 
     // only send the last message to the server:

examples/next-openai/app/use-chat-persistence-single-message-tools/[id]/chat.tsx

@@ -12,7 +12,6 @@ export default function Chat({
       api: '/api/use-chat-persistence-single-message-tools',
       id, // use the provided chatId
       initialMessages, // initial messages if provided
-      sendExtraMessageFields: true, // send id and createdAt for each message
       generateId: createIdGenerator({ prefix: 'msgc', size: 16 }), // id format for client-side messages
 
       // only send the last message to the server:

examples/next-openai/app/use-chat-persistence-single-message/[id]/chat.tsx

@@ -11,7 +11,6 @@ export default function Chat({
     api: '/api/use-chat-persistence-single-message',
     id, // use the provided chatId
     initialMessages, // initial messages if provided
-    sendExtraMessageFields: true, // send id and createdAt for each message
     generateId: createIdGenerator({ prefix: 'msgc', size: 16 }), // id format for client-side messages
 
     // only send the last message to the server:

examples/next-openai/app/use-chat-persistence/[id]/chat.tsx

@@ -11,7 +11,6 @@ export default function Chat({
     api: '/api/use-chat-persistence',
     id, // use the provided chatId
     initialMessages, // initial messages if provided
-    sendExtraMessageFields: true, // send id and createdAt for each message
     generateId: createIdGenerator({ prefix: 'msgc', size: 16 }), // id format for client-side messages
   });
 

examples/next-openai/app/use-chat-resilient-persistence/[id]/chat.tsx

@@ -12,7 +12,6 @@ export default function Chat({
       api: '/api/use-chat-resilient-persistence',
       id, // use the provided chatId
       initialMessages, // initial messages if provided
-      sendExtraMessageFields: true, // send id and createdAt for each message
       generateId: createIdGenerator({ prefix: 'msgc', size: 16 }), // id format for client-side messages
     });
 

examples/next-openai/app/use-chat-resume/chat.tsx

@@ -28,7 +28,6 @@ export function Chat({
     id: chatId,
     api: '/api/use-chat-resume',
     initialMessages,
-    sendExtraMessageFields: true,
     onError: error => {
       console.error('Error streaming text:', error);
     },
@@ -43,15 +42,15 @@ export function Chat({
   }, []);
 
   return (
-    <div className="flex flex-col w-full max-w-md py-24 mx-auto stretch gap-8">
+    <div className="flex flex-col w-full max-w-md gap-8 py-24 mx-auto stretch">
       <Link href={`/use-chat-resume/${chatId}`} target="_noblank">
         Chat Id: {chatId}
       </Link>
 
       <div>Status: {status}</div>
 
       {messages.map(message => (
-        <div key={message.id} className="whitespace-pre-wrap flex flex-row">
+        <div key={message.id} className="flex flex-row whitespace-pre-wrap">
           <div className="min-w-12">
             {message.role === 'user' ? 'User: ' : 'AI: '}
           </div>

examples/nuxt-openai/pages/use-chat-request/index.vue

@@ -4,7 +4,6 @@ import { createIdGenerator } from 'ai';
 
 const { input, handleSubmit, messages } = useChat({
   api: '/api/use-chat-request',
-  sendExtraMessageFields: true,
   generateId: createIdGenerator({ prefix: 'msgc', size: 16 }),
 
   experimental_prepareRequestBody({ messages }) {

packages/ai/core/types/ui-messages.ts

@@ -315,13 +315,6 @@ either synchronously or asynchronously.
    */
   body?: object;
 
-  /**
-   * Whether to send extra message fields such as `message.id` and `message.createdAt` to the API.
-   * Defaults to `false`. When set to `true`, the API endpoint might need to
-   * handle the extra fields before forwarding the request to the AI service.
-   */
-  sendExtraMessageFields?: boolean;
-
   /**
 Streaming protocol that is used. Defaults to `data`.
    */

packages/react/src/use-chat.ts

@@ -129,7 +129,6 @@ export function useChat({
   id,
   initialMessages,
   initialInput = '',
-  sendExtraMessageFields,
   onToolCall,
   experimental_prepareRequestBody,
   maxSteps = 1,
@@ -266,19 +265,9 @@ Default is undefined, which disables throttling.
           throttleWaitMs,
         );
 
-        // Do an optimistic update to the chat state to show the updated messages immediately:
-        const previousMessages = messagesRef.current;
+        // Do an optimistic update to show the updated messages immediately:
         throttledMutate(chatMessages, false);
 
-        const constructedMessagesPayload = sendExtraMessageFields
-          ? chatMessages
-          : chatMessages.map(({ role, content, annotations, parts }) => ({
-              role,
-              content,
-              ...(annotations !== undefined && { annotations }),
-              ...(parts !== undefined && { parts }),
-            }));
-
         const existingData = streamDataRef.current;
 
         await callChatApi({
@@ -290,7 +279,7 @@ Default is undefined, which disables throttling.
             requestBody: chatRequest.body,
           }) ?? {
             id: chatId,
-            messages: constructedMessagesPayload,
+            messages: chatMessages,
             data: chatRequest.data,
             ...extraMetadataRef.current.body,
             ...chatRequest.body,
@@ -377,7 +366,6 @@ Default is undefined, which disables throttling.
       mutateStreamData,
       streamDataRef,
       streamProtocol,
-      sendExtraMessageFields,
       experimental_prepareRequestBody,
       onToolCall,
       maxSteps,