ai 4.0.0-canary.9 → 4.0.1

package/CHANGELOG.md

@@ -1,5 +1,121 @@
 # ai
 
+## 4.0.1
+
+### Patch Changes
+
+- b117255: feat (ai/core): add messages to tool call options
+
+## 4.0.0
+
+### Major Changes
+
+- 4e38b38: chore (ai): remove LanguageModelResponseMetadataWithHeaders type
+- 8bf5756: chore: remove legacy function/tool calling
+- f0cb69d: chore (ai/core): remove experimental function exports
+- da8c609: chore (ai): remove Tokens RSC helper
+- cbab571: chore (ai): remove ExperimentalXXXMessage types
+- b469a7e: chore: remove isXXXError methods
+- 54cb888: chore (ai): remove experimental_StreamData export
+- 4d61295: chore (ai): remove streamToResponse and streamingTextResponse
+- 9a3d741: chore (ai): remove ExperimentalTool export
+- 064257d: chore (ai/core): rename simulateReadableStream values parameter to chunks
+- 60e69ed: chore (ai/core): remove ai-stream related methods from streamText
+- a4f8ce9: chore (ai): AssistantResponse cleanups
+- d3ae4f6: chore (ui/react): remove useObject setInput helper
+- 7264b0a: chore (ai): remove responseMessages property from streamText/generateText result
+- b801982: chore (ai/core): remove init option from streamText result methods
+- f68d7b1: chore (ai/core): streamObject returns result immediately (no Promise)
+- 6090cea: chore (ai): remove rawResponse from generate/stream result objects
+- 073f282: chore (ai): remove AIStream and related exports
+- 1c58337: chore (ai): remove 2.x prompt helpers
+- a40a93d: chore (ai/ui): remove vue, svelte, solid re-export and dependency
+- a7ad35a: chore: remove legacy providers & rsc render
+- c0ddc24: chore (ai): remove toJSON method from AI SDK errors
+- 007cb81: chore (ai): change `streamText` warnings result to Promise
+- effbce3: chore (ai): remove responseMessage from streamText onFinish callback
+- 545d133: chore (ai): remove deprecated roundtrip settings from streamText / generateText
+- 7e89ccb: chore: remove nanoid export
+- f967199: chore (ai/core): streamText returns result immediately (no Promise)
+- 62d08fd: chore (ai): remove TokenUsage, CompletionTokenUsage, and EmbeddingTokenUsage types
+- e5d2ce8: chore (ai): remove deprecated provider registry exports
+- 70ce742: chore (ai): remove experimental_continuationSteps option
+- 2f09717: chore (ai): remove deprecated telemetry data
+- 0827bf9: chore (ai): remove LangChain adapter `toAIStream` method
+
+### Patch Changes
+
+- dce4158: chore (dependencies): update eventsource-parser to 3.0.0
+- f0ec721: chore (ai): remove openai peer dependency
+- f9bb30c: chore (ai): remove unnecessary dev dependencies
+- b053413: chore (ui): refactorings & README update
+- Updated dependencies [e117b54]
+- Updated dependencies [8bf5756]
+- Updated dependencies [b469a7e]
+- Updated dependencies [79c6dd9]
+- Updated dependencies [9f81e66]
+- Updated dependencies [70f28f6]
+- Updated dependencies [dce4158]
+- Updated dependencies [d3ae4f6]
+- Updated dependencies [68d30e9]
+- Updated dependencies [7814c4b]
+- Updated dependencies [ca3e586]
+- Updated dependencies [c0ddc24]
+- Updated dependencies [fe4f109]
+- Updated dependencies [84edae5]
+- Updated dependencies [b1da952]
+- Updated dependencies [04d3747]
+- Updated dependencies [dce4158]
+- Updated dependencies [7e89ccb]
+- Updated dependencies [8426f55]
+- Updated dependencies [db46ce5]
+- Updated dependencies [b053413]
+  - @ai-sdk/react@1.0.0
+  - @ai-sdk/ui-utils@1.0.0
+  - @ai-sdk/provider-utils@2.0.0
+  - @ai-sdk/provider@1.0.0
+
+## 4.0.0-canary.13
+
+### Major Changes
+
+- 064257d: chore (ai/core): rename simulateReadableStream values parameter to chunks
+
+### Patch Changes
+
+- Updated dependencies [79c6dd9]
+- Updated dependencies [04d3747]
+  - @ai-sdk/react@1.0.0-canary.9
+  - @ai-sdk/ui-utils@1.0.0-canary.9
+
+## 4.0.0-canary.12
+
+### Patch Changes
+
+- b053413: chore (ui): refactorings & README update
+- Updated dependencies [b053413]
+  - @ai-sdk/ui-utils@1.0.0-canary.8
+  - @ai-sdk/react@1.0.0-canary.8
+
+## 4.0.0-canary.11
+
+### Major Changes
+
+- f68d7b1: chore (ai/core): streamObject returns result immediately (no Promise)
+- f967199: chore (ai/core): streamText returns result immediately (no Promise)
+
+## 4.0.0-canary.10
+
+### Major Changes
+
+- effbce3: chore (ai): remove responseMessage from streamText onFinish callback
+
+### Patch Changes
+
+- Updated dependencies [fe4f109]
+  - @ai-sdk/ui-utils@1.0.0-canary.7
+  - @ai-sdk/react@1.0.0-canary.7
+
 ## 4.0.0-canary.9
 
 ### Patch Changes

package/README.md

@@ -32,17 +32,13 @@ npm install @ai-sdk/openai
 import { generateText } from 'ai';
 import { openai } from '@ai-sdk/openai'; // Ensure OPENAI_API_KEY environment variable is set
 
-async function main() {
-  const { text } = await generateText({
-    model: openai('gpt-4-turbo'),
-    system: 'You are a friendly assistant!',
-    prompt: 'Why is the sky blue?',
-  });
-
-  console.log(text);
-}
+const { text } = await generateText({
+  model: openai('gpt-4o'),
+  system: 'You are a friendly assistant!',
+  prompt: 'Why is the sky blue?',
+});
 
-main();
+console.log(text);
 ```
 
 ### AI SDK UI
@@ -85,14 +81,14 @@ export default function Page() {
 ###### @/app/api/chat/route.ts (Next.js App Router)
 
 ```ts
-import { CoreMessage, streamText } from 'ai';
+import { streamText } from 'ai';
 import { openai } from '@ai-sdk/openai';
 
 export async function POST(req: Request) {
-  const { messages }: { messages: CoreMessage[] } = await req.json();
+  const { messages } = await req.json();
 
-  const result = await streamText({
-    model: openai('gpt-4'),
+  const result = streamText({
+    model: openai('gpt-4o'),
     system: 'You are a helpful assistant.',
     messages,
   });

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { ToolInvocation, Attachment, Schema, DeepPartial, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
-export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
+export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UseAssistantOptions, formatAssistantStreamPart, formatDataStreamPart, jsonSchema, parseAssistantStreamPart, parseDataStreamPart, processDataStream, processTextStream } from '@ai-sdk/ui-utils';
 export { ToolCall as CoreToolCall, ToolResult as CoreToolResult, generateId } from '@ai-sdk/provider-utils';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1CallOptions, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
@@ -891,7 +891,7 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
     /**
     Warnings from the model provider (e.g. unsupported settings)
        */
-    readonly warnings: CallWarning[] | undefined;
+    readonly warnings: Promise<CallWarning[] | undefined>;
     /**
     The token usage of the generated response. Resolved when the response is finished.
        */
@@ -1066,7 +1066,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): Promise<StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>>;
+}): StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>;
 /**
 Generate an array with structured, typed elements for a given prompt and element schema using a language model.
 
@@ -1133,7 +1133,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): Promise<StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>>;
+}): StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>;
 /**
 Generate JSON with any schema for a given prompt using a language model.
 
@@ -1174,7 +1174,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): Promise<StreamObjectResult<JSONValue, JSONValue, never>>;
+}): StreamObjectResult<JSONValue, JSONValue, never>;
 
 type Parameters = z.ZodTypeAny | Schema<any>;
 type inferParameters<PARAMETERS extends Parameters> = PARAMETERS extends Schema<any> ? PARAMETERS['_type'] : PARAMETERS extends z.ZodTypeAny ? z.infer<PARAMETERS> : never;
@@ -1203,6 +1203,14 @@ type CoreTool<PARAMETERS extends Parameters = any, RESULT = any> = {
   @options.abortSignal is a signal that can be used to abort the tool call.
      */
     execute?: (args: inferParameters<PARAMETERS>, options: {
+        /**
+         * 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[];
+        /**
+         * An optional abort signal that indicates that the overall operation should be aborted.
+         */
         abortSignal?: AbortSignal;
     }) => PromiseLike<RESULT>;
 } & ({
@@ -1233,10 +1241,12 @@ Helper function for inferring the execute args of a tool.
  */
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
     execute: (args: inferParameters<PARAMETERS>, options: {
+        messages: CoreMessage[];
         abortSignal?: AbortSignal;
     }) => PromiseLike<RESULT>;
 }): CoreTool<PARAMETERS, RESULT> & {
     execute: (args: inferParameters<PARAMETERS>, options: {
+        messages: CoreMessage[];
         abortSignal?: AbortSignal;
     }) => PromiseLike<RESULT>;
 };
@@ -1876,15 +1886,6 @@ The usage is the combined usage of all steps.
 Details for all steps.
        */
         readonly steps: StepResult<TOOLS>[];
-        /**
-The response messages that were generated during the call. It consists of an assistant message,
-potentially containing tool calls.
-
-When there are tool results, there is an additional tool message with the tool results that are available.
-If there are tools that do not have execute functions, they are not included in the tool results and
-need to be added separately.
-     */
-        readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
     }) => Promise<void> | void;
     /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
@@ -1898,7 +1899,7 @@ need to be added separately.
         generateId?: () => string;
         currentDate?: () => Date;
     };
-}): Promise<StreamTextResult<TOOLS>>;
+}): StreamTextResult<TOOLS>;
 
 /**
  * Experimental middleware for LanguageModelV1.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ToolInvocation, Attachment, Schema, DeepPartial, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
-export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
+export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UseAssistantOptions, formatAssistantStreamPart, formatDataStreamPart, jsonSchema, parseAssistantStreamPart, parseDataStreamPart, processDataStream, processTextStream } from '@ai-sdk/ui-utils';
 export { ToolCall as CoreToolCall, ToolResult as CoreToolResult, generateId } from '@ai-sdk/provider-utils';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1CallOptions, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
@@ -891,7 +891,7 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
     /**
     Warnings from the model provider (e.g. unsupported settings)
        */
-    readonly warnings: CallWarning[] | undefined;
+    readonly warnings: Promise<CallWarning[] | undefined>;
     /**
     The token usage of the generated response. Resolved when the response is finished.
        */
@@ -1066,7 +1066,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): Promise<StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>>;
+}): StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>;
 /**
 Generate an array with structured, typed elements for a given prompt and element schema using a language model.
 
@@ -1133,7 +1133,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): Promise<StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>>;
+}): StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>;
 /**
 Generate JSON with any schema for a given prompt using a language model.
 
@@ -1174,7 +1174,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): Promise<StreamObjectResult<JSONValue, JSONValue, never>>;
+}): StreamObjectResult<JSONValue, JSONValue, never>;
 
 type Parameters = z.ZodTypeAny | Schema<any>;
 type inferParameters<PARAMETERS extends Parameters> = PARAMETERS extends Schema<any> ? PARAMETERS['_type'] : PARAMETERS extends z.ZodTypeAny ? z.infer<PARAMETERS> : never;
@@ -1203,6 +1203,14 @@ type CoreTool<PARAMETERS extends Parameters = any, RESULT = any> = {
   @options.abortSignal is a signal that can be used to abort the tool call.
      */
     execute?: (args: inferParameters<PARAMETERS>, options: {
+        /**
+         * 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[];
+        /**
+         * An optional abort signal that indicates that the overall operation should be aborted.
+         */
         abortSignal?: AbortSignal;
     }) => PromiseLike<RESULT>;
 } & ({
@@ -1233,10 +1241,12 @@ Helper function for inferring the execute args of a tool.
  */
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
     execute: (args: inferParameters<PARAMETERS>, options: {
+        messages: CoreMessage[];
         abortSignal?: AbortSignal;
     }) => PromiseLike<RESULT>;
 }): CoreTool<PARAMETERS, RESULT> & {
     execute: (args: inferParameters<PARAMETERS>, options: {
+        messages: CoreMessage[];
         abortSignal?: AbortSignal;
     }) => PromiseLike<RESULT>;
 };
@@ -1876,15 +1886,6 @@ The usage is the combined usage of all steps.
 Details for all steps.
        */
         readonly steps: StepResult<TOOLS>[];
-        /**
-The response messages that were generated during the call. It consists of an assistant message,
-potentially containing tool calls.
-
-When there are tool results, there is an additional tool message with the tool results that are available.
-If there are tools that do not have execute functions, they are not included in the tool results and
-need to be added separately.
-     */
-        readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
     }) => Promise<void> | void;
     /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
@@ -1898,7 +1899,7 @@ need to be added separately.
         generateId?: () => string;
         currentDate?: () => Date;
     };
-}): Promise<StreamTextResult<TOOLS>>;
+}): StreamTextResult<TOOLS>;
 
 /**
  * Experimental middleware for LanguageModelV1.