ai 3.3.6 → 3.3.8

package/rsc/dist/rsc-server.d.mts

@@ -1,7 +1,7 @@
-import OpenAI from 'openai';
+import { LanguageModelV1FinishReason, LanguageModelV1CallWarning, LanguageModelV1 } from '@ai-sdk/provider';
 import { ReactNode } from 'react';
 import { z } from 'zod';
-import { LanguageModelV1FinishReason, LanguageModelV1CallWarning, LanguageModelV1 } from '@ai-sdk/provider';
+import OpenAI from 'openai';
 
 type AIAction<T = any, R = any> = (...args: T[]) => Promise<R>;
 type AIActions<T = any, R = any> = Record<string, AIAction<T, R>>;
@@ -26,16 +26,6 @@ type MutableAIState<AIState> = {
     update: (newState: ValueOrUpdater<AIState>) => void;
     done: ((newState: AIState) => void) | (() => void);
 };
-declare const __internal_curr: unique symbol;
-declare const __internal_error: unique symbol;
-/**
- * StreamableValue is a value that can be streamed over the network via AI Actions.
- * To read the streamed values, use the `readStreamableValue` or `useStreamableValue` APIs.
- */
-type StreamableValue<T = any, E = any> = {
-    [__internal_curr]?: T;
-    [__internal_error]?: E;
-};
 
 /**
  * Get the current AI state.
@@ -68,156 +58,45 @@ declare function getAIState<AI extends AIProvider = any>(key: keyof InferAIState
 declare function getMutableAIState<AI extends AIProvider = any>(): MutableAIState<InferAIState<AI, any>>;
 declare function getMutableAIState<AI extends AIProvider = any>(key: keyof InferAIState<AI, any>): MutableAIState<InferAIState<AI, any>[typeof key]>;
 
-type StreamableUIWrapper = {
-    /**
-     * The value of the streamable UI. This can be returned from a Server Action and received by the client.
-     */
-    readonly value: React.ReactNode;
+declare function createAI<AIState = any, UIState = any, Actions extends AIActions = {}>({ actions, initialAIState, initialUIState, onSetAIState, onGetUIState, }: {
+    actions: Actions;
+    initialAIState?: AIState;
+    initialUIState?: UIState;
     /**
-     * This method updates the current UI node. It takes a new UI node and replaces the old one.
+     * This function is called whenever the AI state is updated by an Action.
+     * You can use this to persist the AI state to a database, or to send it to a
+     * logging service.
      */
-    update(value: React.ReactNode): StreamableUIWrapper;
+    onSetAIState?: OnSetAIState<AIState>;
     /**
-     * This method is used to append a new UI node to the end of the old one.
-     * Once appended a new UI node, the previous UI node cannot be updated anymore.
-     *
-     * @example
-     * ```jsx
-     * const ui = createStreamableUI(<div>hello</div>)
-     * ui.append(<div>world</div>)
+     * This function is used to retrieve the UI state based on the AI state.
+     * For example, to render the initial UI state based on a given AI state, or
+     * to sync the UI state when the application is already loaded.
      *
-     * // The UI node will be:
-     * // <>
-     * //   <div>hello</div>
-     * //   <div>world</div>
-     * // </>
-     * ```
-     */
-    append(value: React.ReactNode): StreamableUIWrapper;
-    /**
-     * This method is used to signal that there is an error in the UI stream.
-     * It will be thrown on the client side and caught by the nearest error boundary component.
-     */
-    error(error: any): StreamableUIWrapper;
-    /**
-     * This method marks the UI node as finalized. You can either call it without any parameters or with a new UI node as the final state.
-     * Once called, the UI node cannot be updated or appended anymore.
+     * If returning `undefined`, the client side UI state will not be updated.
      *
-     * This method is always **required** to be called, otherwise the response will be stuck in a loading state.
-     */
-    done(...args: [React.ReactNode] | []): StreamableUIWrapper;
-};
-/**
- * Create a piece of changeable UI that can be streamed to the client.
- * On the client side, it can be rendered as a normal React node.
- */
-declare function createStreamableUI(initialValue?: React.ReactNode): StreamableUIWrapper;
-/**
- * Create a wrapped, changeable value that can be streamed to the client.
- * On the client side, the value can be accessed via the readStreamableValue() API.
- */
-declare function createStreamableValue<T = any, E = any>(initialValue?: T | ReadableStream<T>): StreamableValueWrapper<T, E>;
-type StreamableValueWrapper<T, E> = {
-    /**
-     * The value of the streamable. This can be returned from a Server Action and
-     * received by the client. To read the streamed values, use the
-     * `readStreamableValue` or `useStreamableValue` APIs.
-     */
-    readonly value: StreamableValue<T, E>;
-    /**
-     * This method updates the current value with a new one.
-     */
-    update(value: T): StreamableValueWrapper<T, E>;
-    /**
-     * This method is used to append a delta string to the current value. It
-     * requires the current value of the streamable to be a string.
+     * This function must be annotated with the `"use server"` directive.
      *
      * @example
-     * ```jsx
-     * const streamable = createStreamableValue('hello');
-     * streamable.append(' world');
+     * ```tsx
+     * onGetUIState: async () => {
+     *   'use server';
      *
-     * // The value will be 'hello world'
-     * ```
-     */
-    append(value: T): StreamableValueWrapper<T, E>;
-    /**
-     * This method is used to signal that there is an error in the value stream.
-     * It will be thrown on the client side when consumed via
-     * `readStreamableValue` or `useStreamableValue`.
-     */
-    error(error: any): StreamableValueWrapper<T, E>;
-    /**
-     * This method marks the value as finalized. You can either call it without
-     * any parameters or with a new value as the final state.
-     * Once called, the value cannot be updated or appended anymore.
+     *   const currentAIState = getAIState();
+     *   const externalAIState = await loadAIStateFromDatabase();
      *
-     * This method is always **required** to be called, otherwise the response
-     * will be stuck in a loading state.
-     */
-    done(...args: [T] | []): StreamableValueWrapper<T, E>;
-};
-
-type Streamable$1 = ReactNode | Promise<ReactNode>;
-type Renderer$1<T> = (props: T) => Streamable$1 | Generator<Streamable$1, Streamable$1, void> | AsyncGenerator<Streamable$1, Streamable$1, void>;
-/**
- * `render` is a helper function to create a streamable UI from some LLMs.
- * This API only supports OpenAI's GPT models with Function Calling and Assistants Tools,
- * please use `streamUI` for compatibility with other providers.
- *
- * @deprecated It's recommended to use the `streamUI` API for compatibility with AI SDK Core APIs
- * and future features. This API will be removed in a future release.
- */
-declare function render<TS extends {
-    [name: string]: z.Schema;
-} = {}, FS extends {
-    [name: string]: z.Schema;
-} = {}>(options: {
-    /**
-     * The model name to use. Must be OpenAI SDK compatible. Tools and Functions are only supported
-     * GPT models (3.5/4), OpenAI Assistants, Mistral small and large, and Fireworks firefunction-v1.
+     *   if (currentAIState === externalAIState) return undefined;
      *
-     * @example "gpt-3.5-turbo"
-     */
-    model: string;
-    /**
-     * The provider instance to use. Currently the only provider available is OpenAI.
-     * This needs to match the model name.
+     *   // Update current AI state and return the new UI state
+     *   const state = getMutableAIState()
+     *   state.done(externalAIState)
+     *
+     *   return <div>...</div>;
+     * }
+     * ```
      */
-    provider: OpenAI;
-    messages: Parameters<typeof OpenAI.prototype.chat.completions.create>[0]['messages'];
-    text?: Renderer$1<{
-        /**
-         * The full text content from the model so far.
-         */
-        content: string;
-        /**
-         * The new appended text content from the model since the last `text` call.
-         */
-        delta: string;
-        /**
-         * Whether the model is done generating text.
-         * If `true`, the `content` will be the final output and this call will be the last.
-         */
-        done: boolean;
-    }>;
-    tools?: {
-        [name in keyof TS]: {
-            description?: string;
-            parameters: TS[name];
-            render: Renderer$1<z.infer<TS[name]>>;
-        };
-    };
-    functions?: {
-        [name in keyof FS]: {
-            description?: string;
-            parameters: FS[name];
-            render: Renderer$1<z.infer<FS[name]>>;
-        };
-    };
-    initial?: ReactNode;
-    temperature?: number;
-}): ReactNode;
+    onGetUIState?: OnGetUIState<UIState>;
+}): AIProvider<AIState, UIState, Actions>;
 
 type CallSettings = {
     /**
@@ -486,12 +365,12 @@ type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | '
     toolName: keyof TOOLS;
 };
 
-type Streamable = ReactNode | Promise<ReactNode>;
-type Renderer<T extends Array<any>> = (...args: T) => Streamable | Generator<Streamable, Streamable, void> | AsyncGenerator<Streamable, Streamable, void>;
+type Streamable$1 = ReactNode | Promise<ReactNode>;
+type Renderer$1<T extends Array<any>> = (...args: T) => Streamable$1 | Generator<Streamable$1, Streamable$1, void> | AsyncGenerator<Streamable$1, Streamable$1, void>;
 type RenderTool<PARAMETERS extends z.ZodTypeAny = any> = {
     description?: string;
     parameters: PARAMETERS;
-    generate?: Renderer<[
+    generate?: Renderer$1<[
         z.infer<PARAMETERS>,
         {
             toolName: string;
@@ -499,7 +378,7 @@ type RenderTool<PARAMETERS extends z.ZodTypeAny = any> = {
         }
     ]>;
 };
-type RenderText = Renderer<[
+type RenderText = Renderer$1<[
     {
         /**
          * The full text content from the model so far.
@@ -573,44 +452,167 @@ declare function streamUI<TOOLS extends {
     }) => Promise<void> | void;
 }): Promise<RenderResult>;
 
-declare function createAI<AIState = any, UIState = any, Actions extends AIActions = {}>({ actions, initialAIState, initialUIState, onSetAIState, onGetUIState, }: {
-    actions: Actions;
-    initialAIState?: AIState;
-    initialUIState?: UIState;
+type Streamable = ReactNode | Promise<ReactNode>;
+type Renderer<T> = (props: T) => Streamable | Generator<Streamable, Streamable, void> | AsyncGenerator<Streamable, Streamable, void>;
+/**
+ * `render` is a helper function to create a streamable UI from some LLMs.
+ * This API only supports OpenAI's GPT models with Function Calling and Assistants Tools,
+ * please use `streamUI` for compatibility with other providers.
+ *
+ * @deprecated It's recommended to use the `streamUI` API for compatibility with AI SDK Core APIs
+ * and future features. This API will be removed in a future release.
+ */
+declare function render<TS extends {
+    [name: string]: z.Schema;
+} = {}, FS extends {
+    [name: string]: z.Schema;
+} = {}>(options: {
     /**
-     * This function is called whenever the AI state is updated by an Action.
-     * You can use this to persist the AI state to a database, or to send it to a
-     * logging service.
+     * The model name to use. Must be OpenAI SDK compatible. Tools and Functions are only supported
+     * GPT models (3.5/4), OpenAI Assistants, Mistral small and large, and Fireworks firefunction-v1.
+     *
+     * @example "gpt-3.5-turbo"
      */
-    onSetAIState?: OnSetAIState<AIState>;
+    model: string;
     /**
-     * This function is used to retrieve the UI state based on the AI state.
-     * For example, to render the initial UI state based on a given AI state, or
-     * to sync the UI state when the application is already loaded.
-     *
-     * If returning `undefined`, the client side UI state will not be updated.
-     *
-     * This function must be annotated with the `"use server"` directive.
+     * The provider instance to use. Currently the only provider available is OpenAI.
+     * This needs to match the model name.
+     */
+    provider: OpenAI;
+    messages: Parameters<typeof OpenAI.prototype.chat.completions.create>[0]['messages'];
+    text?: Renderer<{
+        /**
+         * The full text content from the model so far.
+         */
+        content: string;
+        /**
+         * The new appended text content from the model since the last `text` call.
+         */
+        delta: string;
+        /**
+         * Whether the model is done generating text.
+         * If `true`, the `content` will be the final output and this call will be the last.
+         */
+        done: boolean;
+    }>;
+    tools?: {
+        [name in keyof TS]: {
+            description?: string;
+            parameters: TS[name];
+            render: Renderer<z.infer<TS[name]>>;
+        };
+    };
+    functions?: {
+        [name in keyof FS]: {
+            description?: string;
+            parameters: FS[name];
+            render: Renderer<z.infer<FS[name]>>;
+        };
+    };
+    initial?: ReactNode;
+    temperature?: number;
+}): ReactNode;
+
+type StreamableUIWrapper = {
+    /**
+     * The value of the streamable UI. This can be returned from a Server Action and received by the client.
+     */
+    readonly value: React.ReactNode;
+    /**
+     * This method updates the current UI node. It takes a new UI node and replaces the old one.
+     */
+    update(value: React.ReactNode): StreamableUIWrapper;
+    /**
+     * This method is used to append a new UI node to the end of the old one.
+     * Once appended a new UI node, the previous UI node cannot be updated anymore.
      *
      * @example
-     * ```tsx
-     * onGetUIState: async () => {
-     *   'use server';
+     * ```jsx
+     * const ui = createStreamableUI(<div>hello</div>)
+     * ui.append(<div>world</div>)
      *
-     *   const currentAIState = getAIState();
-     *   const externalAIState = await loadAIStateFromDatabase();
+     * // The UI node will be:
+     * // <>
+     * //   <div>hello</div>
+     * //   <div>world</div>
+     * // </>
+     * ```
+     */
+    append(value: React.ReactNode): StreamableUIWrapper;
+    /**
+     * This method is used to signal that there is an error in the UI stream.
+     * It will be thrown on the client side and caught by the nearest error boundary component.
+     */
+    error(error: any): StreamableUIWrapper;
+    /**
+     * This method marks the UI node as finalized. You can either call it without any parameters or with a new UI node as the final state.
+     * Once called, the UI node cannot be updated or appended anymore.
      *
-     *   if (currentAIState === externalAIState) return undefined;
+     * This method is always **required** to be called, otherwise the response will be stuck in a loading state.
+     */
+    done(...args: [React.ReactNode] | []): StreamableUIWrapper;
+};
+/**
+ * Create a piece of changeable UI that can be streamed to the client.
+ * On the client side, it can be rendered as a normal React node.
+ */
+declare function createStreamableUI(initialValue?: React.ReactNode): StreamableUIWrapper;
+
+declare const __internal_curr: unique symbol;
+declare const __internal_error: unique symbol;
+/**
+ * StreamableValue is a value that can be streamed over the network via AI Actions.
+ * To read the streamed values, use the `readStreamableValue` or `useStreamableValue` APIs.
+ */
+type StreamableValue<T = any, E = any> = {
+    [__internal_curr]?: T;
+    [__internal_error]?: E;
+};
+
+/**
+ * Create a wrapped, changeable value that can be streamed to the client.
+ * On the client side, the value can be accessed via the readStreamableValue() API.
+ */
+declare function createStreamableValue<T = any, E = any>(initialValue?: T | ReadableStream<T>): StreamableValueWrapper<T, E>;
+type StreamableValueWrapper<T, E> = {
+    /**
+     * The value of the streamable. This can be returned from a Server Action and
+     * received by the client. To read the streamed values, use the
+     * `readStreamableValue` or `useStreamableValue` APIs.
+     */
+    readonly value: StreamableValue<T, E>;
+    /**
+     * This method updates the current value with a new one.
+     */
+    update(value: T): StreamableValueWrapper<T, E>;
+    /**
+     * This method is used to append a delta string to the current value. It
+     * requires the current value of the streamable to be a string.
      *
-     *   // Update current AI state and return the new UI state
-     *   const state = getMutableAIState()
-     *   state.done(externalAIState)
+     * @example
+     * ```jsx
+     * const streamable = createStreamableValue('hello');
+     * streamable.append(' world');
      *
-     *   return <div>...</div>;
-     * }
+     * // The value will be 'hello world'
      * ```
      */
-    onGetUIState?: OnGetUIState<UIState>;
-}): AIProvider<AIState, UIState, Actions>;
+    append(value: T): StreamableValueWrapper<T, E>;
+    /**
+     * This method is used to signal that there is an error in the value stream.
+     * It will be thrown on the client side when consumed via
+     * `readStreamableValue` or `useStreamableValue`.
+     */
+    error(error: any): StreamableValueWrapper<T, E>;
+    /**
+     * This method marks the value as finalized. You can either call it without
+     * any parameters or with a new value as the final state.
+     * Once called, the value cannot be updated or appended anymore.
+     *
+     * This method is always **required** to be called, otherwise the response
+     * will be stuck in a loading state.
+     */
+    done(...args: [T] | []): StreamableValueWrapper<T, E>;
+};
 
 export { createAI, createStreamableUI, createStreamableValue, getAIState, getMutableAIState, render, streamUI };