ai 3.3.27 → 3.3.28

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 3.3.28
+
+### Patch Changes
+
+- db61c53: feat (ai/core): middleware support
+
 ## 3.3.27
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,8 +1,8 @@
 import { Schema, DeepPartial, ToolInvocation, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
 import { AttributeValue } from '@opentelemetry/api';
-import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
-export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
+import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1CallOptions, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
+export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ServerResponse } from 'http';
 import { ServerResponse as ServerResponse$1 } from 'node:http';
@@ -1789,6 +1789,72 @@ Callback that is called when the LLM response and all request tool executions
  */
 declare const experimental_streamText: typeof streamText;
 
+/**
+ * Experimental middleware for LanguageModelV1.
+ * This type defines the structure for middleware that can be used to modify
+ * the behavior of LanguageModelV1 operations.
+ */
+type Experimental_LanguageModelV1Middleware = {
+    /**
+     * Transforms the parameters before they are passed to the language model.
+     * @param options - Object containing the type of operation and the parameters.
+     * @param options.type - The type of operation ('generate' or 'stream').
+     * @param options.params - The original parameters for the language model call.
+     * @returns A promise that resolves to the transformed parameters.
+     */
+    transformParams?: (options: {
+        type: 'generate' | 'stream';
+        params: LanguageModelV1CallOptions;
+    }) => PromiseLike<LanguageModelV1CallOptions>;
+    /**
+     * Wraps the generate operation of the language model.
+     * @param options - Object containing the generate function, parameters, and model.
+     * @param options.doGenerate - The original generate function.
+     * @param options.params - The parameters for the generate call. If the
+     * `transformParams` middleware is used, this will be the transformed parameters.
+     * @param options.model - The language model instance.
+     * @returns A promise that resolves to the result of the generate operation.
+     */
+    wrapGenerate?: (options: {
+        doGenerate: () => ReturnType<LanguageModelV1['doGenerate']>;
+        params: LanguageModelV1CallOptions;
+        model: LanguageModelV1;
+    }) => Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
+    /**
+     * Wraps the stream operation of the language model.
+     * @param options - Object containing the stream function, parameters, and model.
+     * @param options.doStream - The original stream function.
+     * @param options.params - The parameters for the stream call. If the
+     * `transformParams` middleware is used, this will be the transformed parameters.
+     * @param options.model - The language model instance.
+     * @returns A promise that resolves to the result of the stream operation.
+     */
+    wrapStream?: (options: {
+        doStream: () => ReturnType<LanguageModelV1['doStream']>;
+        params: LanguageModelV1CallOptions;
+        model: LanguageModelV1;
+    }) => PromiseLike<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
+};
+
+/**
+ * Wraps a LanguageModelV1 instance with middleware functionality.
+ * This function allows you to apply middleware to transform parameters,
+ * wrap generate operations, and wrap stream operations of a language model.
+ *
+ * @param options - Configuration options for wrapping the language model.
+ * @param options.model - The original LanguageModelV1 instance to be wrapped.
+ * @param options.middleware - The middleware to be applied to the language model.
+ * @param options.modelId - Optional custom model ID to override the original model's ID.
+ * @param options.providerId - Optional custom provider ID to override the original model's provider.
+ * @returns A new LanguageModelV1 instance with middleware applied.
+ */
+declare const experimental_wrapLanguageModel: ({ model, middleware: { transformParams, wrapGenerate, wrapStream }, modelId, providerId, }: {
+    model: LanguageModelV1;
+    middleware: Experimental_LanguageModelV1Middleware;
+    modelId?: string;
+    providerId?: string;
+}) => LanguageModelV1;
+
 /**
  * Creates a custom provider with specified language models, text embedding models, and an optional fallback provider.
  *
@@ -2901,4 +2967,4 @@ declare const generateId: () => 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, 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 };
+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, Experimental_LanguageModelV1Middleware, 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, experimental_wrapLanguageModel, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { Schema, DeepPartial, ToolInvocation, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
 import { AttributeValue } from '@opentelemetry/api';
-import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
-export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
+import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1CallOptions, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
+export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ServerResponse } from 'http';
 import { ServerResponse as ServerResponse$1 } from 'node:http';
@@ -1789,6 +1789,72 @@ Callback that is called when the LLM response and all request tool executions
  */
 declare const experimental_streamText: typeof streamText;
 
+/**
+ * Experimental middleware for LanguageModelV1.
+ * This type defines the structure for middleware that can be used to modify
+ * the behavior of LanguageModelV1 operations.
+ */
+type Experimental_LanguageModelV1Middleware = {
+    /**
+     * Transforms the parameters before they are passed to the language model.
+     * @param options - Object containing the type of operation and the parameters.
+     * @param options.type - The type of operation ('generate' or 'stream').
+     * @param options.params - The original parameters for the language model call.
+     * @returns A promise that resolves to the transformed parameters.
+     */
+    transformParams?: (options: {
+        type: 'generate' | 'stream';
+        params: LanguageModelV1CallOptions;
+    }) => PromiseLike<LanguageModelV1CallOptions>;
+    /**
+     * Wraps the generate operation of the language model.
+     * @param options - Object containing the generate function, parameters, and model.
+     * @param options.doGenerate - The original generate function.
+     * @param options.params - The parameters for the generate call. If the
+     * `transformParams` middleware is used, this will be the transformed parameters.
+     * @param options.model - The language model instance.
+     * @returns A promise that resolves to the result of the generate operation.
+     */
+    wrapGenerate?: (options: {
+        doGenerate: () => ReturnType<LanguageModelV1['doGenerate']>;
+        params: LanguageModelV1CallOptions;
+        model: LanguageModelV1;
+    }) => Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
+    /**
+     * Wraps the stream operation of the language model.
+     * @param options - Object containing the stream function, parameters, and model.
+     * @param options.doStream - The original stream function.
+     * @param options.params - The parameters for the stream call. If the
+     * `transformParams` middleware is used, this will be the transformed parameters.
+     * @param options.model - The language model instance.
+     * @returns A promise that resolves to the result of the stream operation.
+     */
+    wrapStream?: (options: {
+        doStream: () => ReturnType<LanguageModelV1['doStream']>;
+        params: LanguageModelV1CallOptions;
+        model: LanguageModelV1;
+    }) => PromiseLike<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
+};
+
+/**
+ * Wraps a LanguageModelV1 instance with middleware functionality.
+ * This function allows you to apply middleware to transform parameters,
+ * wrap generate operations, and wrap stream operations of a language model.
+ *
+ * @param options - Configuration options for wrapping the language model.
+ * @param options.model - The original LanguageModelV1 instance to be wrapped.
+ * @param options.middleware - The middleware to be applied to the language model.
+ * @param options.modelId - Optional custom model ID to override the original model's ID.
+ * @param options.providerId - Optional custom provider ID to override the original model's provider.
+ * @returns A new LanguageModelV1 instance with middleware applied.
+ */
+declare const experimental_wrapLanguageModel: ({ model, middleware: { transformParams, wrapGenerate, wrapStream }, modelId, providerId, }: {
+    model: LanguageModelV1;
+    middleware: Experimental_LanguageModelV1Middleware;
+    modelId?: string;
+    providerId?: string;
+}) => LanguageModelV1;
+
 /**
  * Creates a custom provider with specified language models, text embedding models, and an optional fallback provider.
  *
@@ -2901,4 +2967,4 @@ declare const generateId: () => 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, 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 };
+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, Experimental_LanguageModelV1Middleware, 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, experimental_wrapLanguageModel, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.js

@@ -76,6 +76,7 @@ __export(streams_exports, {
   experimental_generateText: () => experimental_generateText,
   experimental_streamObject: () => experimental_streamObject,
   experimental_streamText: () => experimental_streamText,
+  experimental_wrapLanguageModel: () => experimental_wrapLanguageModel,
   formatStreamPart: () => import_ui_utils10.formatStreamPart,
   generateId: () => generateId2,
   generateObject: () => generateObject,
@@ -4208,6 +4209,39 @@ var DefaultStreamTextResult = class {
 };
 var experimental_streamText = streamText;
 
+// core/middleware/wrap-language-model.ts
+var experimental_wrapLanguageModel = ({
+  model,
+  middleware: { transformParams, wrapGenerate, wrapStream },
+  modelId,
+  providerId
+}) => {
+  async function doTransform({
+    params,
+    type
+  }) {
+    return transformParams ? await transformParams({ params, type }) : params;
+  }
+  return {
+    specificationVersion: "v1",
+    provider: providerId != null ? providerId : model.provider,
+    modelId: modelId != null ? modelId : model.modelId,
+    defaultObjectGenerationMode: model.defaultObjectGenerationMode,
+    supportsImageUrls: model.supportsImageUrls,
+    supportsStructuredOutputs: model.supportsStructuredOutputs,
+    async doGenerate(params) {
+      const transformedParams = await doTransform({ params, type: "generate" });
+      const doGenerate = async () => model.doGenerate(transformedParams);
+      return wrapGenerate ? wrapGenerate({ doGenerate, params: transformedParams, model }) : doGenerate();
+    },
+    async doStream(params) {
+      const transformedParams = await doTransform({ params, type: "stream" });
+      const doStream = async () => model.doStream(transformedParams);
+      return wrapStream ? wrapStream({ doStream, params: transformedParams, model }) : doStream();
+    }
+  };
+};
+
 // core/prompt/attachments-to-parts.ts
 function attachmentsToParts(attachments) {
   var _a11, _b, _c;
@@ -5639,6 +5673,7 @@ var nanoid = import_provider_utils11.generateId;
   experimental_generateText,
   experimental_streamObject,
   experimental_streamText,
+  experimental_wrapLanguageModel,
   formatStreamPart,
   generateId,
   generateObject,