ai 2.1.9 → 2.1.11

package/README.md

@@ -5,8 +5,8 @@ The Vercel AI SDK is **a library for building edge-ready AI-powered streaming te
 ## Features
 
 - [SWR](https://swr.vercel.app)-powered React, Svelte and Vue helpers for streaming text responses and building chat and completion UIs
-- First-class support for [LangChain](js.langchain.com/docs) and [OpenAI](https://openai.com), [Anthropic](https://www.anthropic.com), and [HuggingFace](https://huggingface.co)
-- [Edge Runtime](https://edge-runtime.vercel.app/) compatibility
+- First-class support for [LangChain](js.langchain.com/docs) and [OpenAI](https://openai.com), [Anthropic](https://www.anthropic.com), and [Hugging Face](https://huggingface.co)
+- Node.js, Serverless, and [Edge Runtime](https://edge-runtime.vercel.app/) support
 - Callbacks for saving completed streaming responses to a database (in the same request)
 
 ## Installation

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import { ServerResponse } from 'node:http';
+import { ChatCompletionRequestMessageFunctionCall, CreateChatCompletionRequestFunctionCall } from 'openai-edge';
+import { ChatCompletionFunctions } from 'openai-edge/types/api';
 
 /**
  * Helper callback methods for AIStream stream lifecycle events
@@ -97,8 +99,15 @@ declare function LangChainStream(callbacks?: AIStreamCallbacks): {
     stream: ReadableStream<Uint8Array>;
     handlers: {
         handleLLMNewToken: (token: string) => Promise<void>;
-        handleChainEnd: () => Promise<void>;
-        handleLLMError: (e: any) => Promise<void>;
+        handleLLMStart: (_llm: any, _prompts: string[], runId: string) => Promise<void>;
+        handleLLMEnd: (_output: any, runId: string) => Promise<void>;
+        handleLLMError: (e: Error, runId: string) => Promise<void>;
+        handleChainStart: (_chain: any, _inputs: any, runId: string) => Promise<void>;
+        handleChainEnd: (_outputs: any, runId: string) => Promise<void>;
+        handleChainError: (e: Error, runId: string) => Promise<void>;
+        handleToolStart: (_tool: any, _input: string, runId: string) => Promise<void>;
+        handleToolEnd: (_output: string, runId: string) => Promise<void>;
+        handleToolError: (e: Error, runId: string) => Promise<void>;
     };
 };
 
@@ -109,18 +118,38 @@ type Message = {
     id: string;
     createdAt?: Date;
     content: string;
-    role: 'system' | 'user' | 'assistant';
+    role: 'system' | 'user' | 'assistant' | 'function';
+    /**
+     * If the message has a role of `function`, the `name` field is the name of the function.
+     * Otherwise, the name field should not be set.
+     */
+    name?: string;
+    /**
+     * If the assistant role makes a function call, the `function_call` field
+     * contains the function call name and arguments. Otherwise, the field should
+     * not be set.
+     */
+    function_call?: string | ChatCompletionRequestMessageFunctionCall;
 };
-type CreateMessage = {
-    id?: string;
-    createdAt?: Date;
-    content: string;
-    role: 'system' | 'user' | 'assistant';
+type CreateMessage = Omit<Message, 'id'> & {
+    id?: Message['id'];
 };
+type ChatRequest = {
+    messages: Message[];
+    options?: RequestOptions;
+    functions?: Array<ChatCompletionFunctions>;
+    function_call?: CreateChatCompletionRequestFunctionCall;
+};
+type FunctionCallHandler = (chatMessages: Message[], functionCall: ChatCompletionRequestMessageFunctionCall) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
     body?: object;
 };
+type ChatRequestOptions = {
+    options?: RequestOptions;
+    functions?: Array<ChatCompletionFunctions>;
+    function_call?: CreateChatCompletionRequestFunctionCall;
+};
 type UseChatOptions = {
     /**
      * The API endpoint that accepts a `{ messages: Message[] }` object and returns
@@ -128,7 +157,7 @@ type UseChatOptions = {
      */
     api?: string;
     /**
-     * An unique identifier for the chat. If not provided, a random one will be
+     * A unique identifier for the chat. If not provided, a random one will be
      * generated. When provided, the `useChat` hook with the same `id` will
      * have shared states across components.
      */
@@ -141,6 +170,12 @@ type UseChatOptions = {
      * Initial input of the chat.
      */
     initialInput?: string;
+    /**
+     * Callback function to be called when a function call is received.
+     * If the function returns a `ChatRequest` object, the request will be sent
+     * automatically to the API and will be used to update the chat.
+     */
+    experimental_onFunctionCall?: FunctionCallHandler;
     /**
      * Callback function to be called when the API response is received.
      */
@@ -153,6 +188,12 @@ type UseChatOptions = {
      * Callback function to be called when an error is encountered.
      */
     onError?: (error: Error) => void;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
     /**
      * HTTP headers to be sent with the API request.
      */
@@ -209,6 +250,12 @@ type UseCompletionOptions = {
      * Callback function to be called when an error is encountered.
      */
     onError?: (error: Error) => void;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
     /**
      * HTTP headers to be sent with the API request.
      */
@@ -228,4 +275,7 @@ type UseCompletionOptions = {
     body?: object;
 };
 
-export { AIStream, AIStreamCallbacks, AIStreamParser, AnthropicStream, CohereStream, CreateMessage, HuggingFaceStream, LangChainStream, Message, OpenAIStream, RequestOptions, StreamingTextResponse, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createEventStreamTransformer, streamToResponse, trimStartOfStreamHelper };
+declare const nanoid: (size?: number | undefined) => string;
+declare function createChunkDecoder(): (chunk: Uint8Array | undefined) => string;
+
+export { AIStream, AIStreamCallbacks, AIStreamParser, AnthropicStream, ChatRequest, ChatRequestOptions, CohereStream, CreateMessage, FunctionCallHandler, HuggingFaceStream, LangChainStream, Message, OpenAIStream, RequestOptions, StreamingTextResponse, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, nanoid, streamToResponse, trimStartOfStreamHelper };

package/dist/index.js

@@ -65,7 +65,9 @@ __export(streams_exports, {
   OpenAIStream: () => OpenAIStream,
   StreamingTextResponse: () => StreamingTextResponse,
   createCallbacksTransformer: () => createCallbacksTransformer,
+  createChunkDecoder: () => createChunkDecoder,
   createEventStreamTransformer: () => createEventStreamTransformer,
+  nanoid: () => nanoid,
   streamToResponse: () => streamToResponse,
   trimStartOfStreamHelper: () => trimStartOfStreamHelper
 });
@@ -159,10 +161,19 @@ function createEmptyReadableStream() {
 function parseOpenAIStream() {
   const trimStartOfStream = trimStartOfStreamHelper();
   return (data) => {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
     const json = JSON.parse(data);
+    if ((_c = (_b = (_a = json.choices[0]) == null ? void 0 : _a.delta) == null ? void 0 : _b.function_call) == null ? void 0 : _c.name) {
+      return `{"function_call": {"name": "${(_e = (_d = json.choices[0]) == null ? void 0 : _d.delta) == null ? void 0 : _e.function_call.name}", "arguments": "`;
+    } else if ((_h = (_g = (_f = json.choices[0]) == null ? void 0 : _f.delta) == null ? void 0 : _g.function_call) == null ? void 0 : _h.arguments) {
+      const argumentChunk = json.choices[0].delta.function_call.arguments;
+      let escapedPartialJson = argumentChunk.replace(/\\/g, "\\\\").replace(/\//g, "\\/").replace(/"/g, '\\"').replace(/\n/g, "\\n").replace(/\r/g, "\\r").replace(/\t/g, "\\t").replace(/\f/g, "\\f");
+      return `${escapedPartialJson}`;
+    } else if (((_i = json.choices[0]) == null ? void 0 : _i.finish_reason) === "function_call") {
+      return '"}}';
+    }
     const text = trimStartOfStream(
-      (_e = (_d = (_b = (_a = json.choices[0]) == null ? void 0 : _a.delta) == null ? void 0 : _b.content) != null ? _d : (_c = json.choices[0]) == null ? void 0 : _c.text) != null ? _e : ""
+      (_n = (_m = (_k = (_j = json.choices[0]) == null ? void 0 : _j.delta) == null ? void 0 : _k.content) != null ? _m : (_l = json.choices[0]) == null ? void 0 : _l.text) != null ? _n : ""
     );
     return text;
   };
@@ -275,6 +286,22 @@ function AnthropicStream(res, cb) {
 function LangChainStream(callbacks) {
   const stream = new TransformStream();
   const writer = stream.writable.getWriter();
+  const runs = /* @__PURE__ */ new Set();
+  const handleError = (e, runId) => __async(this, null, function* () {
+    runs.delete(runId);
+    yield writer.ready;
+    yield writer.abort(e);
+  });
+  const handleStart = (runId) => __async(this, null, function* () {
+    runs.add(runId);
+  });
+  const handleEnd = (runId) => __async(this, null, function* () {
+    runs.delete(runId);
+    if (runs.size === 0) {
+      yield writer.ready;
+      yield writer.close();
+    }
+  });
   return {
     stream: stream.readable.pipeThrough(createCallbacksTransformer(callbacks)),
     handlers: {
@@ -282,17 +309,51 @@ function LangChainStream(callbacks) {
         yield writer.ready;
         yield writer.write(token);
       }),
-      handleChainEnd: () => __async(this, null, function* () {
-        yield writer.ready;
-        yield writer.close();
+      handleLLMStart: (_llm, _prompts, runId) => __async(this, null, function* () {
+        handleStart(runId);
       }),
-      handleLLMError: (e) => __async(this, null, function* () {
-        yield writer.ready;
-        yield writer.abort(e);
+      handleLLMEnd: (_output, runId) => __async(this, null, function* () {
+        yield handleEnd(runId);
+      }),
+      handleLLMError: (e, runId) => __async(this, null, function* () {
+        yield handleError(e, runId);
+      }),
+      handleChainStart: (_chain, _inputs, runId) => __async(this, null, function* () {
+        handleStart(runId);
+      }),
+      handleChainEnd: (_outputs, runId) => __async(this, null, function* () {
+        yield handleEnd(runId);
+      }),
+      handleChainError: (e, runId) => __async(this, null, function* () {
+        yield handleError(e, runId);
+      }),
+      handleToolStart: (_tool, _input, runId) => __async(this, null, function* () {
+        handleStart(runId);
+      }),
+      handleToolEnd: (_output, runId) => __async(this, null, function* () {
+        yield handleEnd(runId);
+      }),
+      handleToolError: (e, runId) => __async(this, null, function* () {
+        yield handleError(e, runId);
       })
     }
   };
 }
+
+// shared/utils.ts
+var import_nanoid = require("nanoid");
+var nanoid = (0, import_nanoid.customAlphabet)(
+  "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz",
+  7
+);
+function createChunkDecoder() {
+  const decoder = new TextDecoder();
+  return function(chunk) {
+    if (!chunk)
+      return "";
+    return decoder.decode(chunk, { stream: true });
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AIStream,
@@ -303,7 +364,9 @@ function LangChainStream(callbacks) {
   OpenAIStream,
   StreamingTextResponse,
   createCallbacksTransformer,
+  createChunkDecoder,
   createEventStreamTransformer,
+  nanoid,
   streamToResponse,
   trimStartOfStreamHelper
 });

package/dist/index.mjs

@@ -128,10 +128,19 @@ function createEmptyReadableStream() {
 function parseOpenAIStream() {
   const trimStartOfStream = trimStartOfStreamHelper();
   return (data) => {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
     const json = JSON.parse(data);
+    if ((_c = (_b = (_a = json.choices[0]) == null ? void 0 : _a.delta) == null ? void 0 : _b.function_call) == null ? void 0 : _c.name) {
+      return `{"function_call": {"name": "${(_e = (_d = json.choices[0]) == null ? void 0 : _d.delta) == null ? void 0 : _e.function_call.name}", "arguments": "`;
+    } else if ((_h = (_g = (_f = json.choices[0]) == null ? void 0 : _f.delta) == null ? void 0 : _g.function_call) == null ? void 0 : _h.arguments) {
+      const argumentChunk = json.choices[0].delta.function_call.arguments;
+      let escapedPartialJson = argumentChunk.replace(/\\/g, "\\\\").replace(/\//g, "\\/").replace(/"/g, '\\"').replace(/\n/g, "\\n").replace(/\r/g, "\\r").replace(/\t/g, "\\t").replace(/\f/g, "\\f");
+      return `${escapedPartialJson}`;
+    } else if (((_i = json.choices[0]) == null ? void 0 : _i.finish_reason) === "function_call") {
+      return '"}}';
+    }
     const text = trimStartOfStream(
-      (_e = (_d = (_b = (_a = json.choices[0]) == null ? void 0 : _a.delta) == null ? void 0 : _b.content) != null ? _d : (_c = json.choices[0]) == null ? void 0 : _c.text) != null ? _e : ""
+      (_n = (_m = (_k = (_j = json.choices[0]) == null ? void 0 : _j.delta) == null ? void 0 : _k.content) != null ? _m : (_l = json.choices[0]) == null ? void 0 : _l.text) != null ? _n : ""
     );
     return text;
   };
@@ -244,6 +253,22 @@ function AnthropicStream(res, cb) {
 function LangChainStream(callbacks) {
   const stream = new TransformStream();
   const writer = stream.writable.getWriter();
+  const runs = /* @__PURE__ */ new Set();
+  const handleError = (e, runId) => __async(this, null, function* () {
+    runs.delete(runId);
+    yield writer.ready;
+    yield writer.abort(e);
+  });
+  const handleStart = (runId) => __async(this, null, function* () {
+    runs.add(runId);
+  });
+  const handleEnd = (runId) => __async(this, null, function* () {
+    runs.delete(runId);
+    if (runs.size === 0) {
+      yield writer.ready;
+      yield writer.close();
+    }
+  });
   return {
     stream: stream.readable.pipeThrough(createCallbacksTransformer(callbacks)),
     handlers: {
@@ -251,17 +276,51 @@ function LangChainStream(callbacks) {
         yield writer.ready;
         yield writer.write(token);
       }),
-      handleChainEnd: () => __async(this, null, function* () {
-        yield writer.ready;
-        yield writer.close();
+      handleLLMStart: (_llm, _prompts, runId) => __async(this, null, function* () {
+        handleStart(runId);
       }),
-      handleLLMError: (e) => __async(this, null, function* () {
-        yield writer.ready;
-        yield writer.abort(e);
+      handleLLMEnd: (_output, runId) => __async(this, null, function* () {
+        yield handleEnd(runId);
+      }),
+      handleLLMError: (e, runId) => __async(this, null, function* () {
+        yield handleError(e, runId);
+      }),
+      handleChainStart: (_chain, _inputs, runId) => __async(this, null, function* () {
+        handleStart(runId);
+      }),
+      handleChainEnd: (_outputs, runId) => __async(this, null, function* () {
+        yield handleEnd(runId);
+      }),
+      handleChainError: (e, runId) => __async(this, null, function* () {
+        yield handleError(e, runId);
+      }),
+      handleToolStart: (_tool, _input, runId) => __async(this, null, function* () {
+        handleStart(runId);
+      }),
+      handleToolEnd: (_output, runId) => __async(this, null, function* () {
+        yield handleEnd(runId);
+      }),
+      handleToolError: (e, runId) => __async(this, null, function* () {
+        yield handleError(e, runId);
       })
     }
   };
 }
+
+// shared/utils.ts
+import { customAlphabet } from "nanoid";
+var nanoid = customAlphabet(
+  "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz",
+  7
+);
+function createChunkDecoder() {
+  const decoder = new TextDecoder();
+  return function(chunk) {
+    if (!chunk)
+      return "";
+    return decoder.decode(chunk, { stream: true });
+  };
+}
 export {
   AIStream,
   AnthropicStream,
@@ -271,7 +330,9 @@ export {
   OpenAIStream,
   StreamingTextResponse,
   createCallbacksTransformer,
+  createChunkDecoder,
   createEventStreamTransformer,
+  nanoid,
   streamToResponse,
   trimStartOfStreamHelper
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "2.1.9",
+  "version": "2.1.11",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -45,9 +45,9 @@
   },
   "dependencies": {
     "eventsource-parser": "1.0.0",
+    "swr": "2.1.5",
     "nanoid": "^3.3.6",
     "sswr": "^1.10.0",
-    "swr": "2.1.5",
     "swrv": "1.0.3"
   },
   "devDependencies": {
@@ -58,6 +58,7 @@
     "@types/react-dom": "^18.2.0",
     "eslint": "^7.32.0",
     "jest": "29.2.1",
+    "openai-edge": "^1.1.0",
     "ts-jest": "29.0.3",
     "tsup": "^6.7.0",
     "typescript": "5.1.3",
@@ -66,7 +67,7 @@
   },
   "peerDependencies": {
     "react": "^18.2.0",
-    "svelte": "^3.29.0",
+    "svelte": "^4.0.0",
     "vue": "^3.3.4"
   },
   "peerDependenciesMeta": {

package/react/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { ChatCompletionRequestMessageFunctionCall, CreateChatCompletionRequestFunctionCall } from 'openai-edge';
+import { ChatCompletionFunctions } from 'openai-edge/types/api';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
@@ -7,18 +9,38 @@ type Message = {
     id: string;
     createdAt?: Date;
     content: string;
-    role: 'system' | 'user' | 'assistant';
+    role: 'system' | 'user' | 'assistant' | 'function';
+    /**
+     * If the message has a role of `function`, the `name` field is the name of the function.
+     * Otherwise, the name field should not be set.
+     */
+    name?: string;
+    /**
+     * If the assistant role makes a function call, the `function_call` field
+     * contains the function call name and arguments. Otherwise, the field should
+     * not be set.
+     */
+    function_call?: string | ChatCompletionRequestMessageFunctionCall;
 };
-type CreateMessage = {
-    id?: string;
-    createdAt?: Date;
-    content: string;
-    role: 'system' | 'user' | 'assistant';
+type CreateMessage = Omit<Message, 'id'> & {
+    id?: Message['id'];
+};
+type ChatRequest = {
+    messages: Message[];
+    options?: RequestOptions;
+    functions?: Array<ChatCompletionFunctions>;
+    function_call?: CreateChatCompletionRequestFunctionCall;
 };
+type FunctionCallHandler = (chatMessages: Message[], functionCall: ChatCompletionRequestMessageFunctionCall) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
     body?: object;
 };
+type ChatRequestOptions = {
+    options?: RequestOptions;
+    functions?: Array<ChatCompletionFunctions>;
+    function_call?: CreateChatCompletionRequestFunctionCall;
+};
 type UseChatOptions = {
     /**
      * The API endpoint that accepts a `{ messages: Message[] }` object and returns
@@ -26,7 +48,7 @@ type UseChatOptions = {
      */
     api?: string;
     /**
-     * An unique identifier for the chat. If not provided, a random one will be
+     * A unique identifier for the chat. If not provided, a random one will be
      * generated. When provided, the `useChat` hook with the same `id` will
      * have shared states across components.
      */
@@ -39,6 +61,12 @@ type UseChatOptions = {
      * Initial input of the chat.
      */
     initialInput?: string;
+    /**
+     * Callback function to be called when a function call is received.
+     * If the function returns a `ChatRequest` object, the request will be sent
+     * automatically to the API and will be used to update the chat.
+     */
+    experimental_onFunctionCall?: FunctionCallHandler;
     /**
      * Callback function to be called when the API response is received.
      */
@@ -51,6 +79,12 @@ type UseChatOptions = {
      * Callback function to be called when an error is encountered.
      */
     onError?: (error: Error) => void;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
     /**
      * HTTP headers to be sent with the API request.
      */
@@ -107,6 +141,12 @@ type UseCompletionOptions = {
      * Callback function to be called when an error is encountered.
      */
     onError?: (error: Error) => void;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
     /**
      * HTTP headers to be sent with the API request.
      */
@@ -137,13 +177,13 @@ type UseChatHelpers = {
      * @param message The message to append
      * @param options Additional options to pass to the API call
      */
-    append: (message: Message | CreateMessage, options?: RequestOptions) => Promise<string | null | undefined>;
+    append: (message: Message | CreateMessage, chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
     /**
      * Reload the last AI chat response for the given chat history. If the last
      * message isn't from the assistant, it will request the API to generate a
      * new response.
      */
-    reload: (options?: RequestOptions) => Promise<string | null | undefined>;
+    reload: (chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
     /**
      * Abort the current request immediately, keep the generated tokens if any.
      */
@@ -161,11 +201,12 @@ type UseChatHelpers = {
     /** An input/textarea-ready onChange handler to control the value of the input */
     handleInputChange: (e: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
     /** Form submission handler to automattically reset input and append a user message  */
-    handleSubmit: (e: React.FormEvent<HTMLFormElement>) => void;
+    handleSubmit: (e: React.FormEvent<HTMLFormElement>, chatRequestOptions?: ChatRequestOptions) => void;
+    metadata?: Object;
     /** Whether the API request is in progress */
     isLoading: boolean;
 };
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onResponse, onFinish, onError, headers, body }?: UseChatOptions): UseChatHelpers;
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, onResponse, onFinish, onError, credentials, headers, body }?: UseChatOptions): UseChatHelpers;
 
 type UseCompletionHelpers = {
     /** The current completion result */
@@ -209,7 +250,7 @@ type UseCompletionHelpers = {
     /** Whether the API request is in progress */
     isLoading: boolean;
 };
-declare function useCompletion({ api, id, initialCompletion, initialInput, headers, body, onResponse, onFinish, onError }?: UseCompletionOptions): UseCompletionHelpers;
+declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, onResponse, onFinish, onError }?: UseCompletionOptions): UseCompletionHelpers;
 
 type Props = {
     /**