ai 4.1.37 → 4.1.39

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # ai
 
+## 4.1.39
+
+### Patch Changes
+
+- 075a9a9: fix (ai): improve tsdoc on custom provider
+
+## 4.1.38
+
+### Patch Changes
+
+- 4c9c194: chore (ai): add description to provider-defined tools for better accessibility
+- 2e898b4: chore (ai): move mockId test helper into provider utils
+- Updated dependencies [2e898b4]
+  - @ai-sdk/provider-utils@2.1.8
+  - @ai-sdk/react@1.1.14
+  - @ai-sdk/ui-utils@1.1.14
+
 ## 4.1.37
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1526,6 +1526,12 @@ type Tool<PARAMETERS extends Parameters = any, RESULT = any> = {
      */
     parameters: PARAMETERS;
     /**
+  An optional description of what the tool does.
+  Will be used by the language model to decide whether to use the tool.
+  Not used for provider-defined tools.
+     */
+    description?: string;
+    /**
   Optional conversion function that maps the tool result to multi-part tool content for LLMs.
      */
     experimental_toToolResultContent?: (result: RESULT) => ToolResultContent;
@@ -1542,10 +1548,6 @@ type Tool<PARAMETERS extends Parameters = any, RESULT = any> = {
 Function tool.
      */
     type?: undefined | 'function';
-    /**
-An optional description of what the tool does. Will be used by the language model to decide whether to use the tool.
- */
-    description?: string;
 } | {
     /**
 Provider-defined tool.
@@ -2673,8 +2675,9 @@ declare const experimental_wrapLanguageModel: ({ model, middleware: middlewareAr
  * @param {Object} options - The options for creating the custom provider.
  * @param {Record<string, LanguageModel>} [options.languageModels] - A record of language models, where keys are model IDs and values are LanguageModel instances.
  * @param {Record<string, EmbeddingModel<string>>} [options.textEmbeddingModels] - A record of text embedding models, where keys are model IDs and values are EmbeddingModel<string> instances.
+ * @param {Record<string, ImageModel>} [options.imageModels] - A record of image models, where keys are model IDs and values are ImageModel instances.
  * @param {Provider} [options.fallbackProvider] - An optional fallback provider to use when a requested model is not found in the custom provider.
- * @returns {Provider} A Provider object with languageModel and textEmbeddingModel methods.
+ * @returns {Provider} A Provider object with languageModel, textEmbeddingModel, and imageModel methods.
  *
  * @throws {NoSuchModelError} Throws when a requested model is not found and no fallback provider is available.
  */

package/dist/index.d.ts

@@ -1526,6 +1526,12 @@ type Tool<PARAMETERS extends Parameters = any, RESULT = any> = {
      */
     parameters: PARAMETERS;
     /**
+  An optional description of what the tool does.
+  Will be used by the language model to decide whether to use the tool.
+  Not used for provider-defined tools.
+     */
+    description?: string;
+    /**
   Optional conversion function that maps the tool result to multi-part tool content for LLMs.
      */
     experimental_toToolResultContent?: (result: RESULT) => ToolResultContent;
@@ -1542,10 +1548,6 @@ type Tool<PARAMETERS extends Parameters = any, RESULT = any> = {
 Function tool.
      */
     type?: undefined | 'function';
-    /**
-An optional description of what the tool does. Will be used by the language model to decide whether to use the tool.
- */
-    description?: string;
 } | {
     /**
 Provider-defined tool.
@@ -2673,8 +2675,9 @@ declare const experimental_wrapLanguageModel: ({ model, middleware: middlewareAr
  * @param {Object} options - The options for creating the custom provider.
  * @param {Record<string, LanguageModel>} [options.languageModels] - A record of language models, where keys are model IDs and values are LanguageModel instances.
  * @param {Record<string, EmbeddingModel<string>>} [options.textEmbeddingModels] - A record of text embedding models, where keys are model IDs and values are EmbeddingModel<string> instances.
+ * @param {Record<string, ImageModel>} [options.imageModels] - A record of image models, where keys are model IDs and values are ImageModel instances.
  * @param {Provider} [options.fallbackProvider] - An optional fallback provider to use when a requested model is not found in the custom provider.
- * @returns {Provider} A Provider object with languageModel and textEmbeddingModel methods.
+ * @returns {Provider} A Provider object with languageModel, textEmbeddingModel, and imageModel methods.
  *
  * @throws {NoSuchModelError} Throws when a requested model is not found and no fallback provider is available.
  */