@ai-sdk/provider 0.0.16 → 0.0.17

package/dist/index.d.mts

@@ -445,7 +445,18 @@ type LanguageModelV1CallSettings = {
         type: 'text';
     } | {
         type: 'json';
+        /**
+         * JSON schema that the generated output should conform to.
+         */
         schema?: JSONSchema7;
+        /**
+         * Name of output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        name?: string;
+        /**
+         * Description of the output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        description?: string;
     };
     /**
   The seed (integer) to use for random sampling. If set and supported
@@ -607,7 +618,8 @@ type LanguageModelV1CallOptions = LanguageModelV1CallSettings & {
   object-tool mode.
   
   @deprecated mode will be removed in v2.
-  All necessary settings will be directly supported through the call settings.
+  All necessary settings will be directly supported through the call settings,
+  in particular responseFormat, toolChoice, and tools.
      */
     mode: {
         type: 'regular';
@@ -621,7 +633,18 @@ Specifies how the tool should be selected. Defaults to 'auto'.
         toolChoice?: LanguageModelV1ToolChoice;
     } | {
         type: 'object-json';
-        schema: JSONSchema7;
+        /**
+         * JSON schema that the generated output should conform to.
+         */
+        schema?: JSONSchema7;
+        /**
+         * Name of output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        name?: string;
+        /**
+         * Description of the output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        description?: string;
     } | {
         type: 'object-tool';
         tool: LanguageModelV1FunctionTool;
@@ -724,12 +747,22 @@ type LanguageModelV1 = {
      */
     readonly supportsImageUrls?: boolean;
     /**
-  Flag whether this model supports structured outputs,
+  Flag whether this model supports grammar-guided generation,
   i.e. follows JSON schemas for object generation
   when the response format is set to 'json' or
   when the `object-json` mode is used.
   
+  This means that the model guarantees that the generated JSON
+  will be a valid JSON object AND that the object will match the
+  JSON schema.
+  
+  Please note that `generateObject` and `streamObject` will work
+  regardless of this flag, but might send different prompts and
+  use further optimizations if this flag is set to `true`.
+  
   Defaults to `false`.
+  
+  TODO rename to supportsGrammarGuidedGeneration in v2
   */
     readonly supportsStructuredOutputs?: boolean;
     /**

package/dist/index.d.ts

@@ -445,7 +445,18 @@ type LanguageModelV1CallSettings = {
         type: 'text';
     } | {
         type: 'json';
+        /**
+         * JSON schema that the generated output should conform to.
+         */
         schema?: JSONSchema7;
+        /**
+         * Name of output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        name?: string;
+        /**
+         * Description of the output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        description?: string;
     };
     /**
   The seed (integer) to use for random sampling. If set and supported
@@ -607,7 +618,8 @@ type LanguageModelV1CallOptions = LanguageModelV1CallSettings & {
   object-tool mode.
   
   @deprecated mode will be removed in v2.
-  All necessary settings will be directly supported through the call settings.
+  All necessary settings will be directly supported through the call settings,
+  in particular responseFormat, toolChoice, and tools.
      */
     mode: {
         type: 'regular';
@@ -621,7 +633,18 @@ Specifies how the tool should be selected. Defaults to 'auto'.
         toolChoice?: LanguageModelV1ToolChoice;
     } | {
         type: 'object-json';
-        schema: JSONSchema7;
+        /**
+         * JSON schema that the generated output should conform to.
+         */
+        schema?: JSONSchema7;
+        /**
+         * Name of output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        name?: string;
+        /**
+         * Description of the output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        description?: string;
     } | {
         type: 'object-tool';
         tool: LanguageModelV1FunctionTool;
@@ -724,12 +747,22 @@ type LanguageModelV1 = {
      */
     readonly supportsImageUrls?: boolean;
     /**
-  Flag whether this model supports structured outputs,
+  Flag whether this model supports grammar-guided generation,
   i.e. follows JSON schemas for object generation
   when the response format is set to 'json' or
   when the `object-json` mode is used.
   
+  This means that the model guarantees that the generated JSON
+  will be a valid JSON object AND that the object will match the
+  JSON schema.
+  
+  Please note that `generateObject` and `streamObject` will work
+  regardless of this flag, but might send different prompts and
+  use further optimizations if this flag is set to `true`.
+  
   Defaults to `false`.
+  
+  TODO rename to supportsGrammarGuidedGeneration in v2
   */
     readonly supportsStructuredOutputs?: boolean;
     /**

package/package.json

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