@ai-sdk/provider 3.0.0-beta.29 → 3.0.0-beta.30

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/provider
 
+## 3.0.0-beta.30
+
+### Patch Changes
+
+- cbf52cd: feat: expose raw finish reason
+
 ## 3.0.0-beta.29
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1621,18 +1621,31 @@ type LanguageModelV3ToolResult = {
 type LanguageModelV3Content = LanguageModelV3Text | LanguageModelV3Reasoning | LanguageModelV3File | LanguageModelV3Source | LanguageModelV3ToolCall | LanguageModelV3ToolResult;
 
 /**
-Reason why a language model finished generating a response.
-
-Can be one of the following:
-- `stop`: model generated stop sequence
-- `length`: model generated maximum number of tokens
-- `content-filter`: content filter violation stopped the model
-- `tool-calls`: model triggered tool calls
-- `error`: model stopped because of an error
-- `other`: model stopped for other reasons
-- `unknown`: the model has not transmitted a finish reason
+ * Reason why a language model finished generating a response.
+ *
+ * Contains both a unified finish reason and a raw finish reason from the provider.
+ * The unified finish reason is used to provide a consistent finish reason across different providers.
+ * The raw finish reason is used to provide the original finish reason from the provider.
  */
-type LanguageModelV3FinishReason = 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other' | 'unknown';
+type LanguageModelV3FinishReason = {
+    /**
+     * Unified finish reason. This enables using the same finish reason across different providers.
+     *
+     * Can be one of the following:
+     * - `stop`: model generated stop sequence
+     * - `length`: model generated maximum number of tokens
+     * - `content-filter`: content filter violation stopped the model
+     * - `tool-calls`: model triggered tool calls
+     * - `error`: model stopped because of an error
+     * - `other`: model stopped for other reasons
+     */
+    unified: 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other';
+    /**
+     * Raw finish reason from the provider.
+     * This is the original finish reason from the provider.
+     */
+    raw: string | undefined;
+};
 
 interface LanguageModelV3ResponseMetadata {
     /**

package/dist/index.d.ts

@@ -1621,18 +1621,31 @@ type LanguageModelV3ToolResult = {
 type LanguageModelV3Content = LanguageModelV3Text | LanguageModelV3Reasoning | LanguageModelV3File | LanguageModelV3Source | LanguageModelV3ToolCall | LanguageModelV3ToolResult;
 
 /**
-Reason why a language model finished generating a response.
-
-Can be one of the following:
-- `stop`: model generated stop sequence
-- `length`: model generated maximum number of tokens
-- `content-filter`: content filter violation stopped the model
-- `tool-calls`: model triggered tool calls
-- `error`: model stopped because of an error
-- `other`: model stopped for other reasons
-- `unknown`: the model has not transmitted a finish reason
+ * Reason why a language model finished generating a response.
+ *
+ * Contains both a unified finish reason and a raw finish reason from the provider.
+ * The unified finish reason is used to provide a consistent finish reason across different providers.
+ * The raw finish reason is used to provide the original finish reason from the provider.
  */
-type LanguageModelV3FinishReason = 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other' | 'unknown';
+type LanguageModelV3FinishReason = {
+    /**
+     * Unified finish reason. This enables using the same finish reason across different providers.
+     *
+     * Can be one of the following:
+     * - `stop`: model generated stop sequence
+     * - `length`: model generated maximum number of tokens
+     * - `content-filter`: content filter violation stopped the model
+     * - `tool-calls`: model triggered tool calls
+     * - `error`: model stopped because of an error
+     * - `other`: model stopped for other reasons
+     */
+    unified: 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other';
+    /**
+     * Raw finish reason from the provider.
+     * This is the original finish reason from the provider.
+     */
+    raw: string | undefined;
+};
 
 interface LanguageModelV3ResponseMetadata {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider",
-  "version": "3.0.0-beta.29",
+  "version": "3.0.0-beta.30",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",