@ai-sdk/provider 2.0.0-canary.4 → 2.0.0-canary.5

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/provider
 
+## 2.0.0-canary.5
+
+### Major Changes
+
+- 411e483: chore (provider): refactor usage (language model v2)
+- ad80501: chore (provider): allow both binary and base64 file content (spec)
+- 1766ede: chore: rename maxTokens to maxOutputTokens
+
+### Patch Changes
+
+- 79457bd: chore (provider): extract LanguageModelV2File
+- f10304b: feat(tool-calling): don't require the user to have to pass parameters
+
 ## 2.0.0-canary.4
 
 ### Major Changes

package/dist/index.d.mts

@@ -1269,6 +1269,11 @@ type LanguageModelV2FunctionTool = {
     parameters: JSONSchema7;
 };
 
+/**
+Data content. Can be a Uint8Array, base64 encoded data as a string or a URL.
+*/
+type LanguageModelV2DataContent = Uint8Array | string | URL;
+
 /**
  * Additional provider-specific options.
  * Options are additional input to the provider.
@@ -1384,9 +1389,9 @@ interface LanguageModelV2FilePart {
      */
     filename?: string;
     /**
-  File data as base64 encoded string or as a URL.
-     */
-    data: string | URL;
+  File data. Can be a Uint8Array, base64 encoded data as a string or a URL.
+  */
+    data: LanguageModelV2DataContent;
     /**
   IANA media type of the file.
   
@@ -1531,7 +1536,7 @@ type LanguageModelV2CallOptions = {
     /**
   Maximum number of tokens to generate.
      */
-    maxTokens?: number;
+    maxOutputTokens?: number;
     /**
   Temperature setting.
   
@@ -1636,6 +1641,27 @@ type LanguageModelV2CallWarning = {
     message: string;
 };
 
+/**
+A file that has been generated by the model.
+ */
+type LanguageModelV2File = {
+    /**
+  The IANA media type of the file, e.g. `image/png` or `audio/mp3`.
+  
+  @see https://www.iana.org/assignments/media-types/media-types.xhtml
+         */
+    mediaType: string;
+    /**
+  Generated file data as base64 encoded strings or binary data.
+  
+  The file data should be returned without any unnecessary conversion.
+  If the API returns base64 encoded strings, the file data should be returned
+  as base64 encoded strings. If the API returns binary data, the file data should
+  be returned as binary data.
+   */
+    data: string | Uint8Array;
+};
+
 /**
 Reason why a language model finished generating a response.
 
@@ -1722,6 +1748,20 @@ type LanguageModelV2Source = {
     providerMetadata?: LanguageModelV2ProviderMetadata;
 };
 
+/**
+ * Usage information for a language model call.
+ */
+type LanguageModelV2Usage = {
+    /**
+     * The number of input (prompt) tokens used.
+     */
+    inputTokens: number | undefined;
+    /**
+     * The number of output (completion) tokens used.
+     */
+    outputTokens: number | undefined;
+};
+
 /**
 Specification for a language model that implements the language model interface version 2.
  */
@@ -1814,38 +1854,37 @@ An optional signature for verifying that the reasoning originated from the model
     Generated files as base64 encoded strings or binary data.
     The files should be returned without any unnecessary conversion.
          */
-        files?: Array<{
-            /**
-      Generated file data as base64 encoded strings or binary data.
-      The file data should be returned without any unnecessary conversion.
-      If the API returns base64 encoded strings, the file data should be returned
-      as base64 encoded strings. If the API returns binary data, the file data should
-      be returned as binary data.
-             */
-            data: string | Uint8Array;
-            /**
-      The IANA media type of the file.
-      
-      @see https://www.iana.org/assignments/media-types/media-types.xhtml
-             */
-            mediaType: string;
-        }>;
+        files?: Array<LanguageModelV2File>;
+        /**
+    Sources that have been used as input to generate the response.
+     */
+        sources?: LanguageModelV2Source[];
         /**
     Tool calls that the model has generated.
     Can be undefined if the model did not generate any tool calls.
          */
         toolCalls?: Array<LanguageModelV2FunctionToolCall>;
         /**
+    Logprobs for the completion.
+    `undefined` if the mode does not support logprobs or if was not enabled
+    
+    @deprecated will be changed into a provider-specific extension in v2
+     */
+        logprobs?: LanguageModelV2LogProbs;
+        /**
     Finish reason.
          */
         finishReason: LanguageModelV2FinishReason;
         /**
       Usage information.
          */
-        usage: {
-            promptTokens: number;
-            completionTokens: number;
-        };
+        usage: LanguageModelV2Usage;
+        /**
+    Additional provider-specific metadata. They are passed through
+    from the provider to the AI SDK and enable provider-specific
+    results that can be fully encapsulated in the provider.
+         */
+        providerMetadata?: LanguageModelV2ProviderMetadata;
         /**
     Optional request information for telemetry and debugging purposes.
          */
@@ -1880,24 +1919,10 @@ An optional signature for verifying that the reasoning originated from the model
       */
             body?: unknown;
         };
-        warnings?: LanguageModelV2CallWarning[];
-        /**
-    Additional provider-specific metadata. They are passed through
-    from the provider to the AI SDK and enable provider-specific
-    results that can be fully encapsulated in the provider.
-         */
-        providerMetadata?: LanguageModelV2ProviderMetadata;
-        /**
-    Sources that have been used as input to generate the response.
-         */
-        sources?: LanguageModelV2Source[];
         /**
-    Logprobs for the completion.
-    `undefined` if the mode does not support logprobs or if was not enabled
-    
-    @deprecated will be changed into a provider-specific extension in v2
+    Warnings for the call, e.g. unsupported settings.
          */
-        logprobs?: LanguageModelV2LogProbs;
+        warnings?: LanguageModelV2CallWarning[];
     }>;
     /**
   Generates a language model output (streaming).
@@ -1948,23 +1973,9 @@ type LanguageModelV2StreamPart = {
 } | {
     type: 'source';
     source: LanguageModelV2Source;
-} | {
-    type: 'file';
-    /**
-The IANA media type of the file.
-
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
-     */
-    mediaType: string;
-    /**
-Generated file data as base64 encoded strings or binary data.
-The file data should be returned without any unnecessary conversion.
-If the API returns base64 encoded strings, the file data should be returned
-as base64 encoded strings. If the API returns binary data, the file data should
-be returned as binary data.
-     */
-    data: string | Uint8Array;
 } | ({
+    type: 'file';
+} & LanguageModelV2File) | ({
     type: 'tool-call';
 } & LanguageModelV2FunctionToolCall) | {
     type: 'tool-call-delta';
@@ -1981,10 +1992,7 @@ be returned as binary data.
     type: 'finish';
     finishReason: LanguageModelV2FinishReason;
     providerMetadata?: LanguageModelV2ProviderMetadata;
-    usage: {
-        promptTokens: number;
-        completionTokens: number;
-    };
+    usage: LanguageModelV2Usage;
     logprobs?: LanguageModelV2LogProbs;
 } | {
     type: 'error';
@@ -2291,4 +2299,4 @@ interface ProviderV2 {
     readonly imageModel: (modelId: string) => ImageModelV1;
 }
 
-export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, type Experimental_LanguageModelV2Middleware, type ImageModelV1, type ImageModelV1CallOptions, type ImageModelV1CallWarning, 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 LanguageModelV1ObjectGenerationMode, type LanguageModelV1Prompt, type LanguageModelV1ProviderDefinedTool, type LanguageModelV1ProviderMetadata, type LanguageModelV1ReasoningPart, type LanguageModelV1RedactedReasoningPart, type LanguageModelV1Source, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2FunctionToolCall, type LanguageModelV2LogProbs, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2ObjectGenerationMode, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2ProviderMetadata, type LanguageModelV2ProviderOptions, type LanguageModelV2ReasoningPart, type LanguageModelV2RedactedReasoningPart, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2TextPart, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, type ProviderV2, TooManyEmbeddingValuesForCallError, type TranscriptionModelV1, type TranscriptionModelV1CallOptions, type TranscriptionModelV1CallWarning, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, type Experimental_LanguageModelV2Middleware, type ImageModelV1, type ImageModelV1CallOptions, type ImageModelV1CallWarning, 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 LanguageModelV1ObjectGenerationMode, type LanguageModelV1Prompt, type LanguageModelV1ProviderDefinedTool, type LanguageModelV1ProviderMetadata, type LanguageModelV1ReasoningPart, type LanguageModelV1RedactedReasoningPart, type LanguageModelV1Source, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2FunctionToolCall, type LanguageModelV2LogProbs, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2ObjectGenerationMode, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2ProviderMetadata, type LanguageModelV2ProviderOptions, type LanguageModelV2ReasoningPart, type LanguageModelV2RedactedReasoningPart, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2TextPart, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, type ProviderV2, TooManyEmbeddingValuesForCallError, type TranscriptionModelV1, type TranscriptionModelV1CallOptions, type TranscriptionModelV1CallWarning, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };

package/dist/index.d.ts

@@ -1269,6 +1269,11 @@ type LanguageModelV2FunctionTool = {
     parameters: JSONSchema7;
 };
 
+/**
+Data content. Can be a Uint8Array, base64 encoded data as a string or a URL.
+*/
+type LanguageModelV2DataContent = Uint8Array | string | URL;
+
 /**
  * Additional provider-specific options.
  * Options are additional input to the provider.
@@ -1384,9 +1389,9 @@ interface LanguageModelV2FilePart {
      */
     filename?: string;
     /**
-  File data as base64 encoded string or as a URL.
-     */
-    data: string | URL;
+  File data. Can be a Uint8Array, base64 encoded data as a string or a URL.
+  */
+    data: LanguageModelV2DataContent;
     /**
   IANA media type of the file.
   
@@ -1531,7 +1536,7 @@ type LanguageModelV2CallOptions = {
     /**
   Maximum number of tokens to generate.
      */
-    maxTokens?: number;
+    maxOutputTokens?: number;
     /**
   Temperature setting.
   
@@ -1636,6 +1641,27 @@ type LanguageModelV2CallWarning = {
     message: string;
 };
 
+/**
+A file that has been generated by the model.
+ */
+type LanguageModelV2File = {
+    /**
+  The IANA media type of the file, e.g. `image/png` or `audio/mp3`.
+  
+  @see https://www.iana.org/assignments/media-types/media-types.xhtml
+         */
+    mediaType: string;
+    /**
+  Generated file data as base64 encoded strings or binary data.
+  
+  The file data should be returned without any unnecessary conversion.
+  If the API returns base64 encoded strings, the file data should be returned
+  as base64 encoded strings. If the API returns binary data, the file data should
+  be returned as binary data.
+   */
+    data: string | Uint8Array;
+};
+
 /**
 Reason why a language model finished generating a response.
 
@@ -1722,6 +1748,20 @@ type LanguageModelV2Source = {
     providerMetadata?: LanguageModelV2ProviderMetadata;
 };
 
+/**
+ * Usage information for a language model call.
+ */
+type LanguageModelV2Usage = {
+    /**
+     * The number of input (prompt) tokens used.
+     */
+    inputTokens: number | undefined;
+    /**
+     * The number of output (completion) tokens used.
+     */
+    outputTokens: number | undefined;
+};
+
 /**
 Specification for a language model that implements the language model interface version 2.
  */
@@ -1814,38 +1854,37 @@ An optional signature for verifying that the reasoning originated from the model
     Generated files as base64 encoded strings or binary data.
     The files should be returned without any unnecessary conversion.
          */
-        files?: Array<{
-            /**
-      Generated file data as base64 encoded strings or binary data.
-      The file data should be returned without any unnecessary conversion.
-      If the API returns base64 encoded strings, the file data should be returned
-      as base64 encoded strings. If the API returns binary data, the file data should
-      be returned as binary data.
-             */
-            data: string | Uint8Array;
-            /**
-      The IANA media type of the file.
-      
-      @see https://www.iana.org/assignments/media-types/media-types.xhtml
-             */
-            mediaType: string;
-        }>;
+        files?: Array<LanguageModelV2File>;
+        /**
+    Sources that have been used as input to generate the response.
+     */
+        sources?: LanguageModelV2Source[];
         /**
     Tool calls that the model has generated.
     Can be undefined if the model did not generate any tool calls.
          */
         toolCalls?: Array<LanguageModelV2FunctionToolCall>;
         /**
+    Logprobs for the completion.
+    `undefined` if the mode does not support logprobs or if was not enabled
+    
+    @deprecated will be changed into a provider-specific extension in v2
+     */
+        logprobs?: LanguageModelV2LogProbs;
+        /**
     Finish reason.
          */
         finishReason: LanguageModelV2FinishReason;
         /**
       Usage information.
          */
-        usage: {
-            promptTokens: number;
-            completionTokens: number;
-        };
+        usage: LanguageModelV2Usage;
+        /**
+    Additional provider-specific metadata. They are passed through
+    from the provider to the AI SDK and enable provider-specific
+    results that can be fully encapsulated in the provider.
+         */
+        providerMetadata?: LanguageModelV2ProviderMetadata;
         /**
     Optional request information for telemetry and debugging purposes.
          */
@@ -1880,24 +1919,10 @@ An optional signature for verifying that the reasoning originated from the model
       */
             body?: unknown;
         };
-        warnings?: LanguageModelV2CallWarning[];
-        /**
-    Additional provider-specific metadata. They are passed through
-    from the provider to the AI SDK and enable provider-specific
-    results that can be fully encapsulated in the provider.
-         */
-        providerMetadata?: LanguageModelV2ProviderMetadata;
-        /**
-    Sources that have been used as input to generate the response.
-         */
-        sources?: LanguageModelV2Source[];
         /**
-    Logprobs for the completion.
-    `undefined` if the mode does not support logprobs or if was not enabled
-    
-    @deprecated will be changed into a provider-specific extension in v2
+    Warnings for the call, e.g. unsupported settings.
          */
-        logprobs?: LanguageModelV2LogProbs;
+        warnings?: LanguageModelV2CallWarning[];
     }>;
     /**
   Generates a language model output (streaming).
@@ -1948,23 +1973,9 @@ type LanguageModelV2StreamPart = {
 } | {
     type: 'source';
     source: LanguageModelV2Source;
-} | {
-    type: 'file';
-    /**
-The IANA media type of the file.
-
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
-     */
-    mediaType: string;
-    /**
-Generated file data as base64 encoded strings or binary data.
-The file data should be returned without any unnecessary conversion.
-If the API returns base64 encoded strings, the file data should be returned
-as base64 encoded strings. If the API returns binary data, the file data should
-be returned as binary data.
-     */
-    data: string | Uint8Array;
 } | ({
+    type: 'file';
+} & LanguageModelV2File) | ({
     type: 'tool-call';
 } & LanguageModelV2FunctionToolCall) | {
     type: 'tool-call-delta';
@@ -1981,10 +1992,7 @@ be returned as binary data.
     type: 'finish';
     finishReason: LanguageModelV2FinishReason;
     providerMetadata?: LanguageModelV2ProviderMetadata;
-    usage: {
-        promptTokens: number;
-        completionTokens: number;
-    };
+    usage: LanguageModelV2Usage;
     logprobs?: LanguageModelV2LogProbs;
 } | {
     type: 'error';
@@ -2291,4 +2299,4 @@ interface ProviderV2 {
     readonly imageModel: (modelId: string) => ImageModelV1;
 }
 
-export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, type Experimental_LanguageModelV2Middleware, type ImageModelV1, type ImageModelV1CallOptions, type ImageModelV1CallWarning, 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 LanguageModelV1ObjectGenerationMode, type LanguageModelV1Prompt, type LanguageModelV1ProviderDefinedTool, type LanguageModelV1ProviderMetadata, type LanguageModelV1ReasoningPart, type LanguageModelV1RedactedReasoningPart, type LanguageModelV1Source, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2FunctionToolCall, type LanguageModelV2LogProbs, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2ObjectGenerationMode, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2ProviderMetadata, type LanguageModelV2ProviderOptions, type LanguageModelV2ReasoningPart, type LanguageModelV2RedactedReasoningPart, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2TextPart, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, type ProviderV2, TooManyEmbeddingValuesForCallError, type TranscriptionModelV1, type TranscriptionModelV1CallOptions, type TranscriptionModelV1CallWarning, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, type Experimental_LanguageModelV2Middleware, type ImageModelV1, type ImageModelV1CallOptions, type ImageModelV1CallWarning, 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 LanguageModelV1ObjectGenerationMode, type LanguageModelV1Prompt, type LanguageModelV1ProviderDefinedTool, type LanguageModelV1ProviderMetadata, type LanguageModelV1ReasoningPart, type LanguageModelV1RedactedReasoningPart, type LanguageModelV1Source, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2FunctionToolCall, type LanguageModelV2LogProbs, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2ObjectGenerationMode, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2ProviderMetadata, type LanguageModelV2ProviderOptions, type LanguageModelV2ReasoningPart, type LanguageModelV2RedactedReasoningPart, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2TextPart, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, type ProviderV2, TooManyEmbeddingValuesForCallError, type TranscriptionModelV1, type TranscriptionModelV1CallOptions, type TranscriptionModelV1CallWarning, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider",
-  "version": "2.0.0-canary.4",
+  "version": "2.0.0-canary.5",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",