@ai-sdk/provider 0.0.23 → 0.0.26

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @ai-sdk/provider
 
+## 0.0.26
+
+### Patch Changes
+
+- aa98cdb: chore: more flexible dependency versioning
+- 1486128: feat: add supportsUrl to language model specification
+- 7b937c5: feat (provider-utils): improve id generator robustness
+- 3b1b69a: feat: provider-defined tools
+- 811a317: feat (ai/core): multi-part tool results (incl. images)
+
+## 0.0.25
+
+### Patch Changes
+
+- b9b0d7b: feat (ai): access raw request body
+
+## 0.0.24
+
+### Patch Changes
+
+- d595d0d: feat (ai/core): file content parts
+
 ## 0.0.23
 
 ### Patch Changes

package/README.md

@@ -1 +1 @@
-# Vercel AI SDK - Provider Language Model Specification
+# AI SDK - Provider Language Model Specification

package/dist/index.d.mts

@@ -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.
      */
@@ -125,9 +126,9 @@ declare class AISDKError extends Error {
     };
 }
 
-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;
@@ -169,9 +170,9 @@ declare class APICallError extends AISDKError {
     };
 }
 
-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;
     });
@@ -184,6 +185,21 @@ declare class EmptyResponseBodyError extends AISDKError {
 
 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
@@ -535,8 +551,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';
     /**
@@ -591,7 +606,7 @@ type LanguageModelV1Message = ({
     content: string;
 } | {
     role: 'user';
-    content: Array<LanguageModelV1TextPart | LanguageModelV1ImagePart>;
+    content: Array<LanguageModelV1TextPart | LanguageModelV1ImagePart | LanguageModelV1FilePart>;
 } | {
     role: 'assistant';
     content: Array<LanguageModelV1TextPart | LanguageModelV1ToolCallPart>;
@@ -643,6 +658,26 @@ interface LanguageModelV1ImagePart {
     providerMetadata?: LanguageModelV1ProviderMetadata;
 }
 /**
+File content part of a prompt. It contains a file.
+ */
+interface LanguageModelV1FilePart {
+    type: 'file';
+    /**
+  File data as base64 encoded string or as a URL.
+     */
+    data: string | URL;
+    /**
+  Mime type of the file.
+     */
+    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.
+     */
+    providerMetadata?: LanguageModelV1ProviderMetadata;
+}
+/**
 Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
  */
 interface LanguageModelV1ToolCallPart {
@@ -688,6 +723,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.
@@ -695,6 +751,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';
 } | {
@@ -731,7 +809,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'.
          */
@@ -764,9 +842,9 @@ Specifies how the tool should be selected. Defaults to 'auto'.
      */
     prompt: LanguageModelV1Prompt;
     /**
-     * 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.
+  Additional provider-specific metadata.
+  The metadata is passed through to the provider from the AI SDK and enables
+  provider-specific functionality that can be fully encapsulated in the provider.
      */
     providerMetadata?: LanguageModelV1ProviderMetadata;
 };
@@ -779,6 +857,10 @@ type LanguageModelV1CallWarning = {
     type: 'unsupported-setting';
     setting: keyof LanguageModelV1CallSettings;
     details?: string;
+} | {
+    type: 'unsupported-tool';
+    tool: LanguageModelV1FunctionTool | LanguageModelV1ProviderDefinedTool;
+    details?: string;
 } | {
     type: 'other';
     message: string;
@@ -875,6 +957,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
@@ -926,6 +1016,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.
@@ -989,6 +1092,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[];
     }>;
 };
@@ -1030,7 +1143,7 @@ interface ProviderV1 {
   Returns the language model with the given id.
   The model id is then passed to the provider function to get the model.
   
-  @param {string} id - The id of the model to return.
+  @param {string} modelId - The id of the model to return.
   
   @returns {LanguageModel} The language model associated with the id
   
@@ -1041,7 +1154,7 @@ interface ProviderV1 {
   Returns the text embedding model with the given id.
   The model id is then passed to the provider function to get the model.
   
-  @param {string} id - The id of the model to return.
+  @param {string} modelId - The id of the model to return.
   
   @returns {LanguageModel} The language model associated with the id
   
@@ -1050,4 +1163,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 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 };

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.
      */
@@ -125,9 +126,9 @@ declare class AISDKError extends Error {
     };
 }
 
-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;
@@ -169,9 +170,9 @@ declare class APICallError extends AISDKError {
     };
 }
 
-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;
     });
@@ -184,6 +185,21 @@ declare class EmptyResponseBodyError extends AISDKError {
 
 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
@@ -535,8 +551,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';
     /**
@@ -591,7 +606,7 @@ type LanguageModelV1Message = ({
     content: string;
 } | {
     role: 'user';
-    content: Array<LanguageModelV1TextPart | LanguageModelV1ImagePart>;
+    content: Array<LanguageModelV1TextPart | LanguageModelV1ImagePart | LanguageModelV1FilePart>;
 } | {
     role: 'assistant';
     content: Array<LanguageModelV1TextPart | LanguageModelV1ToolCallPart>;
@@ -643,6 +658,26 @@ interface LanguageModelV1ImagePart {
     providerMetadata?: LanguageModelV1ProviderMetadata;
 }
 /**
+File content part of a prompt. It contains a file.
+ */
+interface LanguageModelV1FilePart {
+    type: 'file';
+    /**
+  File data as base64 encoded string or as a URL.
+     */
+    data: string | URL;
+    /**
+  Mime type of the file.
+     */
+    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.
+     */
+    providerMetadata?: LanguageModelV1ProviderMetadata;
+}
+/**
 Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
  */
 interface LanguageModelV1ToolCallPart {
@@ -688,6 +723,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.
@@ -695,6 +751,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';
 } | {
@@ -731,7 +809,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'.
          */
@@ -764,9 +842,9 @@ Specifies how the tool should be selected. Defaults to 'auto'.
      */
     prompt: LanguageModelV1Prompt;
     /**
-     * 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.
+  Additional provider-specific metadata.
+  The metadata is passed through to the provider from the AI SDK and enables
+  provider-specific functionality that can be fully encapsulated in the provider.
      */
     providerMetadata?: LanguageModelV1ProviderMetadata;
 };
@@ -779,6 +857,10 @@ type LanguageModelV1CallWarning = {
     type: 'unsupported-setting';
     setting: keyof LanguageModelV1CallSettings;
     details?: string;
+} | {
+    type: 'unsupported-tool';
+    tool: LanguageModelV1FunctionTool | LanguageModelV1ProviderDefinedTool;
+    details?: string;
 } | {
     type: 'other';
     message: string;
@@ -875,6 +957,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
@@ -926,6 +1016,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.
@@ -989,6 +1092,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[];
     }>;
 };
@@ -1030,7 +1143,7 @@ interface ProviderV1 {
   Returns the language model with the given id.
   The model id is then passed to the provider function to get the model.
   
-  @param {string} id - The id of the model to return.
+  @param {string} modelId - The id of the model to return.
   
   @returns {LanguageModel} The language model associated with the id
   
@@ -1041,7 +1154,7 @@ interface ProviderV1 {
   Returns the text embedding model with the given id.
   The model id is then passed to the provider function to get the model.
   
-  @param {string} id - The id of the model to return.
+  @param {string} modelId - The id of the model to return.
   
   @returns {LanguageModel} The language model associated with the id
   
@@ -1050,4 +1163,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 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 };