ai 4.0.0-canary.11 → 4.0.0-canary.12

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # ai
 
+## 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

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 = streamText({
-    model: openai('gpt-4'),
+    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';

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';

package/dist/index.js

@@ -53,14 +53,16 @@ __export(streams_exports, {
   experimental_createProviderRegistry: () => experimental_createProviderRegistry,
   experimental_customProvider: () => experimental_customProvider,
   experimental_wrapLanguageModel: () => experimental_wrapLanguageModel,
-  formatStreamPart: () => import_ui_utils10.formatStreamPart,
+  formatAssistantStreamPart: () => import_ui_utils10.formatAssistantStreamPart,
+  formatDataStreamPart: () => import_ui_utils10.formatDataStreamPart,
   generateId: () => import_provider_utils11.generateId,
   generateObject: () => generateObject,
   generateText: () => generateText,
   jsonSchema: () => import_ui_utils7.jsonSchema,
-  parseStreamPart: () => import_ui_utils10.parseStreamPart,
-  processDataProtocolResponse: () => import_ui_utils10.processDataProtocolResponse,
-  readDataStream: () => import_ui_utils10.readDataStream,
+  parseAssistantStreamPart: () => import_ui_utils10.parseAssistantStreamPart,
+  parseDataStreamPart: () => import_ui_utils10.parseDataStreamPart,
+  processDataStream: () => import_ui_utils10.processDataStream,
+  processTextStream: () => import_ui_utils10.processTextStream,
   streamObject: () => streamObject,
   streamText: () => streamText,
   tool: () => tool
@@ -3920,13 +3922,6 @@ function streamText({
   } = {},
   ...settings
 }) {
-  if (maxSteps < 1) {
-    throw new InvalidArgumentError({
-      parameter: "maxSteps",
-      value: maxSteps,
-      message: "maxSteps must be at least 1"
-    });
-  }
   return new DefaultStreamTextResult({
     model,
     telemetry,
@@ -3988,6 +3983,13 @@ var DefaultStreamTextResult = class {
     this.responsePromise = new DelayedPromise();
     this.stepsPromise = new DelayedPromise();
     this.stitchableStream = createStitchableStream();
+    if (maxSteps < 1) {
+      throw new InvalidArgumentError({
+        parameter: "maxSteps",
+        value: maxSteps,
+        message: "maxSteps must be at least 1"
+      });
+    }
     const tracer = getTracer(telemetry);
     const baseTelemetryAttributes = getBaseTelemetryAttributes({
       model,
@@ -4000,7 +4002,6 @@ var DefaultStreamTextResult = class {
       tools
     });
     const self = this;
-    const stepResults = [];
     recordSpan({
       name: "ai.streamText",
       attributes: selectTelemetryAttributes({
@@ -4019,9 +4020,15 @@ var DefaultStreamTextResult = class {
       endWhenDone: false,
       fn: async (rootSpan) => {
         const retry = retryWithExponentialBackoff({ maxRetries });
-        const startStep = async ({
-          responseMessages
-        }) => {
+        const stepResults = [];
+        async function streamStep({
+          currentStep,
+          responseMessages,
+          usage,
+          stepType,
+          previousStepText,
+          hasLeadingWhitespace
+        }) {
           const promptFormat = responseMessages.length === 0 ? initialPrompt.type : "messages";
           const promptMessages = await convertToLanguageModelPrompt({
             prompt: {
@@ -4037,9 +4044,9 @@ var DefaultStreamTextResult = class {
             ...prepareToolsAndToolChoice({ tools, toolChoice, activeTools })
           };
           const {
-            result: { stream: stream2, warnings: warnings2, rawResponse: rawResponse2, request: request2 },
-            doStreamSpan: doStreamSpan2,
-            startTimestampMs: startTimestampMs2
+            result: { stream, warnings, rawResponse, request },
+            doStreamSpan,
+            startTimestampMs
           } = await retry(
             () => recordSpan({
               name: "ai.streamText.doStream",
@@ -4081,10 +4088,10 @@ var DefaultStreamTextResult = class {
               }),
               tracer,
               endWhenDone: false,
-              fn: async (doStreamSpan3) => ({
+              fn: async (doStreamSpan2) => ({
                 startTimestampMs: now2(),
                 // get before the call
-                doStreamSpan: doStreamSpan3,
+                doStreamSpan: doStreamSpan2,
                 result: await model.doStream({
                   mode,
                   ...prepareCallSettings(settings),
@@ -4097,47 +4104,15 @@ var DefaultStreamTextResult = class {
               })
             })
           );
-          return {
-            result: {
-              stream: runToolsTransformation({
-                tools,
-                generatorStream: stream2,
-                toolCallStreaming,
-                tracer,
-                telemetry,
-                abortSignal
-              }),
-              warnings: warnings2,
-              request: request2 != null ? request2 : {},
-              rawResponse: rawResponse2
-            },
-            doStreamSpan: doStreamSpan2,
-            startTimestampMs: startTimestampMs2
-          };
-        };
-        const {
-          result: { stream, warnings, rawResponse, request },
-          doStreamSpan,
-          startTimestampMs
-        } = await startStep({ responseMessages: [] });
-        function addStepStream({
-          stream: stream2,
-          startTimestamp,
-          doStreamSpan: doStreamSpan2,
-          currentStep,
-          responseMessages,
-          usage = {
-            promptTokens: 0,
-            completionTokens: 0,
-            totalTokens: 0
-          },
-          stepType,
-          previousStepText = "",
-          stepRequest,
-          hasLeadingWhitespace,
-          warnings: warnings2,
-          response
-        }) {
+          const transformedStream = runToolsTransformation({
+            tools,
+            generatorStream: stream,
+            toolCallStreaming,
+            tracer,
+            telemetry,
+            abortSignal
+          });
+          const stepRequest = request != null ? request : {};
           const stepToolCalls = [];
           const stepToolResults = [];
           let stepFinishReason = "unknown";
@@ -4172,17 +4147,17 @@ var DefaultStreamTextResult = class {
             await (onChunk == null ? void 0 : onChunk({ chunk }));
           }
           self.stitchableStream.addStream(
-            stream2.pipeThrough(
+            transformedStream.pipeThrough(
               new TransformStream({
                 async transform(chunk, controller) {
                   var _a11, _b, _c;
                   if (stepFirstChunk) {
-                    const msToFirstChunk = now2() - startTimestamp;
+                    const msToFirstChunk = now2() - startTimestampMs;
                     stepFirstChunk = false;
-                    doStreamSpan2.addEvent("ai.stream.firstChunk", {
+                    doStreamSpan.addEvent("ai.stream.firstChunk", {
                       "ai.response.msToFirstChunk": msToFirstChunk
                     });
-                    doStreamSpan2.setAttributes({
+                    doStreamSpan.setAttributes({
                       "ai.response.msToFirstChunk": msToFirstChunk
                     });
                   }
@@ -4240,9 +4215,9 @@ var DefaultStreamTextResult = class {
                       stepFinishReason = chunk.finishReason;
                       stepProviderMetadata = chunk.experimental_providerMetadata;
                       stepLogProbs = chunk.logprobs;
-                      const msToFinish = now2() - startTimestamp;
-                      doStreamSpan2.addEvent("ai.stream.finish");
-                      doStreamSpan2.setAttributes({
+                      const msToFinish = now2() - startTimestampMs;
+                      doStreamSpan.addEvent("ai.stream.finish");
+                      doStreamSpan.setAttributes({
                         "ai.response.msToFinish": msToFinish,
                         "ai.response.avgCompletionTokensPerSecond": 1e3 * stepUsage.completionTokens / msToFinish
                       });
@@ -4293,7 +4268,7 @@ var DefaultStreamTextResult = class {
                     chunkBuffer = "";
                   }
                   try {
-                    doStreamSpan2.setAttributes(
+                    doStreamSpan.setAttributes(
                       selectTelemetryAttributes({
                         telemetry,
                         attributes: {
@@ -4318,7 +4293,7 @@ var DefaultStreamTextResult = class {
                     );
                   } catch (error) {
                   } finally {
-                    doStreamSpan2.end();
+                    doStreamSpan.end();
                   }
                   controller.enqueue({
                     type: "step-finish",
@@ -4358,12 +4333,12 @@ var DefaultStreamTextResult = class {
                     toolResults: stepToolResults,
                     finishReason: stepFinishReason,
                     usage: stepUsage,
-                    warnings: warnings2,
+                    warnings,
                     logprobs: stepLogProbs,
                     request: stepRequest,
                     response: {
                       ...stepResponse,
-                      headers: response == null ? void 0 : response.headers,
+                      headers: rawResponse == null ? void 0 : rawResponse.headers,
                       // deep clone msgs to avoid mutating past messages in multi-step:
                       messages: JSON.parse(JSON.stringify(responseMessages))
                     },
@@ -4378,26 +4353,13 @@ var DefaultStreamTextResult = class {
                     totalTokens: usage.totalTokens + stepUsage.totalTokens
                   };
                   if (nextStepType !== "done") {
-                    const {
-                      result,
-                      doStreamSpan: doStreamSpan3,
-                      startTimestampMs: startTimestamp2
-                    } = await startStep({ responseMessages });
-                    warnings2 = result.warnings;
-                    response = result.rawResponse;
-                    addStepStream({
-                      stream: result.stream,
-                      startTimestamp: startTimestamp2,
-                      doStreamSpan: doStreamSpan3,
+                    await streamStep({
                       currentStep: currentStep + 1,
                       responseMessages,
                       usage: combinedUsage,
                       stepType: nextStepType,
                       previousStepText: fullStepText,
-                      stepRequest: result.request,
-                      hasLeadingWhitespace: hasWhitespaceSuffix,
-                      warnings: warnings2,
-                      response
+                      hasLeadingWhitespace: hasWhitespaceSuffix
                     });
                     return;
                   }
@@ -4440,7 +4402,7 @@ var DefaultStreamTextResult = class {
                       messages: responseMessages
                     });
                     self.stepsPromise.resolve(stepResults);
-                    self.warningsPromise.resolve(warnings2 != null ? warnings2 : []);
+                    self.warningsPromise.resolve(warnings != null ? warnings : []);
                     await (onFinish == null ? void 0 : onFinish({
                       finishReason: stepFinishReason,
                       logprobs: stepLogProbs,
@@ -4458,7 +4420,7 @@ var DefaultStreamTextResult = class {
                         headers: rawResponse == null ? void 0 : rawResponse.headers,
                         messages: responseMessages
                       },
-                      warnings: warnings2,
+                      warnings,
                       experimental_providerMetadata: stepProviderMetadata,
                       steps: stepResults
                     }));
@@ -4472,18 +4434,17 @@ var DefaultStreamTextResult = class {
             )
           );
         }
-        addStepStream({
-          stream,
-          startTimestamp: startTimestampMs,
-          doStreamSpan,
+        await streamStep({
           currentStep: 0,
           responseMessages: [],
-          usage: void 0,
+          usage: {
+            promptTokens: 0,
+            completionTokens: 0,
+            totalTokens: 0
+          },
+          previousStepText: "",
           stepType: "initial",
-          stepRequest: request,
-          hasLeadingWhitespace: false,
-          warnings,
-          response: rawResponse
+          hasLeadingWhitespace: false
         });
       }
     }).catch((error) => {
@@ -4577,12 +4538,12 @@ var DefaultStreamTextResult = class {
         const chunkType = chunk.type;
         switch (chunkType) {
           case "text-delta": {
-            controller.enqueue((0, import_ui_utils6.formatStreamPart)("text", chunk.textDelta));
+            controller.enqueue((0, import_ui_utils6.formatDataStreamPart)("text", chunk.textDelta));
             break;
           }
           case "tool-call-streaming-start": {
             controller.enqueue(
-              (0, import_ui_utils6.formatStreamPart)("tool_call_streaming_start", {
+              (0, import_ui_utils6.formatDataStreamPart)("tool_call_streaming_start", {
                 toolCallId: chunk.toolCallId,
                 toolName: chunk.toolName
               })
@@ -4591,7 +4552,7 @@ var DefaultStreamTextResult = class {
           }
           case "tool-call-delta": {
             controller.enqueue(
-              (0, import_ui_utils6.formatStreamPart)("tool_call_delta", {
+              (0, import_ui_utils6.formatDataStreamPart)("tool_call_delta", {
                 toolCallId: chunk.toolCallId,
                 argsTextDelta: chunk.argsTextDelta
               })
@@ -4600,7 +4561,7 @@ var DefaultStreamTextResult = class {
           }
           case "tool-call": {
             controller.enqueue(
-              (0, import_ui_utils6.formatStreamPart)("tool_call", {
+              (0, import_ui_utils6.formatDataStreamPart)("tool_call", {
                 toolCallId: chunk.toolCallId,
                 toolName: chunk.toolName,
                 args: chunk.args
@@ -4610,7 +4571,7 @@ var DefaultStreamTextResult = class {
           }
           case "tool-result": {
             controller.enqueue(
-              (0, import_ui_utils6.formatStreamPart)("tool_result", {
+              (0, import_ui_utils6.formatDataStreamPart)("tool_result", {
                 toolCallId: chunk.toolCallId,
                 result: chunk.result
               })
@@ -4619,13 +4580,13 @@ var DefaultStreamTextResult = class {
           }
           case "error": {
             controller.enqueue(
-              (0, import_ui_utils6.formatStreamPart)("error", getErrorMessage3(chunk.error))
+              (0, import_ui_utils6.formatDataStreamPart)("error", getErrorMessage3(chunk.error))
             );
             break;
           }
           case "step-finish": {
             controller.enqueue(
-              (0, import_ui_utils6.formatStreamPart)("finish_step", {
+              (0, import_ui_utils6.formatDataStreamPart)("finish_step", {
                 finishReason: chunk.finishReason,
                 usage: sendUsage ? {
                   promptTokens: chunk.usage.promptTokens,
@@ -4638,7 +4599,7 @@ var DefaultStreamTextResult = class {
           }
           case "finish": {
             controller.enqueue(
-              (0, import_ui_utils6.formatStreamPart)("finish_message", {
+              (0, import_ui_utils6.formatDataStreamPart)("finish_message", {
                 finishReason: chunk.finishReason,
                 usage: sendUsage ? {
                   promptTokens: chunk.usage.promptTokens,
@@ -4915,17 +4876,21 @@ function AssistantResponse({ threadId, messageId }, process2) {
       const textEncoder = new TextEncoder();
       const sendMessage = (message) => {
         controller.enqueue(
-          textEncoder.encode((0, import_ui_utils8.formatStreamPart)("assistant_message", message))
+          textEncoder.encode(
+            (0, import_ui_utils8.formatAssistantStreamPart)("assistant_message", message)
+          )
         );
       };
       const sendDataMessage = (message) => {
         controller.enqueue(
-          textEncoder.encode((0, import_ui_utils8.formatStreamPart)("data_message", message))
+          textEncoder.encode(
+            (0, import_ui_utils8.formatAssistantStreamPart)("data_message", message)
+          )
         );
       };
       const sendError = (errorMessage) => {
         controller.enqueue(
-          textEncoder.encode((0, import_ui_utils8.formatStreamPart)("error", errorMessage))
+          textEncoder.encode((0, import_ui_utils8.formatAssistantStreamPart)("error", errorMessage))
         );
       };
       const forwardStream = async (stream2) => {
@@ -4936,7 +4901,7 @@ function AssistantResponse({ threadId, messageId }, process2) {
             case "thread.message.created": {
               controller.enqueue(
                 textEncoder.encode(
-                  (0, import_ui_utils8.formatStreamPart)("assistant_message", {
+                  (0, import_ui_utils8.formatAssistantStreamPart)("assistant_message", {
                     id: value.data.id,
                     role: "assistant",
                     content: [{ type: "text", text: { value: "" } }]
@@ -4950,7 +4915,7 @@ function AssistantResponse({ threadId, messageId }, process2) {
               if ((content == null ? void 0 : content.type) === "text" && ((_b = content.text) == null ? void 0 : _b.value) != null) {
                 controller.enqueue(
                   textEncoder.encode(
-                    (0, import_ui_utils8.formatStreamPart)("text", content.text.value)
+                    (0, import_ui_utils8.formatAssistantStreamPart)("text", content.text.value)
                   )
                 );
               }
@@ -4967,7 +4932,7 @@ function AssistantResponse({ threadId, messageId }, process2) {
       };
       controller.enqueue(
         textEncoder.encode(
-          (0, import_ui_utils8.formatStreamPart)("assistant_control_data", {
+          (0, import_ui_utils8.formatAssistantStreamPart)("assistant_control_data", {
             threadId,
             messageId
           })
@@ -5084,7 +5049,7 @@ var StreamData = class {
       throw new Error("Stream controller is not initialized.");
     }
     this.controller.enqueue(
-      this.encoder.encode((0, import_ui_utils9.formatStreamPart)("data", [value]))
+      this.encoder.encode((0, import_ui_utils9.formatDataStreamPart)("data", [value]))
     );
   }
   appendMessageAnnotation(value) {
@@ -5095,7 +5060,7 @@ var StreamData = class {
       throw new Error("Stream controller is not initialized.");
     }
     this.controller.enqueue(
-      this.encoder.encode((0, import_ui_utils9.formatStreamPart)("message_annotations", [value]))
+      this.encoder.encode((0, import_ui_utils9.formatDataStreamPart)("message_annotations", [value]))
     );
   }
 };
@@ -5105,7 +5070,7 @@ function createStreamDataTransformer() {
   return new TransformStream({
     transform: async (chunk, controller) => {
       const message = decoder.decode(chunk);
-      controller.enqueue(encoder.encode((0, import_ui_utils9.formatStreamPart)("text", message)));
+      controller.enqueue(encoder.encode((0, import_ui_utils9.formatDataStreamPart)("text", message)));
     }
   });
 }
@@ -5239,14 +5204,16 @@ function trimStartOfStream() {
   experimental_createProviderRegistry,
   experimental_customProvider,
   experimental_wrapLanguageModel,
-  formatStreamPart,
+  formatAssistantStreamPart,
+  formatDataStreamPart,
   generateId,
   generateObject,
   generateText,
   jsonSchema,
-  parseStreamPart,
-  processDataProtocolResponse,
-  readDataStream,
+  parseAssistantStreamPart,
+  parseDataStreamPart,
+  processDataStream,
+  processTextStream,
   streamObject,
   streamText,
   tool