ai 4.0.0-canary.5 → 4.0.0-canary.7

package/dist/index.d.ts

@@ -46,33 +46,6 @@ type TelemetrySettings = {
     tracer?: Tracer;
 };
 
-/**
-Represents the number of tokens used in a prompt and completion.
- */
-type LanguageModelUsage$1 = {
-    /**
-  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;
-};
-/**
-Represents the number of tokens used in an embedding.
- */
-type EmbeddingModelUsage$1 = {
-    /**
-  The number of tokens used in the embedding.
-     */
-    tokens: number;
-};
-
 /**
 Embedding model that is used by the AI SDK Core functions.
 */
@@ -147,10 +120,6 @@ type LanguageModelResponseMetadata = {
        */
     headers?: Record<string, string>;
 };
-/**
-@deprecated Use `LanguageModelResponseMetadata` instead.
- */
-type LanguageModelResponseMetadataWithHeaders = LanguageModelResponseMetadata;
 
 /**
  * Provider for language and text embedding models.
@@ -188,19 +157,31 @@ functionality that can be fully encapsulated in the provider.
 type ProviderMetadata = LanguageModelV1ProviderMetadata;
 
 /**
- * @deprecated Use LanguageModelUsage instead.
- */
-type TokenUsage = LanguageModelUsage$1;
-/**
- * @deprecated Use LanguageModelUsage instead.
+Represents the number of tokens used in a prompt and completion.
  */
-type CompletionTokenUsage = LanguageModelUsage$1;
-type LanguageModelUsage = LanguageModelUsage$1;
+type LanguageModelUsage = {
+    /**
+  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;
+};
 /**
- * @deprecated Use EmbeddingModelUsage instead.
+Represents the number of tokens used in an embedding.
  */
-type EmbeddingTokenUsage = EmbeddingModelUsage$1;
-type EmbeddingModelUsage = EmbeddingModelUsage$1;
+type EmbeddingModelUsage = {
+    /**
+  The number of tokens used in the embedding.
+     */
+    tokens: number;
+};
 
 /**
 The result of an `embed` call.
@@ -218,7 +199,7 @@ interface EmbedResult<VALUE> {
     /**
     The embedding token usage.
       */
-    readonly usage: EmbeddingModelUsage$1;
+    readonly usage: EmbeddingModelUsage;
     /**
     Optional raw response data.
        */
@@ -288,7 +269,7 @@ interface EmbedManyResult<VALUE> {
     /**
     The embedding token usage.
       */
-    readonly usage: EmbeddingModelUsage$1;
+    readonly usage: EmbeddingModelUsage;
 }
 
 /**
@@ -659,7 +640,7 @@ interface GenerateObjectResult<T> {
     /**
     The token usage of the generated text.
        */
-    readonly usage: LanguageModelUsage$1;
+    readonly usage: LanguageModelUsage;
     /**
     Warnings from the model provider (e.g. unsupported settings).
        */
@@ -916,7 +897,7 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
     /**
     The token usage of the generated response. Resolved when the response is finished.
        */
-    readonly usage: Promise<LanguageModelUsage$1>;
+    readonly usage: Promise<LanguageModelUsage>;
     /**
   Additional provider-specific metadata. They are passed through
   from the provider to the AI SDK and enable provider-specific
@@ -988,7 +969,7 @@ type ObjectStreamPart<PARTIAL> = {
     type: 'finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
-    usage: LanguageModelUsage$1;
+    usage: LanguageModelUsage;
     response: LanguageModelResponseMetadata;
     providerMetadata?: ProviderMetadata;
 };
@@ -997,7 +978,7 @@ type OnFinishCallback<RESULT> = (event: {
     /**
   The token usage of the generated response.
   */
-    usage: LanguageModelUsage$1;
+    usage: LanguageModelUsage;
     /**
   The generated object. Can be undefined if the final object does not match the schema.
   */
@@ -1266,10 +1247,6 @@ declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARA
 }): CoreTool<PARAMETERS, RESULT> & {
     execute: undefined;
 };
-/**
- * @deprecated Use `CoreTool` instead.
- */
-type ExperimentalTool = CoreTool;
 
 /**
 Converts an array of messages from useChat into an array of CoreMessages that can be used
@@ -1374,7 +1351,7 @@ type StepResult<TOOLS extends Record<string, CoreTool>> = {
     /**
   The token usage of the generated text.
   */
-    readonly usage: LanguageModelUsage$1;
+    readonly usage: LanguageModelUsage;
     /**
   Warnings from the model provider (e.g. unsupported settings).
   */
@@ -1440,16 +1417,12 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
     /**
     The token usage of the generated text.
      */
-    readonly usage: LanguageModelUsage$1;
+    readonly usage: LanguageModelUsage;
     /**
     Warnings from the model provider (e.g. unsupported settings)
      */
     readonly warnings: CallWarning[] | undefined;
     /**
-  @deprecated use `response.messages` instead.
-       */
-    readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
-    /**
   Details for all steps.
   You can use this to get information about intermediate steps,
   such as the tool calls or the response headers.
@@ -1534,7 +1507,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, maxSteps, experimental_continuationSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1556,10 +1529,6 @@ By default, it's set to 1, which means that only a single LLM call is made.
      */
     maxSteps?: number;
     /**
-@deprecated Use `experimental_continueSteps` instead.
-     */
-    experimental_continuationSteps?: boolean;
-    /**
 When enabled, the model will perform additional steps if the finish reason is "length" (experimental).
 
 By default, it's set to false.
@@ -1612,11 +1581,6 @@ declare class StreamData {
  * This assumes every chunk is a 'text' chunk.
  */
 declare function createStreamDataTransformer(): TransformStream<any, any>;
-/**
-@deprecated Use `StreamData` instead.
- */
-declare class experimental_StreamData extends StreamData {
-}
 
 /**
 A result object for accessing different stream types and additional information.
@@ -1632,7 +1596,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
   Resolved when the response is finished.
        */
-    readonly usage: Promise<LanguageModelUsage$1>;
+    readonly usage: Promise<LanguageModelUsage>;
     /**
   The reason why the generation finished. Taken from the last step.
   
@@ -1664,10 +1628,6 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
        */
     readonly toolResults: Promise<ToolResultUnion<TOOLS>[]>;
     /**
-  @deprecated use `response.messages` instead.
-       */
-    readonly responseMessages: Promise<Array<CoreAssistantMessage | CoreToolMessage>>;
-    /**
   Details for all steps.
   You can use this to get information about intermediate steps,
   such as the tool calls or the response headers.
@@ -1722,11 +1682,14 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     Writes data stream output to a Node.js response-like object.
   
     @param response A Node.js response-like object (ServerResponse).
-    @param options An object with an init property (ResponseInit) and a data property.
-    You can also pass in a ResponseInit directly (deprecated).
+    @param options.status The status code.
+    @param options.statusText The status text.
+    @param options.headers The headers.
+    @param options.data The stream data.
+    @param options.getErrorMessage An optional function that converts an error to an error message.
+    @param options.sendUsage Whether to send the usage information to the client. Defaults to true.
        */
-    pipeDataStreamToResponse(response: ServerResponse$1, options?: ResponseInit | {
-        init?: ResponseInit;
+    pipeDataStreamToResponse(response: ServerResponse$1, options?: ResponseInit & {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
         sendUsage?: boolean;
@@ -1744,13 +1707,16 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     Converts the result to a streamed response object with a stream data part stream.
     It can be used with the `useChat` and `useCompletion` hooks.
   
-    @param options An object with an init property (ResponseInit) and a data property.
-    You can also pass in a ResponseInit directly (deprecated).
+    @param options.status The status code.
+    @param options.statusText The status text.
+    @param options.headers The headers.
+    @param options.data The stream data.
+    @param options.getErrorMessage An optional function that converts an error to an error message.
+    @param options.sendUsage Whether to send the usage information to the client. Defaults to true.
   
     @return A response object.
        */
-    toDataStreamResponse(options?: ResponseInit | {
-        init?: ResponseInit;
+    toDataStreamResponse(options?: ResponseInit & {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
         sendUsage?: boolean;
@@ -1784,7 +1750,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
     type: 'step-finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
-    usage: LanguageModelUsage$1;
+    usage: LanguageModelUsage;
     response: LanguageModelResponseMetadata;
     experimental_providerMetadata?: ProviderMetadata;
     isContinued: boolean;
@@ -1792,7 +1758,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
     type: 'finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
-    usage: LanguageModelUsage$1;
+    usage: LanguageModelUsage;
     response: LanguageModelResponseMetadata;
     experimental_providerMetadata?: ProviderMetadata;
 } | {
@@ -2034,70 +2000,10 @@ declare class NoSuchProviderError extends NoSuchModelError {
     static isInstance(error: unknown): error is NoSuchProviderError;
 }
 
-/**
- * Provides for language and text embedding models.
- *
- * @deprecated Use `ProviderV1` instead.
- */
-interface experimental_Provider {
-    /**
-  Returns the language model with the given id in the format `providerId:modelId`.
-  The model id is then passed to the provider function to get the model.
-  
-  @param {string} id - The id of the model to return.
-  
-  @throws {NoSuchModelError} If no model with the given id exists.
-  @throws {NoSuchProviderError} If no provider with the given id exists.
-  
-  @returns {LanguageModel} The language model associated with the id.
-     */
-    languageModel?: (modelId: string) => LanguageModel;
-    /**
-  Returns the text embedding model with the given id in the format `providerId:modelId`.
-  The model id is then passed to the provider function to get the model.
-  
-  @param {string} id - The id of the model to return.
-  
-  @throws {NoSuchModelError} If no model with the given id exists.
-  @throws {NoSuchProviderError} If no provider with the given id exists.
-  
-  @returns {LanguageModel} The language model associated with the id.
-     */
-    textEmbeddingModel?: (modelId: string) => EmbeddingModel<string>;
-    /**
-  Returns the text embedding model with the given id in the format `providerId:modelId`.
-  The model id is then passed to the provider function to get the model.
-  
-  @param {string} id - The id of the model to return.
-  
-  @throws {NoSuchModelError} If no model with the given id exists.
-  @throws {NoSuchProviderError} If no provider with the given id exists.
-  
-  @returns {LanguageModel} The language model associated with the id.
-  
-  @deprecated use `textEmbeddingModel` instead.
-     */
-    textEmbedding?: (modelId: string) => EmbeddingModel<string>;
-}
-
-/**
-Registry for managing models. It enables getting a model with a string id.
-
-@deprecated Use `experimental_Provider` instead.
- */
-type experimental_ProviderRegistry = Provider;
-/**
- * @deprecated Use `experimental_ProviderRegistry` instead.
- */
-type experimental_ModelRegistry = experimental_ProviderRegistry;
 /**
  * Creates a registry for the given providers.
  */
-declare function experimental_createProviderRegistry(providers: Record<string, experimental_Provider | Provider>): Provider;
-/**
- * @deprecated Use `experimental_createProviderRegistry` instead.
- */
-declare const experimental_createModelRegistry: typeof experimental_createProviderRegistry;
+declare function experimental_createProviderRegistry(providers: Record<string, Provider>): Provider;
 
 /**
  * Calculates the cosine similarity between two vectors. This is a useful metric for
@@ -2246,14 +2152,6 @@ The process parameter is a callback in which you can run the assistant on thread
  */
 type AssistantResponseCallback = (options: {
     /**
-  @deprecated use variable from outer scope instead.
-     */
-    threadId: string;
-    /**
-  @deprecated use variable from outer scope instead.
-     */
-    messageId: string;
-    /**
   Forwards an assistant message (non-streaming) to the client.
      */
     sendMessage: (message: AssistantMessage) => void;
@@ -2272,10 +2170,6 @@ It is designed to facilitate streaming assistant responses to the `useAssistant`
 It receives an assistant thread and a current message, and can send messages and data messages to the client.
  */
 declare function AssistantResponse({ threadId, messageId }: AssistantResponseSettings, process: AssistantResponseCallback): Response;
-/**
-@deprecated Use `AssistantResponse` instead.
- */
-declare const experimental_AssistantResponse: typeof AssistantResponse;
 
 /**
  * Configuration options and helper callback methods for stream lifecycle events.
@@ -2321,16 +2215,6 @@ type LangChainStreamEvent = {
 /**
 Converts LangChain output streams to AIStream.
 
-The following streams are supported:
-- `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
-- `string` streams (LangChain `StringOutputParser` output)
-
-@deprecated Use `toDataStream` instead.
- */
-declare function toAIStream(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<any>;
-/**
-Converts LangChain output streams to AIStream.
-
 The following streams are supported:
 - `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
 - `string` streams (LangChain `StringOutputParser` output)
@@ -2342,10 +2226,8 @@ declare function toDataStreamResponse$1(stream: ReadableStream<LangChainStreamEv
     callbacks?: StreamCallbacks;
 }): Response;
 
-declare const langchainAdapter_toAIStream: typeof toAIStream;
 declare namespace langchainAdapter {
   export {
-    langchainAdapter_toAIStream as toAIStream,
     toDataStream$1 as toDataStream,
     toDataStreamResponse$1 as toDataStreamResponse,
   };
@@ -2370,4 +2252,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CompletionTokenUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, EmbeddingTokenUsage, ExperimentalTool, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelResponseMetadataWithHeaders, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };