ai 3.1.3 → 3.1.5

package/dist/index.d.mts

@@ -162,7 +162,18 @@ interface ToolResultPart {
 A message that can be used in the `messages` field of a prompt.
 It can be a user message, an assistant message, or a tool message.
  */
-type CoreMessage = CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
+type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
+/**
+ A system message. It can contain system information.
+
+ Note: using the "system" part of the prompt is strongly preferred
+ to increase the resilience against prompt injection attacks,
+ and because not all providers support several system messages.
+ */
+type CoreSystemMessage = {
+    role: 'system';
+    content: string;
+};
 /**
  * @deprecated Use `CoreMessage` instead.
  */
@@ -510,11 +521,12 @@ interface CoreTool<PARAMETERS extends z.ZodTypeAny = any, RESULT = any> {
     description?: string;
     /**
   The schema of the input that the tool expects. The language model will use this to generate the input.
+  It is also used to validate the output of the language model.
   Use descriptions to make the input understandable for the language model.
      */
     parameters: PARAMETERS;
     /**
-  An optional execute function for the actual execution function of the tool.
+  An async function that is called with the arguments from the tool call and produces a result.
   If not provided, the tool will not be executed automatically.
      */
     execute?: (args: z.infer<PARAMETERS>) => PromiseLike<RESULT>;
@@ -615,7 +627,7 @@ Generate a text and call tools for a given prompt using a language model.
 This function does not stream the output. If you want to stream the output, use `streamText` instead.
 
 @param model - The language model to use.
-@param tools - The tools that the model can call. The model needs to support calling tools.
+@param tools - Tools that are accessible to and can be called by the model. The model needs to support calling tools.
 
 @param system - A system message that will be part of the prompt.
 @param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
@@ -720,7 +732,7 @@ Generate a text and call tools for a given prompt using a language model.
 This function streams the output. If you do not want to stream the output, use `generateText` instead.
 
 @param model - The language model to use.
-@param tools - The tools that the model can call. The model needs to support calling tools.
+@param tools - Tools that are accessible to and can be called by the model. The model needs to support calling tools.
 
 @param system - A system message that will be part of the prompt.
 @param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
@@ -784,7 +796,7 @@ A result object for accessing different stream types and additional information.
 declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     private originalStream;
     /**
-  Warnings from the model provider (e.g. unsupported settings)
+  Warnings from the model provider (e.g. unsupported settings).
      */
     readonly warnings: CallWarning[] | undefined;
     /**
@@ -1827,6 +1839,42 @@ type InkeepChatResultCallbacks = {
 type InkeepAIStreamCallbacksAndOptions = AIStreamCallbacksAndOptions & InkeepChatResultCallbacks;
 declare function InkeepStream(res: Response, callbacks?: InkeepAIStreamCallbacksAndOptions): ReadableStream;
 
+type LangChainImageDetail = 'auto' | 'low' | 'high';
+type LangChainMessageContentText = {
+    type: 'text';
+    text: string;
+};
+type LangChainMessageContentImageUrl = {
+    type: 'image_url';
+    image_url: string | {
+        url: string;
+        detail?: LangChainImageDetail;
+    };
+};
+type LangChainMessageContentComplex = LangChainMessageContentText | LangChainMessageContentImageUrl | (Record<string, any> & {
+    type?: 'text' | 'image_url' | string;
+}) | (Record<string, any> & {
+    type?: never;
+});
+type LangChainMessageContent = string | LangChainMessageContentComplex[];
+type LangChainAIMessageChunk = {
+    content: LangChainMessageContent;
+};
+/**
+Converts the result of a LangChain Expression Language stream invocation to an AIStream.
+ */
+declare function toAIStream(stream: ReadableStream<LangChainAIMessageChunk>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
+
+declare const langchainAdapter_toAIStream: typeof toAIStream;
+declare namespace langchainAdapter {
+  export {
+    langchainAdapter_toAIStream as toAIStream,
+  };
+}
+
+/**
+@deprecated Use LangChainAdapter.toAIStream() instead.
+ */
 declare function LangChainStream(callbacks?: AIStreamCallbacksAndOptions): {
     stream: ReadableStream<any>;
     writer: WritableStreamDefaultWriter<any>;
@@ -1991,4 +2039,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, 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, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, 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, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, 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, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, 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

@@ -162,7 +162,18 @@ interface ToolResultPart {
 A message that can be used in the `messages` field of a prompt.
 It can be a user message, an assistant message, or a tool message.
  */
-type CoreMessage = CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
+type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
+/**
+ A system message. It can contain system information.
+
+ Note: using the "system" part of the prompt is strongly preferred
+ to increase the resilience against prompt injection attacks,
+ and because not all providers support several system messages.
+ */
+type CoreSystemMessage = {
+    role: 'system';
+    content: string;
+};
 /**
  * @deprecated Use `CoreMessage` instead.
  */
@@ -510,11 +521,12 @@ interface CoreTool<PARAMETERS extends z.ZodTypeAny = any, RESULT = any> {
     description?: string;
     /**
   The schema of the input that the tool expects. The language model will use this to generate the input.
+  It is also used to validate the output of the language model.
   Use descriptions to make the input understandable for the language model.
      */
     parameters: PARAMETERS;
     /**
-  An optional execute function for the actual execution function of the tool.
+  An async function that is called with the arguments from the tool call and produces a result.
   If not provided, the tool will not be executed automatically.
      */
     execute?: (args: z.infer<PARAMETERS>) => PromiseLike<RESULT>;
@@ -615,7 +627,7 @@ Generate a text and call tools for a given prompt using a language model.
 This function does not stream the output. If you want to stream the output, use `streamText` instead.
 
 @param model - The language model to use.
-@param tools - The tools that the model can call. The model needs to support calling tools.
+@param tools - Tools that are accessible to and can be called by the model. The model needs to support calling tools.
 
 @param system - A system message that will be part of the prompt.
 @param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
@@ -720,7 +732,7 @@ Generate a text and call tools for a given prompt using a language model.
 This function streams the output. If you do not want to stream the output, use `generateText` instead.
 
 @param model - The language model to use.
-@param tools - The tools that the model can call. The model needs to support calling tools.
+@param tools - Tools that are accessible to and can be called by the model. The model needs to support calling tools.
 
 @param system - A system message that will be part of the prompt.
 @param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
@@ -784,7 +796,7 @@ A result object for accessing different stream types and additional information.
 declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     private originalStream;
     /**
-  Warnings from the model provider (e.g. unsupported settings)
+  Warnings from the model provider (e.g. unsupported settings).
      */
     readonly warnings: CallWarning[] | undefined;
     /**
@@ -1827,6 +1839,42 @@ type InkeepChatResultCallbacks = {
 type InkeepAIStreamCallbacksAndOptions = AIStreamCallbacksAndOptions & InkeepChatResultCallbacks;
 declare function InkeepStream(res: Response, callbacks?: InkeepAIStreamCallbacksAndOptions): ReadableStream;
 
+type LangChainImageDetail = 'auto' | 'low' | 'high';
+type LangChainMessageContentText = {
+    type: 'text';
+    text: string;
+};
+type LangChainMessageContentImageUrl = {
+    type: 'image_url';
+    image_url: string | {
+        url: string;
+        detail?: LangChainImageDetail;
+    };
+};
+type LangChainMessageContentComplex = LangChainMessageContentText | LangChainMessageContentImageUrl | (Record<string, any> & {
+    type?: 'text' | 'image_url' | string;
+}) | (Record<string, any> & {
+    type?: never;
+});
+type LangChainMessageContent = string | LangChainMessageContentComplex[];
+type LangChainAIMessageChunk = {
+    content: LangChainMessageContent;
+};
+/**
+Converts the result of a LangChain Expression Language stream invocation to an AIStream.
+ */
+declare function toAIStream(stream: ReadableStream<LangChainAIMessageChunk>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
+
+declare const langchainAdapter_toAIStream: typeof toAIStream;
+declare namespace langchainAdapter {
+  export {
+    langchainAdapter_toAIStream as toAIStream,
+  };
+}
+
+/**
+@deprecated Use LangChainAdapter.toAIStream() instead.
+ */
 declare function LangChainStream(callbacks?: AIStreamCallbacksAndOptions): {
     stream: ReadableStream<any>;
     writer: WritableStreamDefaultWriter<any>;
@@ -1991,4 +2039,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, 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, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, 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, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, 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, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, 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

@@ -52,6 +52,7 @@ __export(streams_exports, {
   InvalidResponseDataError: () => import_provider8.InvalidResponseDataError,
   InvalidToolArgumentsError: () => import_provider8.InvalidToolArgumentsError,
   JSONParseError: () => import_provider8.JSONParseError,
+  LangChainAdapter: () => langchain_adapter_exports,
   LangChainStream: () => LangChainStream,
   LoadAPIKeyError: () => import_provider8.LoadAPIKeyError,
   MistralStream: () => MistralStream,
@@ -170,6 +171,9 @@ function convertToLanguageModelPrompt(prompt) {
       languageModelMessages.push(
         ...prompt.messages.map((message) => {
           switch (message.role) {
+            case "system": {
+              return { role: "system", content: message.content };
+            }
             case "user": {
               if (typeof message.content === "string") {
                 return {
@@ -2464,6 +2468,30 @@ function InkeepStream(res, callbacks) {
   );
 }
 
+// streams/langchain-adapter.ts
+var langchain_adapter_exports = {};
+__export(langchain_adapter_exports, {
+  toAIStream: () => toAIStream
+});
+function toAIStream(stream, callbacks) {
+  return stream.pipeThrough(
+    new TransformStream({
+      transform: async (chunk, controller) => {
+        if (typeof chunk.content === "string") {
+          controller.enqueue(chunk.content);
+        } else {
+          const content = chunk.content;
+          for (const item of content) {
+            if (item.type === "text") {
+              controller.enqueue(item.text);
+            }
+          }
+        }
+      }
+    })
+  ).pipeThrough(createCallbacksTransformer(callbacks)).pipeThrough(createStreamDataTransformer());
+}
+
 // streams/langchain-stream.ts
 function LangChainStream(callbacks) {
   const stream = new TransformStream();
@@ -3091,6 +3119,7 @@ function streamToResponse(res, response, init) {
   InvalidResponseDataError,
   InvalidToolArgumentsError,
   JSONParseError,
+  LangChainAdapter,
   LangChainStream,
   LoadAPIKeyError,
   MistralStream,