@ai-sdk/provider 0.0.24 → 1.0.0-canary.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { JSONSchema7 } from 'json-schema';
+export { JSONSchema7, JSONSchema7Definition } from 'json-schema';
 
 /**
 An embedding is a vector, i.e. an array of numbers.
@@ -82,13 +83,13 @@ type EmbeddingModelV1<VALUE> = {
     }>;
 };
 
-declare const symbol$c: unique symbol;
+declare const symbol$d: unique symbol;
 /**
  * Custom error class for AI SDK related errors.
  * @extends Error
  */
 declare class AISDKError extends Error {
-    private readonly [symbol$c];
+    private readonly [symbol$d];
     /**
      * The underlying cause of the error, if any.
      */
@@ -113,21 +114,11 @@ declare class AISDKError extends Error {
      */
     static isInstance(error: unknown): error is AISDKError;
     protected static hasMarker(error: unknown, marker: string): boolean;
-    /**
-     * Returns a JSON representation of the error.
-     * @returns {Object} An object containing the error's name, message, and cause.
-     *
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-    };
 }
 
-declare const symbol$b: unique symbol;
+declare const symbol$c: unique symbol;
 declare class APICallError extends AISDKError {
-    private readonly [symbol$b];
+    private readonly [symbol$c];
     readonly url: string;
     readonly requestBodyValues: unknown;
     readonly statusCode?: number;
@@ -148,42 +139,34 @@ declare class APICallError extends AISDKError {
         data?: unknown;
     });
     static isInstance(error: unknown): error is APICallError;
-    /**
-     * @deprecated Use isInstance instead.
-     */
-    static isAPICallError(error: unknown): error is APICallError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        url: string;
-        requestBodyValues: unknown;
-        statusCode: number | undefined;
-        responseHeaders: Record<string, string> | undefined;
-        responseBody: string | undefined;
-        cause: unknown;
-        isRetryable: boolean;
-        data: unknown;
-    };
 }
 
-declare const symbol$a: unique symbol;
+declare const symbol$b: unique symbol;
 declare class EmptyResponseBodyError extends AISDKError {
-    private readonly [symbol$a];
+    private readonly [symbol$b];
     constructor({ message }?: {
         message?: string;
     });
     static isInstance(error: unknown): error is EmptyResponseBodyError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isEmptyResponseBodyError(error: unknown): error is EmptyResponseBodyError;
 }
 
 declare function getErrorMessage(error: unknown | undefined): string;
 
+declare const symbol$a: unique symbol;
+/**
+ * A function argument is invalid.
+ */
+declare class InvalidArgumentError extends AISDKError {
+    private readonly [symbol$a];
+    readonly argument: string;
+    constructor({ message, cause, argument, }: {
+        argument: string;
+        message: string;
+        cause?: unknown;
+    });
+    static isInstance(error: unknown): error is InvalidArgumentError;
+}
+
 declare const symbol$9: unique symbol;
 /**
  * A prompt is invalid. This error should be thrown by providers when they cannot
@@ -198,19 +181,6 @@ declare class InvalidPromptError extends AISDKError {
         cause?: unknown;
     });
     static isInstance(error: unknown): error is InvalidPromptError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isInvalidPromptError(error: unknown): error is InvalidPromptError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        prompt: unknown;
-    };
 }
 
 declare const symbol$8: unique symbol;
@@ -226,19 +196,6 @@ declare class InvalidResponseDataError extends AISDKError {
         message?: string;
     });
     static isInstance(error: unknown): error is InvalidResponseDataError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isInvalidResponseDataError(error: unknown): error is InvalidResponseDataError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        data: unknown;
-    };
 }
 
 declare const symbol$7: unique symbol;
@@ -250,20 +207,6 @@ declare class JSONParseError extends AISDKError {
         cause: unknown;
     });
     static isInstance(error: unknown): error is JSONParseError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isJSONParseError(error: unknown): error is JSONParseError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        cause: unknown;
-        stack: string | undefined;
-        valueText: string;
-    };
 }
 
 declare const symbol$6: unique symbol;
@@ -273,10 +216,6 @@ declare class LoadAPIKeyError extends AISDKError {
         message: string;
     });
     static isInstance(error: unknown): error is LoadAPIKeyError;
-    /**
-     * @deprecated Use isInstance instead.
-     */
-    static isLoadAPIKeyError(error: unknown): error is LoadAPIKeyError;
 }
 
 declare const symbol$5: unique symbol;
@@ -286,10 +225,6 @@ declare class LoadSettingError extends AISDKError {
         message: string;
     });
     static isInstance(error: unknown): error is LoadSettingError;
-    /**
-     * @deprecated Use isInstance instead.
-     */
-    static isLoadSettingError(error: unknown): error is LoadSettingError;
 }
 
 declare const symbol$4: unique symbol;
@@ -302,19 +237,6 @@ declare class NoContentGeneratedError extends AISDKError {
         message?: string;
     });
     static isInstance(error: unknown): error is NoContentGeneratedError;
-    /**
-     * @deprecated Use isInstance instead.
-     */
-    static isNoContentGeneratedError(error: unknown): error is NoContentGeneratedError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        cause: unknown;
-        message: string;
-        stack: string | undefined;
-    };
 }
 
 declare const symbol$3: unique symbol;
@@ -329,20 +251,6 @@ declare class NoSuchModelError extends AISDKError {
         message?: string;
     });
     static isInstance(error: unknown): error is NoSuchModelError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isNoSuchModelError(error: unknown): error is NoSuchModelError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        modelId: string;
-        modelType: "languageModel" | "textEmbeddingModel";
-    };
 }
 
 declare const symbol$2: unique symbol;
@@ -359,22 +267,6 @@ declare class TooManyEmbeddingValuesForCallError extends AISDKError {
         values: Array<unknown>;
     });
     static isInstance(error: unknown): error is TooManyEmbeddingValuesForCallError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isTooManyEmbeddingValuesForCallError(error: unknown): error is TooManyEmbeddingValuesForCallError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        provider: string;
-        modelId: string;
-        maxEmbeddingsPerCall: number;
-        values: unknown[];
-    };
 }
 
 declare const symbol$1: unique symbol;
@@ -400,20 +292,6 @@ declare class TypeValidationError extends AISDKError {
         value: unknown;
         cause: unknown;
     }): TypeValidationError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isTypeValidationError(error: unknown): error is TypeValidationError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        cause: unknown;
-        stack: string | undefined;
-        value: unknown;
-    };
 }
 
 declare const symbol: unique symbol;
@@ -424,19 +302,6 @@ declare class UnsupportedFunctionalityError extends AISDKError {
         functionality: string;
     });
     static isInstance(error: unknown): error is UnsupportedFunctionalityError;
-    /**
-     * @deprecated Use isInstance instead.
-     */
-    static isUnsupportedFunctionalityError(error: unknown): error is UnsupportedFunctionalityError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        functionality: string;
-    };
 }
 
 type JSONValue = null | string | number | boolean | JSONObject | JSONArray;
@@ -535,8 +400,7 @@ 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.
+  The type of the tool (always 'function').
      */
     type: 'function';
     /**
@@ -708,6 +572,27 @@ interface LanguageModelV1ToolResultPart {
      */
     isError?: boolean;
     /**
+  Tool results as an array of parts. This enables advanced tool results including images.
+  When this is used, the `result` field should be ignored (if the provider supports content).
+     */
+    content?: Array<{
+        type: 'text';
+        /**
+Text content.
+         */
+        text: string;
+    } | {
+        type: 'image';
+        /**
+base-64 encoded image data
+         */
+        data: string;
+        /**
+Mime type of the image.
+         */
+        mimeType?: string;
+    }>;
+    /**
      * Additional provider-specific metadata. They are passed through
      * to the provider from the AI SDK and enable provider-specific
      * functionality that can be fully encapsulated in the provider.
@@ -715,6 +600,28 @@ interface LanguageModelV1ToolResultPart {
     providerMetadata?: LanguageModelV1ProviderMetadata;
 }
 
+/**
+The configuration of a tool that is defined by the provider.
+ */
+type LanguageModelV1ProviderDefinedTool = {
+    /**
+  The type of the tool (always 'provider-defined').
+     */
+    type: 'provider-defined';
+    /**
+  The ID of the tool. Should follow the format `<provider-name>.<tool-name>`.
+     */
+    id: `${string}.${string}`;
+    /**
+  The name of the tool. Unique within this model call.
+     */
+    name: string;
+    /**
+  The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+    */
+    args: Record<string, unknown>;
+};
+
 type LanguageModelV1ToolChoice = {
     type: 'auto';
 } | {
@@ -751,7 +658,7 @@ type LanguageModelV1CallOptions = LanguageModelV1CallSettings & {
         /**
 The tools that are available for the model.
          */
-        tools?: Array<LanguageModelV1FunctionTool>;
+        tools?: Array<LanguageModelV1FunctionTool | LanguageModelV1ProviderDefinedTool>;
         /**
 Specifies how the tool should be selected. Defaults to 'auto'.
          */
@@ -799,6 +706,10 @@ type LanguageModelV1CallWarning = {
     type: 'unsupported-setting';
     setting: keyof LanguageModelV1CallSettings;
     details?: string;
+} | {
+    type: 'unsupported-tool';
+    tool: LanguageModelV1FunctionTool | LanguageModelV1ProviderDefinedTool;
+    details?: string;
 } | {
     type: 'other';
     message: string;
@@ -895,6 +806,14 @@ type LanguageModelV1 = {
   */
     readonly supportsStructuredOutputs?: boolean;
     /**
+  Checks if the model supports the given URL for file parts natively.
+  If the model does not support the URL,
+  the AI SDK will download the file and pass the file data to the model.
+  
+  When undefined, the AI SDK will download the file.
+     */
+    supportsUrl?(url: URL): boolean;
+    /**
   Generates a language model output (non-streaming).
   
   Naming: "do" prefix to prevent accidental direct usage of the method
@@ -946,6 +865,19 @@ type LanguageModelV1 = {
             */
             headers?: Record<string, string>;
         };
+        /**
+    Optional request information for telemetry and debugging purposes.
+         */
+        request?: {
+            /**
+      Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
+      Non-HTTP(s) providers should not set this.
+             */
+            body?: string;
+        };
+        /**
+    Optional response information for telemetry and debugging purposes.
+         */
         response?: {
             /**
       ID for the generated response, if the provider sends one.
@@ -1009,6 +941,16 @@ type LanguageModelV1 = {
              */
             headers?: Record<string, string>;
         };
+        /**
+    Optional request information for telemetry and debugging purposes.
+         */
+        request?: {
+            /**
+      Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
+      Non-HTTP(s) providers should not set this.
+         */
+            body?: string;
+        };
         warnings?: LanguageModelV1CallWarning[];
     }>;
 };
@@ -1070,4 +1012,4 @@ interface ProviderV1 {
     textEmbeddingModel(modelId: string): EmbeddingModelV1<string>;
 }
 
-export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FilePart, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1Prompt, type LanguageModelV1ProviderMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FilePart, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1Prompt, type LanguageModelV1ProviderDefinedTool, type LanguageModelV1ProviderMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };