ai 3.1.22 → 3.1.24

package/dist/index.d.mts

@@ -168,9 +168,21 @@ declare class EmbedManyResult<VALUE> {
     });
 }
 
+/**
+Represents the number of tokens used in a prompt and completion.
+ */
 type TokenUsage = {
+    /**
+  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;
 };
 
@@ -595,7 +607,7 @@ Default and recommended: 'auto' (best mode for the model).
      */
     mode?: 'auto' | 'json' | 'tool' | 'grammar';
 }): Promise<StreamObjectResult<T>>;
-type ObjectStreamPartInput = {
+type ObjectStreamInputPart = {
     type: 'error';
     error: unknown;
 } | {
@@ -608,7 +620,7 @@ type ObjectStreamPartInput = {
         totalTokens: number;
     };
 };
-type ObjectStreamPart<T> = ObjectStreamPartInput | {
+type ObjectStreamPart<T> = ObjectStreamInputPart | {
     type: 'object';
     object: DeepPartial<T>;
 };
@@ -616,12 +628,16 @@ type ObjectStreamPart<T> = ObjectStreamPartInput | {
 The result of a `streamObject` call that contains the partial object stream and additional information.
  */
 declare class StreamObjectResult<T> {
-    private readonly originalStream;
+    readonly originalStream: ReadableStream<ObjectStreamPart<T>>;
     /**
   Warnings from the model provider (e.g. unsupported settings)
      */
     readonly warnings: CallWarning[] | undefined;
     /**
+  The token usage of the generated response. Resolved when the response is finished.
+     */
+    readonly usage: Promise<TokenUsage>;
+    /**
   Optional raw response data.
      */
     rawResponse?: {
@@ -631,7 +647,7 @@ declare class StreamObjectResult<T> {
         headers?: Record<string, string>;
     };
     constructor({ stream, warnings, rawResponse, }: {
-        stream: ReadableStream<string | ObjectStreamPartInput>;
+        stream: ReadableStream<string | ObjectStreamInputPart>;
         warnings: CallWarning[] | undefined;
         rawResponse?: {
             headers?: Record<string, string>;
@@ -841,12 +857,12 @@ If set and supported by the model, calls will generate deterministic results.
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
 
-@param maxAutomaticRoundtrips - Maximal number of automatic roundtrips for tool calls.
+@param maxToolRoundtrips - Maximal number of automatic roundtrips for tool calls.
 
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -860,6 +876,10 @@ The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     /**
+@deprecated Use `maxToolRoundtrips` instead.
+     */
+    maxAutomaticRoundtrips?: number;
+    /**
 Maximal number of automatic roundtrips for tool calls.
 
 An automatic tool call roundtrip is another LLM call with the
@@ -871,7 +891,7 @@ case of misconfigured tools.
 
 By default, it's set to 0, which will disable the feature.
      */
-    maxAutomaticRoundtrips?: number;
+    maxToolRoundtrips?: number;
 }): Promise<GenerateTextResult<TOOLS>>;
 /**
 The result of a `generateText` call.
@@ -1366,15 +1386,39 @@ type FunctionCallHandler = (chatMessages: Message$1[], functionCall: FunctionCal
  */
 type ToolCallHandler = (chatMessages: Message$1[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
+    /**
+  An optional object of headers to be passed to the API endpoint.
+   */
     headers?: Record<string, string> | Headers;
+    /**
+  An optional object to be passed to the API endpoint.
+     */
     body?: object;
 };
 type ChatRequestOptions = {
+    /**
+  The options to be passed to the fetch call.
+     */
     options?: RequestOptions;
+    /**
+  @deprecated
+  */
     functions?: Array<Function>;
+    /**
+  @deprecated
+  */
     function_call?: FunctionCall$1;
+    /**
+  @deprecated
+  */
     tools?: Array<Tool>;
+    /**
+  @deprecated
+  */
     tool_choice?: ToolChoice;
+    /**
+  Additional data to be sent to the server.
+     */
     data?: Record<string, string>;
 };
 type UseChatOptions = {
@@ -2417,4 +2461,4 @@ declare class StreamingTextResponse extends Response {
     constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);
 }
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, AssistantStatus, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseAssistantOptions, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, AssistantStatus, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseAssistantOptions, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.d.ts

@@ -168,9 +168,21 @@ declare class EmbedManyResult<VALUE> {
     });
 }
 
+/**
+Represents the number of tokens used in a prompt and completion.
+ */
 type TokenUsage = {
+    /**
+  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;
 };
 
@@ -595,7 +607,7 @@ Default and recommended: 'auto' (best mode for the model).
      */
     mode?: 'auto' | 'json' | 'tool' | 'grammar';
 }): Promise<StreamObjectResult<T>>;
-type ObjectStreamPartInput = {
+type ObjectStreamInputPart = {
     type: 'error';
     error: unknown;
 } | {
@@ -608,7 +620,7 @@ type ObjectStreamPartInput = {
         totalTokens: number;
     };
 };
-type ObjectStreamPart<T> = ObjectStreamPartInput | {
+type ObjectStreamPart<T> = ObjectStreamInputPart | {
     type: 'object';
     object: DeepPartial<T>;
 };
@@ -616,12 +628,16 @@ type ObjectStreamPart<T> = ObjectStreamPartInput | {
 The result of a `streamObject` call that contains the partial object stream and additional information.
  */
 declare class StreamObjectResult<T> {
-    private readonly originalStream;
+    readonly originalStream: ReadableStream<ObjectStreamPart<T>>;
     /**
   Warnings from the model provider (e.g. unsupported settings)
      */
     readonly warnings: CallWarning[] | undefined;
     /**
+  The token usage of the generated response. Resolved when the response is finished.
+     */
+    readonly usage: Promise<TokenUsage>;
+    /**
   Optional raw response data.
      */
     rawResponse?: {
@@ -631,7 +647,7 @@ declare class StreamObjectResult<T> {
         headers?: Record<string, string>;
     };
     constructor({ stream, warnings, rawResponse, }: {
-        stream: ReadableStream<string | ObjectStreamPartInput>;
+        stream: ReadableStream<string | ObjectStreamInputPart>;
         warnings: CallWarning[] | undefined;
         rawResponse?: {
             headers?: Record<string, string>;
@@ -841,12 +857,12 @@ If set and supported by the model, calls will generate deterministic results.
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
 
-@param maxAutomaticRoundtrips - Maximal number of automatic roundtrips for tool calls.
+@param maxToolRoundtrips - Maximal number of automatic roundtrips for tool calls.
 
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -860,6 +876,10 @@ The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     /**
+@deprecated Use `maxToolRoundtrips` instead.
+     */
+    maxAutomaticRoundtrips?: number;
+    /**
 Maximal number of automatic roundtrips for tool calls.
 
 An automatic tool call roundtrip is another LLM call with the
@@ -871,7 +891,7 @@ case of misconfigured tools.
 
 By default, it's set to 0, which will disable the feature.
      */
-    maxAutomaticRoundtrips?: number;
+    maxToolRoundtrips?: number;
 }): Promise<GenerateTextResult<TOOLS>>;
 /**
 The result of a `generateText` call.
@@ -1366,15 +1386,39 @@ type FunctionCallHandler = (chatMessages: Message$1[], functionCall: FunctionCal
  */
 type ToolCallHandler = (chatMessages: Message$1[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
+    /**
+  An optional object of headers to be passed to the API endpoint.
+   */
     headers?: Record<string, string> | Headers;
+    /**
+  An optional object to be passed to the API endpoint.
+     */
     body?: object;
 };
 type ChatRequestOptions = {
+    /**
+  The options to be passed to the fetch call.
+     */
     options?: RequestOptions;
+    /**
+  @deprecated
+  */
     functions?: Array<Function>;
+    /**
+  @deprecated
+  */
     function_call?: FunctionCall$1;
+    /**
+  @deprecated
+  */
     tools?: Array<Tool>;
+    /**
+  @deprecated
+  */
     tool_choice?: ToolChoice;
+    /**
+  Additional data to be sent to the server.
+     */
     data?: Record<string, string>;
 };
 type UseChatOptions = {
@@ -2417,4 +2461,4 @@ declare class StreamingTextResponse extends Response {
     constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);
 }
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, AssistantStatus, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseAssistantOptions, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, AssistantStatus, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseAssistantOptions, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.js

@@ -1212,57 +1212,72 @@ var StreamObjectResult = class {
     warnings,
     rawResponse
   }) {
-    this.originalStream = stream;
     this.warnings = warnings;
     this.rawResponse = rawResponse;
-  }
-  get partialObjectStream() {
-    let accumulatedText = "";
-    let latestObject = void 0;
-    return createAsyncIterableStream(this.originalStream, {
-      transform(chunk, controller) {
-        if (typeof chunk === "string") {
-          accumulatedText += chunk;
-          const currentObject = parsePartialJson(
-            accumulatedText
-          );
-          if (!isDeepEqualData(latestObject, currentObject)) {
-            latestObject = currentObject;
-            controller.enqueue(currentObject);
-          }
-        } else if (chunk.type === "error") {
-          throw chunk.error;
-        }
-      }
+    let resolveUsage;
+    this.usage = new Promise((resolve) => {
+      resolveUsage = resolve;
     });
-  }
-  get fullStream() {
+    let usage;
     let accumulatedText = "";
     let latestObject = void 0;
-    return createAsyncIterableStream(this.originalStream, {
-      transform(chunk, controller) {
-        if (typeof chunk === "string") {
-          accumulatedText += chunk;
-          const currentObject = parsePartialJson(
-            accumulatedText
-          );
-          if (!isDeepEqualData(latestObject, currentObject)) {
-            latestObject = currentObject;
-            controller.enqueue({ type: "object", object: currentObject });
+    this.originalStream = stream.pipeThrough(
+      new TransformStream({
+        async transform(chunk, controller) {
+          if (typeof chunk === "string") {
+            accumulatedText += chunk;
+            const currentObject = parsePartialJson(
+              accumulatedText
+            );
+            if (!isDeepEqualData(latestObject, currentObject)) {
+              latestObject = currentObject;
+              controller.enqueue({ type: "object", object: currentObject });
+            }
+            return;
           }
-        } else {
           switch (chunk.type) {
-            case "finish":
+            case "finish": {
+              usage = calculateTokenUsage(chunk.usage);
               controller.enqueue({
                 ...chunk,
-                usage: calculateTokenUsage(chunk.usage)
+                usage
               });
+              resolveUsage(usage);
               break;
-            default:
+            }
+            default: {
               controller.enqueue(chunk);
               break;
+            }
           }
         }
+      })
+    );
+  }
+  get partialObjectStream() {
+    return createAsyncIterableStream(this.originalStream, {
+      transform(chunk, controller) {
+        switch (chunk.type) {
+          case "object":
+            controller.enqueue(chunk.object);
+            break;
+          case "finish":
+            break;
+          case "error":
+            controller.error(chunk.error);
+            break;
+          default: {
+            const _exhaustiveCheck = chunk;
+            throw new Error(`Unsupported chunk type: ${_exhaustiveCheck}`);
+          }
+        }
+      }
+    });
+  }
+  get fullStream() {
+    return createAsyncIterableStream(this.originalStream, {
+      transform(chunk, controller) {
+        controller.enqueue(chunk);
       }
     });
   }
@@ -1344,6 +1359,7 @@ async function generateText({
   maxRetries,
   abortSignal,
   maxAutomaticRoundtrips = 0,
+  maxToolRoundtrips = maxAutomaticRoundtrips,
   ...settings
 }) {
   var _a, _b, _c;
@@ -1388,7 +1404,7 @@ async function generateText({
     // there are tool calls:
     currentToolCalls.length > 0 && // all current tool calls have results:
     currentToolResults.length === currentToolCalls.length && // the number of roundtrips is less than the maximum:
-    roundtrips++ < maxAutomaticRoundtrips
+    roundtrips++ < maxToolRoundtrips
   );
   return new GenerateTextResult({
     // Always return a string so that the caller doesn't have to check for undefined.