@ai-sdk/xai 4.0.0-canary.68 → 4.0.0-canary.69

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ai-sdk/xai
 
+## 4.0.0-canary.69
+
+### Patch Changes
+
+- 23f9d72: deprecate searchParameters (xai live search) in favor of web_search/x_search agent tools
+- 1dbecd7: feat(provider/xai): add `enableImageSearch` to the xAI Web Search tool
+
+  The xAI Responses API supports `enable_image_search` on Web Search tools. `xai.tools.webSearch()` now accepts `enableImageSearch` and sends it through to the API as `enable_image_search`.
+
 ## 4.0.0-canary.68
 
 ### Patch Changes

package/dist/index.d.ts

@@ -245,6 +245,7 @@ declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderExecutedToolF
 }, {
     allowedDomains?: string[];
     excludedDomains?: string[];
+    enableImageSearch?: boolean;
     enableImageUnderstanding?: boolean;
 }, {}>;
 declare const webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.ProviderExecutedTool<{}, {
@@ -352,6 +353,7 @@ declare const xaiTools: {
     }, {
         allowedDomains?: string[];
         excludedDomains?: string[];
+        enableImageSearch?: boolean;
         enableImageUnderstanding?: boolean;
     }, {}>>[0]) => _ai_sdk_provider_utils.ProviderExecutedTool<{}, {
         query: string;

package/dist/index.js

@@ -284,6 +284,15 @@ var xaiLanguageModelChatOptions = z.object({
    * Defaults to true.
    */
   parallel_function_calling: z.boolean().optional(),
+  /**
+   * @deprecated xAI has deprecated Live Search (`search_parameters`) in favor
+   * of the Agent Tools API. Requests using this option now return a "Live
+   * search is deprecated" error. Use the `web_search` / `x_search` tools
+   * instead (e.g. `xai.tools.webSearch()`, `xai.tools.xSearch()`) with
+   * `xai.responses(modelId)`.
+   *
+   * @see https://docs.x.ai/docs/guides/tools/overview
+   */
   searchParameters: z.object({
     /**
      * search mode preference
@@ -1967,6 +1976,7 @@ var webSearchArgsSchema = lazySchema3(
     z10.object({
       allowedDomains: z10.array(z10.string()).max(5).optional(),
       excludedDomains: z10.array(z10.string()).max(5).optional(),
+      enableImageSearch: z10.boolean().optional(),
       enableImageUnderstanding: z10.boolean().optional()
     })
   )
@@ -2058,6 +2068,7 @@ async function prepareResponsesTools({
             type: "web_search",
             allowed_domains: args.allowedDomains,
             excluded_domains: args.excludedDomains,
+            enable_image_search: args.enableImageSearch,
             enable_image_understanding: args.enableImageUnderstanding
           });
           break;
@@ -3013,7 +3024,7 @@ var xaiTools = {
 };
 
 // src/version.ts
-var VERSION = true ? "4.0.0-canary.68" : "0.0.0-test";
+var VERSION = true ? "4.0.0-canary.69" : "0.0.0-test";
 
 // src/files/xai-files.ts
 import {