ai 3.0.19 → 3.0.21

package/dist/index.d.ts

@@ -1,328 +1,10 @@
+import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1CallWarning } from '@ai-sdk/provider';
 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';
 
-/**
-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 = {
-    /**
-     * Maximum number of tokens to generate.
-     */
-    maxTokens?: number;
-    /**
-     * Temperature setting. This is a number between 0 (almost no randomness) and
-     * 1 (very random).
-     *
-     * Different LLM providers have different temperature
-     * scales, so they'd need to map it (without mapping, the same temperature has
-     * different effects on different models). The provider can also chose to map
-     * this to topP, potentially even using a custom setting on their model.
-     *
-     * Note: This is an example of a setting that requires a clear specification of
-     * the semantics.
-     */
-    temperature?: number;
-    /**
-     * Nucleus sampling. This is a number between 0 and 1.
-     *
-     * E.g. 0.1 would mean that only tokens with the top 10% probability mass
-     * are considered.
-     *
-     * It is recommended to set either `temperature` or `topP`, but not both.
-     */
-    topP?: number;
-    /**
-     * Presence penalty setting. It affects the likelihood of the model to
-     * repeat information that is already in the prompt.
-     *
-     * The presence penalty is a number between -1 (increase repetition)
-     * and 1 (maximum penalty, decrease repetition). 0 means no penalty.
-     */
-    presencePenalty?: number;
-    /**
-     * Frequency penalty setting. It affects the likelihood of the model
-     * to repeatedly use the same words or phrases.
-     *
-     * The frequency penalty is a number between -1 (increase repetition)
-     * and 1 (maximum penalty, decrease repetition). 0 means no penalty.
-     */
-    frequencyPenalty?: number;
-    /**
-     * The seed (integer) to use for random sampling. If set and supported
-     * by the model, calls will generate deterministic results.
-     */
-    seed?: number;
-    /**
-     * Abort signal for cancelling the operation.
-     */
-    abortSignal?: AbortSignal;
-};
-
-/**
- * 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.
- */
-type LanguageModelV1Prompt = Array<LanguageModelV1Message>;
-type LanguageModelV1Message = {
-    role: 'system';
-    content: string;
-} | {
-    role: 'user';
-    content: Array<LanguageModelV1TextPart | LanguageModelV1ImagePart>;
-} | {
-    role: 'assistant';
-    content: Array<LanguageModelV1TextPart | LanguageModelV1ToolCallPart>;
-} | {
-    role: 'tool';
-    content: Array<LanguageModelV1ToolResultPart>;
-};
-interface LanguageModelV1TextPart {
-    type: 'text';
-    /**
-     * The text content.
-     */
-    text: string;
-}
-interface LanguageModelV1ImagePart {
-    type: 'image';
-    /**
-     * Image data as a Uint8Array (e.g. from a Blob or Buffer) or a URL.
-     */
-    image: Uint8Array | URL;
-    /**
-     * Optional mime type of the image.
-     */
-    mimeType?: string;
-}
-interface LanguageModelV1ToolCallPart {
-    type: 'tool-call';
-    toolCallId: string;
-    toolName: string;
-    args: unknown;
-}
-interface LanguageModelV1ToolResultPart {
-    type: 'tool-result';
-    toolCallId: string;
-    toolName: string;
-    result: unknown;
-}
-
-type LanguageModelV1CallOptions = LanguageModelV1CallSettings & {
-    /**
-     * Whether the user provided the input as messages or as
-     * a prompt. This can help guide non-chat models in the
-     * expansion, bc different expansions can be needed for
-     * chat/non-chat use cases.
-     */
-    inputFormat: 'messages' | 'prompt';
-    /**
-     * The mode affects the behavior of the language model. It is required to
-     * support provider-independent streaming and generation of structured objects.
-     * The model can take this information and e.g. configure json mode, the correct
-     * low level grammar, etc. It can also be used to optimize the efficiency of the
-     * streaming, e.g. tool-delta stream parts are only needed in the
-     * object-tool mode.
-     */
-    mode: {
-        type: 'regular';
-        tools?: Array<LanguageModelV1FunctionTool>;
-    } | {
-        type: 'object-json';
-    } | {
-        type: 'object-grammar';
-        schema: JSONSchema7;
-    } | {
-        type: 'object-tool';
-        tool: LanguageModelV1FunctionTool;
-    };
-    /**
-     * A language mode prompt is a standardized prompt type.
-     *
-     * Note: This is **not** the user-facing prompt. The AI SDK methods will map the
-     * user-facing prompt types such as chat or instruction prompts to this format.
-     * That approach allows us to evolve the user  facing prompts without breaking
-     * the language model interface.
-     */
-    prompt: LanguageModelV1Prompt;
-};
-
-/**
- * Warning from the model provider for this call. The call will proceed, but e.g.
- * some settings might not be supported, which can lead to suboptimal results.
- */
-type LanguageModelV1CallWarning = {
-    type: 'unsupported-setting';
-    setting: keyof LanguageModelV1CallSettings;
-} | {
-    type: 'other';
-    message: string;
-};
-
-type LanguageModelV1FinishReason = 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other';
-
-type LanguageModelV1FunctionToolCall = {
-    toolCallType: 'function';
-    toolCallId: string;
-    toolName: string;
-    /**
-     * Stringified JSON object with the tool call arguments. Must match the
-     * parameters schema of the tool.
-     */
-    args: string;
-};
-
-/**
- * Experimental: Specification for a language model that implements the language model
- * interface version 1.
- */
-type LanguageModelV1 = {
-    /**
-     * The language model must specify which language model interface
-     * version it implements. This will allow us to evolve the language
-     * model interface and retain backwards compatibility. The different
-     * implementation versions can be handled as a discriminated union
-     * on our side.
-     */
-    readonly specificationVersion: 'v1';
-    /**
-     * Name of the provider for logging purposes.
-     */
-    readonly provider: string;
-    /**
-     * Provider-specific model ID for logging purposes.
-     */
-    readonly modelId: string;
-    /**
-     * Default object generation mode that should be used with this model when
-     * no mode is specified. Should be the mode with the best results for this
-     * model. `undefined` can be returned if object generation is not supported.
-     *
-     * This is needed to generate the best objects possible w/o requiring the
-     * user to explicitly specify the object generation mode.
-     */
-    readonly defaultObjectGenerationMode: 'json' | 'tool' | 'grammar' | undefined;
-    /**
-     * Generates a language model output (non-streaming).
-     *
-     * Naming: "do" prefix to prevent accidental direct usage of the method
-     * by the user.
-     */
-    doGenerate(options: LanguageModelV1CallOptions): PromiseLike<{
-        /**
-         * Text that the model has generated. Can be undefined if the model
-         * has only generated tool calls.
-         */
-        text?: string;
-        /**
-         * Tool calls that the model has generated. Can be undefined if the
-         * model has only generated text.
-         */
-        toolCalls?: Array<LanguageModelV1FunctionToolCall>;
-        /**
-         * Finish reason.
-         */
-        finishReason: LanguageModelV1FinishReason;
-        /**
-         * Usage information.
-         */
-        usage: {
-            promptTokens: number;
-            completionTokens: number;
-        };
-        /**
-         * Raw prompt and setting information for observability provider integration.
-         */
-        rawCall: {
-            /**
-             * Raw prompt after expansion and conversion to the format that the
-             * provider uses to send the information to their API.
-             */
-            rawPrompt: unknown;
-            /**
-             * Raw settings that are used for the API call. Includes provider-specific
-             * settings.
-             */
-            rawSettings: Record<string, unknown>;
-        };
-        warnings?: LanguageModelV1CallWarning[];
-    }>;
-    /**
-     * Generates a language model output (streaming).
-     *
-     * Naming: "do" prefix to prevent accidental direct usage of the method
-     * by the user.
-     *
-     * @return A stream of higher-level language model output parts.
-     */
-    doStream(options: LanguageModelV1CallOptions): PromiseLike<{
-        stream: ReadableStream<LanguageModelV1StreamPart>;
-        /**
-         * Raw prompt and setting information for observability provider integration.
-         */
-        rawCall: {
-            /**
-             * Raw prompt after expansion and conversion to the format that the
-             * provider uses to send the information to their API.
-             */
-            rawPrompt: unknown;
-            /**
-             * Raw settings that are used for the API call. Includes provider-specific
-             * settings.
-             */
-            rawSettings: Record<string, unknown>;
-        };
-        warnings?: LanguageModelV1CallWarning[];
-    }>;
-};
-type LanguageModelV1StreamPart = {
-    type: 'text-delta';
-    textDelta: string;
-} | ({
-    type: 'tool-call';
-} & LanguageModelV1FunctionToolCall) | {
-    type: 'tool-call-delta';
-    toolCallType: 'function';
-    toolCallId: string;
-    toolName: string;
-    argsTextDelta: string;
-} | {
-    type: 'finish';
-    finishReason: LanguageModelV1FinishReason;
-    usage: {
-        promptTokens: number;
-        completionTokens: number;
-    };
-} | {
-    type: 'error';
-    error: unknown;
-};
-
 type TokenUsage = {
     promptTokens: number;
     completionTokens: number;
@@ -470,6 +152,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;
 }
 
 /**
@@ -997,6 +683,12 @@ declare class StreamTextResult<TOOLS extends Record<string, ExperimentalTool>> {
   @returns an `AIStream` object.
      */
     toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
+    /**
+  Creates a simple text stream response.
+  Each text delta is encoded as UTF-8 and sent as a separate chunk.
+  Non-text-delta events are ignored.
+     */
+    toTextStreamResponse(init?: ResponseInit): Response;
 }
 
 interface FunctionCall {
@@ -1350,10 +1042,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;
@@ -1607,10 +1295,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;
 }
@@ -1797,18 +1483,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<{
@@ -1933,7 +1655,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>;
@@ -1951,7 +1673,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.
@@ -1980,7 +1707,7 @@ declare class experimental_StreamingReactResponse {
             content: string;
             data?: JSONValue[];
         }) => UINode | Promise<UINode>;
-        data?: experimental_StreamData;
+        data?: StreamData;
         generateId?: IdGenerator;
     });
 }
@@ -1989,7 +1716,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.
@@ -1999,4 +1726,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 };