ai 3.3.26 → 3.3.27

package/dist/index.d.ts

@@ -44,7 +44,7 @@ type TelemetrySettings = {
 /**
 Represents the number of tokens used in a prompt and completion.
  */
-type CompletionTokenUsage$1 = {
+type LanguageModelUsage$1 = {
     /**
   The number of tokens used in the prompt.
      */
@@ -61,7 +61,7 @@ type CompletionTokenUsage$1 = {
 /**
 Represents the number of tokens used in an embedding.
  */
-type EmbeddingTokenUsage = {
+type EmbeddingModelUsage$1 = {
     /**
   The number of tokens used in the embedding.
      */
@@ -95,6 +95,8 @@ Can be one of the following:
 type FinishReason = LanguageModelV1FinishReason;
 /**
 Log probabilities for each token and its top log probabilities.
+
+@deprecated Will become a provider extension in the future.
  */
 type LogProbs = LanguageModelV1LogProbs;
 /**
@@ -114,6 +116,23 @@ type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | '
     type: 'tool';
     toolName: keyof TOOLS;
 };
+type LanguageModelResponseMetadata = {
+    /**
+  ID for the generated response.
+       */
+    id: string;
+    /**
+  Timestamp for the start of the generated response.
+  */
+    timestamp: Date;
+    /**
+  The ID of the response model that was used to generate the response.
+  */
+    modelId: string;
+};
+type LanguageModelResponseMetadataWithHeaders = LanguageModelResponseMetadata & {
+    headers?: Record<string, string>;
+};
 
 /**
  * Provider for language and text embedding models.
@@ -151,10 +170,19 @@ functionality that can be fully encapsulated in the provider.
 type ProviderMetadata = LanguageModelV1ProviderMetadata;
 
 /**
- * @deprecated Use CompletionTokenUsage instead.
+ * @deprecated Use LanguageModelUsage instead.
+ */
+type TokenUsage = LanguageModelUsage$1;
+/**
+ * @deprecated Use LanguageModelUsage instead.
  */
-type TokenUsage = CompletionTokenUsage$1;
-type CompletionTokenUsage = CompletionTokenUsage$1;
+type CompletionTokenUsage = LanguageModelUsage$1;
+type LanguageModelUsage = LanguageModelUsage$1;
+/**
+ * @deprecated Use EmbeddingModelUsage instead.
+ */
+type EmbeddingTokenUsage = EmbeddingModelUsage$1;
+type EmbeddingModelUsage = EmbeddingModelUsage$1;
 
 /**
 The result of a `embed` call.
@@ -172,7 +200,7 @@ interface EmbedResult<VALUE> {
     /**
     The embedding token usage.
       */
-    readonly usage: EmbeddingTokenUsage;
+    readonly usage: EmbeddingModelUsage$1;
     /**
     Optional raw response data.
        */
@@ -242,7 +270,7 @@ interface EmbedManyResult<VALUE> {
     /**
     The embedding token usage.
       */
-    readonly usage: EmbeddingTokenUsage;
+    readonly usage: EmbeddingModelUsage$1;
 }
 
 /**
@@ -430,6 +458,12 @@ interface ToolCallPart {
   Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
      */
     args: unknown;
+    /**
+  Additional provider-specific metadata. They are passed through
+  to the provider from the AI SDK and enable provider-specific
+  functionality that can be fully encapsulated in the provider.
+   */
+    experimental_providerMetadata?: ProviderMetadata;
 }
 /**
 Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
@@ -583,13 +617,15 @@ interface GenerateObjectResult<T> {
     /**
     The token usage of the generated text.
        */
-    readonly usage: CompletionTokenUsage$1;
+    readonly usage: LanguageModelUsage$1;
     /**
     Warnings from the model provider (e.g. unsupported settings)
        */
     readonly warnings: CallWarning[] | undefined;
     /**
-    Optional raw response data.
+   Optional raw response data.
+  
+  @deprecated Use `response.headers` instead.
        */
     readonly rawResponse?: {
         /**
@@ -598,8 +634,14 @@ interface GenerateObjectResult<T> {
         headers?: Record<string, string>;
     };
     /**
-    Logprobs for the completion.
-    `undefined` if the mode does not support logprobs or if was not enabled
+  Additional response information.
+     */
+    readonly response: LanguageModelResponseMetadataWithHeaders;
+    /**
+   Logprobs for the completion.
+  `undefined` if the mode does not support logprobs or if was not enabled.
+  
+  @deprecated Will become a provider extension in the future.
        */
     readonly logprobs: LogProbs | undefined;
     /**
@@ -663,6 +705,13 @@ Default and recommended: 'auto' (best mode for the model).
 Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        generateId?: () => string;
+        currentDate?: () => Date;
+    };
 }): Promise<GenerateObjectResult<OBJECT>>;
 /**
 Generate an array with structured, typed elements for a given prompt and element schema using a language model.
@@ -712,6 +761,13 @@ Default and recommended: 'auto' (best mode for the model).
 Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        generateId?: () => string;
+        currentDate?: () => Date;
+    };
 }): Promise<GenerateObjectResult<Array<ELEMENT>>>;
 /**
 Generate JSON with any schema for a given prompt using a language model.
@@ -735,6 +791,13 @@ The mode to use for object generation. Must be "json" for no-schema output.
 Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        generateId?: () => string;
+        currentDate?: () => Date;
+    };
 }): Promise<GenerateObjectResult<JSONValue>>;
 /**
  * @deprecated Use `generateObject` instead.
@@ -754,7 +817,7 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
     /**
     The token usage of the generated response. Resolved when the response is finished.
        */
-    readonly usage: Promise<CompletionTokenUsage$1>;
+    readonly usage: Promise<LanguageModelUsage$1>;
     /**
   Additional provider-specific metadata. They are passed through
   from the provider to the AI SDK and enable provider-specific
@@ -762,7 +825,9 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
      */
     readonly experimental_providerMetadata: Promise<ProviderMetadata | undefined>;
     /**
-    Optional raw response data.
+  Optional raw response data.
+  
+  @deprecated Use `response` instead.
        */
     readonly rawResponse?: {
         /**
@@ -771,6 +836,10 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
         headers?: Record<string, string>;
     };
     /**
+  Additional response information.
+   */
+    readonly response: Promise<LanguageModelResponseMetadataWithHeaders>;
+    /**
     The generated object (typed according to the schema). Resolved when the response is finished.
        */
     readonly object: Promise<RESULT>;
@@ -817,33 +886,29 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
        */
     toTextStreamResponse(init?: ResponseInit): Response;
 }
-type ObjectStreamInputPart = {
+type ObjectStreamPart<PARTIAL> = {
+    type: 'object';
+    object: PARTIAL;
+} | {
+    type: 'text-delta';
+    textDelta: string;
+} | {
     type: 'error';
     error: unknown;
 } | {
     type: 'finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
-    usage: {
-        promptTokens: number;
-        completionTokens: number;
-        totalTokens: number;
-    };
+    usage: LanguageModelUsage$1;
+    response: LanguageModelResponseMetadata;
     providerMetadata?: ProviderMetadata;
 };
-type ObjectStreamPart<PARTIAL> = ObjectStreamInputPart | {
-    type: 'object';
-    object: PARTIAL;
-} | {
-    type: 'text-delta';
-    textDelta: string;
-};
 
 type OnFinishCallback<RESULT> = (event: {
     /**
   The token usage of the generated response.
   */
-    usage: CompletionTokenUsage$1;
+    usage: LanguageModelUsage$1;
     /**
   The generated object. Can be undefined if the final object does not match the schema.
   */
@@ -854,14 +919,20 @@ type OnFinishCallback<RESULT> = (event: {
     error: unknown | undefined;
     /**
   Optional raw response data.
-  */
+  
+  @deprecated Use `response` instead.
+         */
     rawResponse?: {
         /**
     Response headers.
-    */
+       */
         headers?: Record<string, string>;
     };
     /**
+  Response metadata.
+   */
+    response: LanguageModelResponseMetadataWithHeaders;
+    /**
   Warnings from the model provider (e.g. unsupported settings).
   */
     warnings?: CallWarning[];
@@ -928,6 +999,8 @@ Callback that is called when the LLM response and the final object validation ar
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
+        generateId?: () => string;
+        currentDate?: () => Date;
         now?: () => number;
     };
 }): Promise<StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>>;
@@ -987,6 +1060,8 @@ Callback that is called when the LLM response and the final object validation ar
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
+        generateId?: () => string;
+        currentDate?: () => Date;
         now?: () => number;
     };
 }): Promise<StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>>;
@@ -1020,6 +1095,8 @@ Callback that is called when the LLM response and the final object validation ar
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
+        generateId?: () => string;
+        currentDate?: () => Date;
         now?: () => number;
     };
 }): Promise<StreamObjectResult<JSONValue, JSONValue, never>>;
@@ -1179,7 +1256,7 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
     /**
     The token usage of the generated text.
      */
-    readonly usage: CompletionTokenUsage$1;
+    readonly usage: LanguageModelUsage$1;
     /**
     Warnings from the model provider (e.g. unsupported settings)
      */
@@ -1216,7 +1293,7 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
         /**
       The token usage of the generated text.
       */
-        readonly usage: CompletionTokenUsage$1;
+        readonly usage: LanguageModelUsage$1;
         /**
       Warnings from the model provider (e.g. unsupported settings)
        */
@@ -1227,17 +1304,25 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
        */
         readonly logprobs: LogProbs | undefined;
         /**
-      Optional raw response data.
-         */
+    Optional raw response data.
+    
+    @deprecated Use `response.headers` instead.
+       */
         readonly rawResponse?: {
             /**
-        Response headers.
-           */
+      Response headers.
+       */
             readonly headers?: Record<string, string>;
         };
+        /**
+    Additional response information.
+     */
+        readonly response: LanguageModelResponseMetadataWithHeaders;
     }>;
     /**
-    Optional raw response data.
+  Optional raw response data.
+  
+  @deprecated Use `response.headers` instead.
      */
     readonly rawResponse?: {
         /**
@@ -1246,8 +1331,14 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
         readonly headers?: Record<string, string>;
     };
     /**
-    Logprobs for the completion.
-    `undefined` if the mode does not support logprobs or if was not enabled.
+  Additional response information.
+     */
+    readonly response: LanguageModelResponseMetadataWithHeaders;
+    /**
+  Logprobs for the completion.
+  `undefined` if the mode does not support logprobs or if was not enabled.
+  
+  @deprecated Will become a provider extension in the future.
        */
     readonly logprobs: LogProbs | undefined;
     /**
@@ -1302,7 +1393,7 @@ If set and supported by the model, calls will generate deterministic results.
 @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, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1336,7 +1427,18 @@ By default, it's set to 0, which will disable the feature.
      * Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        generateId?: () => string;
+        currentDate?: () => Date;
+    };
 }): Promise<GenerateTextResult<TOOLS>>;
+/**
+ * @deprecated Use `generateText` instead.
+ */
+declare const experimental_generateText: typeof generateText;
 
 /**
 A result object for accessing different stream types and additional information.
@@ -1352,7 +1454,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
   Resolved when the response is finished.
        */
-    readonly usage: Promise<CompletionTokenUsage$1>;
+    readonly usage: Promise<LanguageModelUsage$1>;
     /**
   The reason why the generation finished. Taken from the last roundtrip.
   
@@ -1385,6 +1487,8 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     readonly toolResults: Promise<ToToolResult<TOOLS>[]>;
     /**
   Optional raw response data.
+  
+  @deprecated Use `response` instead.
        */
     readonly rawResponse?: {
         /**
@@ -1393,6 +1497,10 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         headers?: Record<string, string>;
     };
     /**
+  Additional response information.
+   */
+    readonly response: Promise<LanguageModelResponseMetadataWithHeaders>;
+    /**
     A text stream that returns only the generated text deltas. You can use it
     as either an AsyncIterable or a ReadableStream. When an error occurs, the
     stream will throw the error.
@@ -1513,21 +1621,15 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
     type: 'roundtrip-finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
-    usage: {
-        promptTokens: number;
-        completionTokens: number;
-        totalTokens: number;
-    };
+    usage: LanguageModelUsage$1;
+    response: LanguageModelResponseMetadata;
     experimental_providerMetadata?: ProviderMetadata;
 } | {
     type: 'finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
-    usage: {
-        promptTokens: number;
-        completionTokens: number;
-        totalTokens: number;
-    };
+    usage: LanguageModelUsage$1;
+    response: LanguageModelResponseMetadata;
     experimental_providerMetadata?: ProviderMetadata;
 } | {
     type: 'error';
@@ -1580,7 +1682,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1634,7 +1736,7 @@ Callback that is called when the LLM response and all request tool executions
         /**
   The token usage of the generated response.
    */
-        usage: CompletionTokenUsage$1;
+        usage: LanguageModelUsage$1;
         /**
   The full text that has been generated.
          */
@@ -1649,6 +1751,8 @@ Callback that is called when the LLM response and all request tool executions
         toolResults?: ToToolResult<TOOLS>[];
         /**
   Optional raw response data.
+  
+  @deprecated Use `response` instead.
          */
         rawResponse?: {
             /**
@@ -1657,6 +1761,10 @@ Callback that is called when the LLM response and all request tool executions
             headers?: Record<string, string>;
         };
         /**
+  Response metadata.
+         */
+        response: LanguageModelResponseMetadataWithHeaders;
+        /**
   Warnings from the model provider (e.g. unsupported settings).
          */
         warnings?: CallWarning[];
@@ -1672,8 +1780,14 @@ Callback that is called when the LLM response and all request tool executions
      */
     _internal?: {
         now?: () => number;
+        generateId?: () => string;
+        currentDate?: () => Date;
     };
 }): Promise<StreamTextResult<TOOLS>>;
+/**
+ * @deprecated Use `streamText` instead.
+ */
+declare const experimental_streamText: typeof streamText;
 
 /**
  * Creates a custom provider with specified language models, text embedding models, and an optional fallback provider.
@@ -2781,10 +2895,10 @@ declare class StreamingTextResponse extends Response {
     constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);
 }
 
-declare const generateId: (size?: number) => string;
+declare const generateId: () => string;
 /**
 @deprecated Use `generateId` instead.
  */
-declare const nanoid: (size?: number) => string;
+declare const nanoid: () => string;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_streamObject, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LanguageModelResponseMetadata, LanguageModelResponseMetadataWithHeaders, LanguageModelUsage, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };