ai 3.1.0-canary.2 → 3.1.0-canary.4

package/README.md

@@ -26,7 +26,7 @@ This library is created by [Vercel](https://vercel.com) and [Next.js](https://ne
 - Shu Ding ([@shuding\_](https://twitter.com/shuding_)) - [Vercel](https://vercel.com)
 - Max Leiter ([@max_leiter](https://twitter.com/max_leiter)) - [Vercel](https://vercel.com)
 - Malte Ubl ([@cramforce](https://twitter.com/cramforce)) - [Vercel](https://vercel.com)
-- Justin Ridgewell ([@jridgewell](https://github.com/jridgewell)) - [Vercel](https://vercel.com)
+- Justin Ridgewell ([@jridgewell](https://github.com/jridgewell))
 
 [Contributors](https://github.com/vercel/ai/graphs/contributors)
 

package/ai-model-specification/dist/index.d.mts

@@ -1,24 +1,7 @@
 import * as zod from 'zod';
 import { ZodSchema } from 'zod';
 
-declare class AI_InvalidArgumentError extends Error {
-    readonly parameter: string;
-    readonly value: unknown;
-    constructor({ parameter, value, message, }: {
-        parameter: string;
-        value: unknown;
-        message: string;
-    });
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        parameter: string;
-        value: unknown;
-    };
-}
-
-declare class ApiCallError extends Error {
+declare class APICallError extends Error {
     readonly url: string;
     readonly requestBodyValues: unknown;
     readonly statusCode?: number;
@@ -26,7 +9,8 @@ declare class ApiCallError extends Error {
     readonly cause?: unknown;
     readonly isRetryable: boolean;
     readonly data?: unknown;
-    constructor({ message, url, requestBodyValues, statusCode, responseBody, cause, isRetryable, data, }: {
+    constructor({ message, url, requestBodyValues, statusCode, responseBody, cause, isRetryable, // server error
+    data, }: {
         message: string;
         url: string;
         requestBodyValues: unknown;
@@ -36,6 +20,7 @@ declare class ApiCallError extends Error {
         isRetryable?: boolean;
         data?: unknown;
     });
+    static isAPICallError(error: unknown): error is APICallError;
     toJSON(): {
         name: string;
         message: string;
@@ -49,6 +34,60 @@ declare class ApiCallError extends Error {
     };
 }
 
+declare class InvalidArgumentError extends Error {
+    readonly parameter: string;
+    readonly value: unknown;
+    constructor({ parameter, value, message, }: {
+        parameter: string;
+        value: unknown;
+        message: string;
+    });
+    static isInvalidArgumentError(error: unknown): error is InvalidArgumentError;
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        parameter: string;
+        value: unknown;
+    };
+}
+
+declare class InvalidPromptError extends Error {
+    readonly prompt: unknown;
+    constructor({ prompt, message }: {
+        prompt: unknown;
+        message: string;
+    });
+    static isInvalidPromptError(error: unknown): error is InvalidPromptError;
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        prompt: unknown;
+    };
+}
+
+declare class InvalidToolArgumentsError extends Error {
+    readonly toolName: string;
+    readonly toolArgs: string;
+    readonly cause: unknown;
+    constructor({ toolArgs, toolName, cause, message, }: {
+        message?: string;
+        toolArgs: string;
+        toolName: string;
+        cause: unknown;
+    });
+    static isInvalidToolArgumentsError(error: unknown): error is InvalidToolArgumentsError;
+    toJSON(): {
+        name: string;
+        message: string;
+        cause: unknown;
+        stack: string | undefined;
+        toolName: string;
+        toolArgs: string;
+    };
+}
+
 declare class JSONParseError extends Error {
     readonly text: string;
     readonly cause: unknown;
@@ -56,6 +95,7 @@ declare class JSONParseError extends Error {
         text: string;
         cause: unknown;
     });
+    static isJSONParseError(error: unknown): error is JSONParseError;
     toJSON(): {
         name: string;
         message: string;
@@ -69,6 +109,7 @@ declare class LoadAPIKeyError extends Error {
     constructor({ message }: {
         message: string;
     });
+    static isLoadAPIKeyError(error: unknown): error is LoadAPIKeyError;
     toJSON(): {
         name: string;
         message: string;
@@ -78,6 +119,7 @@ declare class LoadAPIKeyError extends Error {
 declare class NoTextGeneratedError extends Error {
     readonly cause: unknown;
     constructor();
+    static isNoTextGeneratedError(error: unknown): error is NoTextGeneratedError;
     toJSON(): {
         name: string;
         cause: unknown;
@@ -86,6 +128,41 @@ declare class NoTextGeneratedError extends Error {
     };
 }
 
+declare class NoSuchToolError extends Error {
+    readonly toolName: string;
+    constructor({ message, toolName }: {
+        message: string;
+        toolName: string;
+    });
+    static isNoSuchToolError(error: unknown): error is NoSuchToolError;
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        toolName: string;
+    };
+}
+
+type RetryErrorReason = 'maxRetriesExceeded' | 'errorNotRetryable' | 'abort';
+declare class RetryError extends Error {
+    readonly reason: RetryErrorReason;
+    readonly lastError: unknown;
+    readonly errors: Array<unknown>;
+    constructor({ message, reason, errors, }: {
+        message: string;
+        reason: RetryErrorReason;
+        errors: Array<unknown>;
+    });
+    static isRetryError(error: unknown): error is RetryError;
+    toJSON(): {
+        name: string;
+        message: string;
+        reason: RetryErrorReason;
+        lastError: unknown;
+        errors: unknown[];
+    };
+}
+
 declare class TypeValidationError extends Error {
     readonly value: unknown;
     readonly cause: unknown;
@@ -93,6 +170,7 @@ declare class TypeValidationError extends Error {
         value: unknown;
         cause: unknown;
     });
+    static isTypeValidationError(error: unknown): error is TypeValidationError;
     toJSON(): {
         name: string;
         message: string;
@@ -109,6 +187,7 @@ declare class UnsupportedFunctionalityError extends Error {
         provider: string;
         functionality: string;
     });
+    static isUnsupportedFunctionalityError(error: unknown): error is UnsupportedFunctionalityError;
     toJSON(): {
         name: string;
         message: string;
@@ -168,6 +247,10 @@ type LanguageModelV1CallSettings = {
      * by the model, calls will generate deterministic results.
      */
     seed?: number;
+    /**
+     * Abort signal for cancelling the operation.
+     */
+    abortSignal?: AbortSignal;
 };
 
 /**
@@ -223,9 +306,9 @@ interface LanguageModelV1TextPart {
 interface LanguageModelV1ImagePart {
     type: 'image';
     /**
-     * Image data as a Uint8Array.
+     * Image data as a Uint8Array (e.g. from a Blob or Buffer) or a URL.
      */
-    image: Uint8Array;
+    image: Uint8Array | URL;
     /**
      * Optional mime type of the image.
      */
@@ -351,6 +434,32 @@ type LanguageModelV1 = {
          * 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[];
     }>;
     /**
@@ -363,6 +472,21 @@ type LanguageModelV1 = {
      */
     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[];
     }>;
 };
@@ -388,6 +512,8 @@ type LanguageModelV1StreamPart = {
     error: unknown;
 };
 
+declare function getErrorMessage(error: unknown | undefined): string;
+
 declare function loadApiKey({ apiKey, environmentVariableName, apiKeyParameterName, description, }: {
     apiKey: string | undefined;
     environmentVariableName: string;
@@ -468,21 +594,21 @@ declare const createJsonErrorResponseHandler: <T>({ errorSchema, errorToMessage,
     errorSchema: ZodSchema<T, zod.ZodTypeDef, T>;
     errorToMessage: (error: T) => string;
     isRetryable?: ((response: Response, error?: T | undefined) => boolean) | undefined;
-}) => ResponseHandler<ApiCallError>;
+}) => ResponseHandler<APICallError>;
 declare const createEventSourceResponseHandler: <T>(chunkSchema: ZodSchema<T, zod.ZodTypeDef, T>) => ResponseHandler<ReadableStream<ParsedChunk<T>>>;
 declare const createJsonResponseHandler: <T>(responseSchema: ZodSchema<T, zod.ZodTypeDef, T>) => ResponseHandler<T>;
 
 declare const postJsonToApi: <T>({ url, headers, body, failedResponseHandler, successfulResponseHandler, abortSignal, }: {
     url: string;
-    headers?: Record<string, string> | undefined;
+    headers?: Record<string, string | undefined> | undefined;
     body: unknown;
-    failedResponseHandler: ResponseHandler<ApiCallError>;
+    failedResponseHandler: ResponseHandler<APICallError>;
     successfulResponseHandler: ResponseHandler<T>;
     abortSignal?: AbortSignal | undefined;
 }) => Promise<T>;
 declare const postToApi: <T>({ url, headers, body, successfulResponseHandler, failedResponseHandler, abortSignal, }: {
     url: string;
-    headers?: Record<string, string> | undefined;
+    headers?: Record<string, string | undefined> | undefined;
     body: {
         content: string | FormData | Uint8Array;
         values: unknown;
@@ -536,4 +662,4 @@ declare function safeValidateTypes<T>({ value, schema, }: {
     error: TypeValidationError;
 };
 
-export { AI_InvalidArgumentError, ApiCallError, JSONParseError, LanguageModelV1, LanguageModelV1CallWarning, LanguageModelV1FunctionTool, LanguageModelV1FunctionToolCall, LanguageModelV1ImagePart, LanguageModelV1Message, LanguageModelV1Prompt, LanguageModelV1StreamPart, LanguageModelV1TextPart, LanguageModelV1ToolCallPart, LanguageModelV1ToolResultPart, LoadAPIKeyError, NoTextGeneratedError, ParsedChunk, ResponseHandler, TypeValidationError, UnsupportedFunctionalityError, convertBase64ToUint8Array, convertUint8ArrayToBase64, createEventSourceResponseHandler, createJsonErrorResponseHandler, createJsonResponseHandler, isParseableJson, loadApiKey, parseJSON, postJsonToApi, postToApi, safeParseJSON, safeValidateTypes, scale, validateTypes };
+export { APICallError, InvalidArgumentError, InvalidPromptError, InvalidToolArgumentsError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1CallWarning, LanguageModelV1FinishReason, LanguageModelV1FunctionTool, LanguageModelV1FunctionToolCall, LanguageModelV1ImagePart, LanguageModelV1Message, LanguageModelV1Prompt, LanguageModelV1StreamPart, LanguageModelV1TextPart, LanguageModelV1ToolCallPart, LanguageModelV1ToolResultPart, LoadAPIKeyError, NoSuchToolError, NoTextGeneratedError, ParsedChunk, ResponseHandler, RetryError, RetryErrorReason, TypeValidationError, UnsupportedFunctionalityError, convertBase64ToUint8Array, convertUint8ArrayToBase64, createEventSourceResponseHandler, createJsonErrorResponseHandler, createJsonResponseHandler, getErrorMessage, isParseableJson, loadApiKey, parseJSON, postJsonToApi, postToApi, safeParseJSON, safeValidateTypes, scale, validateTypes };

package/ai-model-specification/dist/index.d.ts

@@ -1,24 +1,7 @@
 import * as zod from 'zod';
 import { ZodSchema } from 'zod';
 
-declare class AI_InvalidArgumentError extends Error {
-    readonly parameter: string;
-    readonly value: unknown;
-    constructor({ parameter, value, message, }: {
-        parameter: string;
-        value: unknown;
-        message: string;
-    });
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        parameter: string;
-        value: unknown;
-    };
-}
-
-declare class ApiCallError extends Error {
+declare class APICallError extends Error {
     readonly url: string;
     readonly requestBodyValues: unknown;
     readonly statusCode?: number;
@@ -26,7 +9,8 @@ declare class ApiCallError extends Error {
     readonly cause?: unknown;
     readonly isRetryable: boolean;
     readonly data?: unknown;
-    constructor({ message, url, requestBodyValues, statusCode, responseBody, cause, isRetryable, data, }: {
+    constructor({ message, url, requestBodyValues, statusCode, responseBody, cause, isRetryable, // server error
+    data, }: {
         message: string;
         url: string;
         requestBodyValues: unknown;
@@ -36,6 +20,7 @@ declare class ApiCallError extends Error {
         isRetryable?: boolean;
         data?: unknown;
     });
+    static isAPICallError(error: unknown): error is APICallError;
     toJSON(): {
         name: string;
         message: string;
@@ -49,6 +34,60 @@ declare class ApiCallError extends Error {
     };
 }
 
+declare class InvalidArgumentError extends Error {
+    readonly parameter: string;
+    readonly value: unknown;
+    constructor({ parameter, value, message, }: {
+        parameter: string;
+        value: unknown;
+        message: string;
+    });
+    static isInvalidArgumentError(error: unknown): error is InvalidArgumentError;
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        parameter: string;
+        value: unknown;
+    };
+}
+
+declare class InvalidPromptError extends Error {
+    readonly prompt: unknown;
+    constructor({ prompt, message }: {
+        prompt: unknown;
+        message: string;
+    });
+    static isInvalidPromptError(error: unknown): error is InvalidPromptError;
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        prompt: unknown;
+    };
+}
+
+declare class InvalidToolArgumentsError extends Error {
+    readonly toolName: string;
+    readonly toolArgs: string;
+    readonly cause: unknown;
+    constructor({ toolArgs, toolName, cause, message, }: {
+        message?: string;
+        toolArgs: string;
+        toolName: string;
+        cause: unknown;
+    });
+    static isInvalidToolArgumentsError(error: unknown): error is InvalidToolArgumentsError;
+    toJSON(): {
+        name: string;
+        message: string;
+        cause: unknown;
+        stack: string | undefined;
+        toolName: string;
+        toolArgs: string;
+    };
+}
+
 declare class JSONParseError extends Error {
     readonly text: string;
     readonly cause: unknown;
@@ -56,6 +95,7 @@ declare class JSONParseError extends Error {
         text: string;
         cause: unknown;
     });
+    static isJSONParseError(error: unknown): error is JSONParseError;
     toJSON(): {
         name: string;
         message: string;
@@ -69,6 +109,7 @@ declare class LoadAPIKeyError extends Error {
     constructor({ message }: {
         message: string;
     });
+    static isLoadAPIKeyError(error: unknown): error is LoadAPIKeyError;
     toJSON(): {
         name: string;
         message: string;
@@ -78,6 +119,7 @@ declare class LoadAPIKeyError extends Error {
 declare class NoTextGeneratedError extends Error {
     readonly cause: unknown;
     constructor();
+    static isNoTextGeneratedError(error: unknown): error is NoTextGeneratedError;
     toJSON(): {
         name: string;
         cause: unknown;
@@ -86,6 +128,41 @@ declare class NoTextGeneratedError extends Error {
     };
 }
 
+declare class NoSuchToolError extends Error {
+    readonly toolName: string;
+    constructor({ message, toolName }: {
+        message: string;
+        toolName: string;
+    });
+    static isNoSuchToolError(error: unknown): error is NoSuchToolError;
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        toolName: string;
+    };
+}
+
+type RetryErrorReason = 'maxRetriesExceeded' | 'errorNotRetryable' | 'abort';
+declare class RetryError extends Error {
+    readonly reason: RetryErrorReason;
+    readonly lastError: unknown;
+    readonly errors: Array<unknown>;
+    constructor({ message, reason, errors, }: {
+        message: string;
+        reason: RetryErrorReason;
+        errors: Array<unknown>;
+    });
+    static isRetryError(error: unknown): error is RetryError;
+    toJSON(): {
+        name: string;
+        message: string;
+        reason: RetryErrorReason;
+        lastError: unknown;
+        errors: unknown[];
+    };
+}
+
 declare class TypeValidationError extends Error {
     readonly value: unknown;
     readonly cause: unknown;
@@ -93,6 +170,7 @@ declare class TypeValidationError extends Error {
         value: unknown;
         cause: unknown;
     });
+    static isTypeValidationError(error: unknown): error is TypeValidationError;
     toJSON(): {
         name: string;
         message: string;
@@ -109,6 +187,7 @@ declare class UnsupportedFunctionalityError extends Error {
         provider: string;
         functionality: string;
     });
+    static isUnsupportedFunctionalityError(error: unknown): error is UnsupportedFunctionalityError;
     toJSON(): {
         name: string;
         message: string;
@@ -168,6 +247,10 @@ type LanguageModelV1CallSettings = {
      * by the model, calls will generate deterministic results.
      */
     seed?: number;
+    /**
+     * Abort signal for cancelling the operation.
+     */
+    abortSignal?: AbortSignal;
 };
 
 /**
@@ -223,9 +306,9 @@ interface LanguageModelV1TextPart {
 interface LanguageModelV1ImagePart {
     type: 'image';
     /**
-     * Image data as a Uint8Array.
+     * Image data as a Uint8Array (e.g. from a Blob or Buffer) or a URL.
      */
-    image: Uint8Array;
+    image: Uint8Array | URL;
     /**
      * Optional mime type of the image.
      */
@@ -351,6 +434,32 @@ type LanguageModelV1 = {
          * 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[];
     }>;
     /**
@@ -363,6 +472,21 @@ type LanguageModelV1 = {
      */
     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[];
     }>;
 };
@@ -388,6 +512,8 @@ type LanguageModelV1StreamPart = {
     error: unknown;
 };
 
+declare function getErrorMessage(error: unknown | undefined): string;
+
 declare function loadApiKey({ apiKey, environmentVariableName, apiKeyParameterName, description, }: {
     apiKey: string | undefined;
     environmentVariableName: string;
@@ -468,21 +594,21 @@ declare const createJsonErrorResponseHandler: <T>({ errorSchema, errorToMessage,
     errorSchema: ZodSchema<T, zod.ZodTypeDef, T>;
     errorToMessage: (error: T) => string;
     isRetryable?: ((response: Response, error?: T | undefined) => boolean) | undefined;
-}) => ResponseHandler<ApiCallError>;
+}) => ResponseHandler<APICallError>;
 declare const createEventSourceResponseHandler: <T>(chunkSchema: ZodSchema<T, zod.ZodTypeDef, T>) => ResponseHandler<ReadableStream<ParsedChunk<T>>>;
 declare const createJsonResponseHandler: <T>(responseSchema: ZodSchema<T, zod.ZodTypeDef, T>) => ResponseHandler<T>;
 
 declare const postJsonToApi: <T>({ url, headers, body, failedResponseHandler, successfulResponseHandler, abortSignal, }: {
     url: string;
-    headers?: Record<string, string> | undefined;
+    headers?: Record<string, string | undefined> | undefined;
     body: unknown;
-    failedResponseHandler: ResponseHandler<ApiCallError>;
+    failedResponseHandler: ResponseHandler<APICallError>;
     successfulResponseHandler: ResponseHandler<T>;
     abortSignal?: AbortSignal | undefined;
 }) => Promise<T>;
 declare const postToApi: <T>({ url, headers, body, successfulResponseHandler, failedResponseHandler, abortSignal, }: {
     url: string;
-    headers?: Record<string, string> | undefined;
+    headers?: Record<string, string | undefined> | undefined;
     body: {
         content: string | FormData | Uint8Array;
         values: unknown;
@@ -536,4 +662,4 @@ declare function safeValidateTypes<T>({ value, schema, }: {
     error: TypeValidationError;
 };
 
-export { AI_InvalidArgumentError, ApiCallError, JSONParseError, LanguageModelV1, LanguageModelV1CallWarning, LanguageModelV1FunctionTool, LanguageModelV1FunctionToolCall, LanguageModelV1ImagePart, LanguageModelV1Message, LanguageModelV1Prompt, LanguageModelV1StreamPart, LanguageModelV1TextPart, LanguageModelV1ToolCallPart, LanguageModelV1ToolResultPart, LoadAPIKeyError, NoTextGeneratedError, ParsedChunk, ResponseHandler, TypeValidationError, UnsupportedFunctionalityError, convertBase64ToUint8Array, convertUint8ArrayToBase64, createEventSourceResponseHandler, createJsonErrorResponseHandler, createJsonResponseHandler, isParseableJson, loadApiKey, parseJSON, postJsonToApi, postToApi, safeParseJSON, safeValidateTypes, scale, validateTypes };
+export { APICallError, InvalidArgumentError, InvalidPromptError, InvalidToolArgumentsError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1CallWarning, LanguageModelV1FinishReason, LanguageModelV1FunctionTool, LanguageModelV1FunctionToolCall, LanguageModelV1ImagePart, LanguageModelV1Message, LanguageModelV1Prompt, LanguageModelV1StreamPart, LanguageModelV1TextPart, LanguageModelV1ToolCallPart, LanguageModelV1ToolResultPart, LoadAPIKeyError, NoSuchToolError, NoTextGeneratedError, ParsedChunk, ResponseHandler, RetryError, RetryErrorReason, TypeValidationError, UnsupportedFunctionalityError, convertBase64ToUint8Array, convertUint8ArrayToBase64, createEventSourceResponseHandler, createJsonErrorResponseHandler, createJsonResponseHandler, getErrorMessage, isParseableJson, loadApiKey, parseJSON, postJsonToApi, postToApi, safeParseJSON, safeValidateTypes, scale, validateTypes };