ai 3.0.18 → 3.0.20

package/dist/index.d.ts

@@ -1,10 +1,29 @@
 import { z } from 'zod';
+import { JSONSchema7 } from 'json-schema';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
 import { ChatCompletionResponseChunk } from '@mistralai/mistralai';
 import { ServerResponse } from 'node:http';
 
-type JsonSchema = Record<string, unknown>;
+/**
+A tool has a name, a description, and a set of parameters.
+
+Note: this is **not** the user-facing tool definition. The AI SDK methods will
+map the user-facing tool definitions to this format.
+ */
+type LanguageModelV1FunctionTool = {
+    /**
+  The type of the tool. Only functions for now, but this gives us room to
+  add more specific tool types in the future and use a discriminated union.
+     */
+    type: 'function';
+    /**
+  The name of the tool. Unique within this model call.
+     */
+    name: string;
+    description?: string;
+    parameters: JSONSchema7;
+};
 
 type LanguageModelV1CallSettings = {
     /**
@@ -61,33 +80,13 @@ type LanguageModelV1CallSettings = {
 };
 
 /**
- * A tool has a name, a description, and a set of parameters.
- *
- * Note: this is **not** the user-facing tool definition. The AI SDK methods will
- * map the user-facing tool definitions to this format.
- */
-type LanguageModelV1FunctionTool = {
-    /**
-     * The type of the tool. Only functions for now, but this gives us room to
-     * add more specific tool types in the future and use a discriminated union.
-     */
-    type: 'function';
-    /**
-     * The name of the tool. Unique within this model call.
-     */
-    name: string;
-    description?: string;
-    parameters: JsonSchema;
-};
+A prompt is a list of messages.
 
-/**
- * A prompt is a list of messages.
- *
- * Note: Not all models and prompt formats support multi-modal inputs and
- * tool calls. The validation happens at runtime.
- *
- * Note: This is not a user-facing prompt. The AI SDK methods will map the
- * user-facing prompt types such as chat or instruction prompts to this format.
+Note: Not all models and prompt formats support multi-modal inputs and
+tool calls. The validation happens at runtime.
+
+Note: This is not a user-facing prompt. The AI SDK methods will map the
+user-facing prompt types such as chat or instruction prompts to this format.
  */
 type LanguageModelV1Prompt = Array<LanguageModelV1Message>;
 type LanguageModelV1Message = {
@@ -103,35 +102,69 @@ type LanguageModelV1Message = {
     role: 'tool';
     content: Array<LanguageModelV1ToolResultPart>;
 };
+/**
+Text content part of a prompt. It contains a string of text.
+ */
 interface LanguageModelV1TextPart {
     type: 'text';
     /**
-     * The text content.
+  The text content.
      */
     text: string;
 }
+/**
+Image content part of a prompt. It contains an image.
+ */
 interface LanguageModelV1ImagePart {
     type: 'image';
     /**
-     * Image data as a Uint8Array (e.g. from a Blob or Buffer) or a URL.
+  Image data as a Uint8Array (e.g. from a Blob or Buffer) or a URL.
      */
     image: Uint8Array | URL;
     /**
-     * Optional mime type of the image.
+  Optional mime type of the image.
      */
     mimeType?: string;
 }
+/**
+Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
+ */
 interface LanguageModelV1ToolCallPart {
     type: 'tool-call';
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
     toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
     toolName: string;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
     args: unknown;
 }
+/**
+Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
+ */
 interface LanguageModelV1ToolResultPart {
     type: 'tool-result';
+    /**
+  ID of the tool call that this result is associated with.
+   */
     toolCallId: string;
+    /**
+  Name of the tool that generated this result.
+    */
     toolName: string;
+    /**
+  Result of the tool call. This is a JSON-serializable object.
+     */
     result: unknown;
+    /**
+  Optional flag if the result is an error or an error message.
+     */
+    isError?: boolean;
 }
 
 type LanguageModelV1CallOptions = LanguageModelV1CallSettings & {
@@ -157,7 +190,7 @@ type LanguageModelV1CallOptions = LanguageModelV1CallSettings & {
         type: 'object-json';
     } | {
         type: 'object-grammar';
-        schema: JsonSchema;
+        schema: JSONSchema7;
     } | {
         type: 'object-tool';
         tool: LanguageModelV1FunctionTool;
@@ -471,6 +504,10 @@ interface ToolResultPart {
   Result of the tool call. This is a JSON-serializable object.
      */
     result: unknown;
+    /**
+  Optional flag if the result is an error or an error message.
+     */
+    isError?: boolean;
 }
 
 /**
@@ -784,6 +821,7 @@ type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType>
 
 type ToToolCall<TOOLS extends Record<string, ExperimentalTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
+        type: 'tool-call';
         toolCallId: string;
         toolName: NAME & string;
         args: z.infer<TOOLS[NAME]['parameters']>;
@@ -801,6 +839,7 @@ type ToToolsWithDefinedExecute<TOOLS extends Record<string, ExperimentalTool>> =
 };
 type ToToolResultObject<TOOLS extends Record<string, ExperimentalTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
+        type: 'tool-result';
         toolCallId: string;
         toolName: NAME & string;
         args: z.infer<TOOLS[NAME]['parameters']>;
@@ -1349,10 +1388,6 @@ declare function createChunkDecoder(complex?: boolean): (chunk: Uint8Array | und
 
 declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n`;
 type StreamString = `${(typeof StreamStringPrefixes)[keyof typeof StreamStringPrefixes]}:${string}\n`;
-/**
- * A header sent to the client so it knows how to handle parsing the stream (as a deprecated text response or using the new prefixed protocol)
- */
-declare const COMPLEX_HEADER = "X-Experimental-Stream-Data";
 
 declare interface AzureChatCompletions {
     id: string;
@@ -1606,10 +1641,8 @@ interface AIStreamCallbacksAndOptions {
     /** `onText`: Called for each text chunk. */
     onText?: (text: string) => Promise<void> | void;
     /**
-     * A flag for enabling the experimental_StreamData class and the new protocol.
-     * @see https://github.com/vercel-labs/ai/pull/425
-     *
-     * When StreamData is rolled out, this will be removed and the new protocol will be used by default.
+     * @deprecated This flag is no longer used and only retained for backwards compatibility.
+     * You can remove it from your code.
      */
     experimental_streamData?: boolean;
 }
@@ -1796,18 +1829,54 @@ interface MessageStopEvent {
  */
 declare function AnthropicStream(res: Response | AsyncIterable<CompletionChunk> | AsyncIterable<MessageStreamEvent>, cb?: AIStreamCallbacksAndOptions): ReadableStream;
 
+/**
+You can pass the thread and the latest message into the `AssistantResponse`. This establishes the context for the response.
+ */
 type AssistantResponseSettings = {
+    /**
+  The thread ID that the response is associated with.
+     */
     threadId: string;
+    /**
+  The ID of the latest message that the response is associated with.
+   */
     messageId: string;
 };
+/**
+The process parameter is a callback in which you can run the assistant on threads, and send messages and data messages to the client.
+ */
 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;
+    /**
+  Send a data message to the client. You can use this to provide information for rendering custom UIs while the assistant is processing the thread.
+   */
     sendDataMessage: (message: DataMessage) => void;
+    /**
+  Forwards the assistant response stream to the client. Returns the `Run` object after it completes, or when it requires an action.
+     */
     forwardStream: (stream: AssistantStream) => Promise<Run | undefined>;
 }) => Promise<void>;
-declare function experimental_AssistantResponse({ threadId, messageId }: AssistantResponseSettings, process: AssistantResponseCallback): Response;
+/**
+The `AssistantResponse` allows you to send a stream of assistant update to `useAssistant`.
+It is designed to facilitate streaming assistant responses to the `useAssistant` hook.
+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;
 
 interface AWSBedrockResponse {
     body?: AsyncIterable<{
@@ -1932,7 +2001,7 @@ declare function ReplicateStream(res: Prediction, cb?: AIStreamCallbacksAndOptio
 /**
  * A stream wrapper to send custom JSON-encoded data back to the client.
  */
-declare class experimental_StreamData {
+declare class StreamData {
     private encoder;
     private controller;
     stream: TransformStream<Uint8Array, Uint8Array>;
@@ -1950,7 +2019,12 @@ declare class experimental_StreamData {
  * A TransformStream for LLMs that do not have their own transform stream handlers managing encoding (e.g. OpenAIStream has one for function call handling).
  * This assumes every chunk is a 'text' chunk.
  */
-declare function createStreamDataTransformer(experimental_streamData: boolean | undefined): TransformStream<any, any>;
+declare function createStreamDataTransformer(): TransformStream<any, any>;
+/**
+@deprecated Use `StreamData` instead.
+ */
+declare class experimental_StreamData extends StreamData {
+}
 
 /**
  * This is a naive implementation of the streaming React response API.
@@ -1979,7 +2053,7 @@ declare class experimental_StreamingReactResponse {
             content: string;
             data?: JSONValue[];
         }) => UINode | Promise<UINode>;
-        data?: experimental_StreamData;
+        data?: StreamData;
         generateId?: IdGenerator;
     });
 }
@@ -1988,7 +2062,7 @@ declare class experimental_StreamingReactResponse {
  * A utility class for streaming text responses.
  */
 declare class StreamingTextResponse extends Response {
-    constructor(res: ReadableStream, init?: ResponseInit, data?: experimental_StreamData);
+    constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);
 }
 /**
  * A utility function to stream a ReadableStream to a Node.js response-like object.
@@ -1998,4 +2072,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, COMPLEX_HEADER, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, DataContent, DataMessage, DeepPartial, ErrorStreamPart, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, Function, FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, LangChainStream, Message$1 as Message, MistralStream, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamObjectResult, 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, generateId, isStreamStringEqualToType, generateId as nanoid, readableFromAsyncIterable, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, DataContent, DataMessage, DeepPartial, ErrorStreamPart, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, Function, FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, LangChainStream, Message$1 as Message, MistralStream, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, 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, generateId, isStreamStringEqualToType, generateId as nanoid, readableFromAsyncIterable, streamToResponse, tool, trimStartOfStreamHelper };