@langchain/xai 1.2.2-dev-1768440391024 → 1.3.0

package/dist/tools/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":["xaiLiveSearch","tools"],"sources":["../../src/tools/index.d.ts"],"sourcesContent":["import { xaiLiveSearch } from \"./live_search.js\";\nexport declare const tools: {\n    xaiLiveSearch: typeof xaiLiveSearch;\n};\n//# sourceMappingURL=index.d.ts.map"],"mappings":";;;cACqBC;wBACKD;AAD1B,CAAA"}
+{"version":3,"file":"index.d.cts","names":["xaiLiveSearch","xaiWebSearch","xaiXSearch","xaiCodeExecution","xaiCollectionsSearch","tools","XAILiveSearchTool","XAILiveSearchToolOptions","XAIWebSearchTool","XAIWebSearchToolOptions","XAIXSearchTool","XAIXSearchToolOptions","XAICodeExecutionTool","XAICollectionsSearchTool","XAICollectionsSearchToolOptions","XAI_LIVE_SEARCH_TOOL_TYPE","XAI_LIVE_SEARCH_TOOL_NAME","XAI_WEB_SEARCH_TOOL_TYPE","XAI_X_SEARCH_TOOL_TYPE","XAI_CODE_EXECUTION_TOOL_TYPE","XAI_COLLECTIONS_SEARCH_TOOL_TYPE"],"sources":["../../src/tools/index.d.ts"],"sourcesContent":["import { xaiLiveSearch } from \"./live_search.js\";\nimport { xaiWebSearch } from \"./web_search.js\";\nimport { xaiXSearch } from \"./x_search.js\";\nimport { xaiCodeExecution } from \"./code_execution.js\";\nimport { xaiCollectionsSearch } from \"./collections_search.js\";\nexport declare const tools: {\n    /** @deprecated Use xaiWebSearch and xaiXSearch instead */\n    xaiLiveSearch: typeof xaiLiveSearch;\n    xaiWebSearch: typeof xaiWebSearch;\n    xaiXSearch: typeof xaiXSearch;\n    xaiCodeExecution: typeof xaiCodeExecution;\n    xaiCollectionsSearch: typeof xaiCollectionsSearch;\n};\nexport type { XAILiveSearchTool, XAILiveSearchToolOptions, } from \"./live_search.js\";\nexport type { XAIWebSearchTool, XAIWebSearchToolOptions, } from \"./web_search.js\";\nexport type { XAIXSearchTool, XAIXSearchToolOptions } from \"./x_search.js\";\nexport type { XAICodeExecutionTool } from \"./code_execution.js\";\nexport type { XAICollectionsSearchTool, XAICollectionsSearchToolOptions, } from \"./collections_search.js\";\nexport { XAI_LIVE_SEARCH_TOOL_TYPE, XAI_LIVE_SEARCH_TOOL_NAME, } from \"./live_search.js\";\nexport { XAI_WEB_SEARCH_TOOL_TYPE } from \"./web_search.js\";\nexport { XAI_X_SEARCH_TOOL_TYPE } from \"./x_search.js\";\nexport { XAI_CODE_EXECUTION_TOOL_TYPE } from \"./code_execution.js\";\nexport { XAI_COLLECTIONS_SEARCH_TOOL_TYPE } from \"./collections_search.js\";\n//# sourceMappingURL=index.d.ts.map"],"mappings":";;;;;;;cAKqBK;;EAAAA,aAOpB,EAAA,OALyBL,aAKzB;EALyBA,YAAAA,EAAAA,OACDC,YADCD;EACDC,UAAAA,EAAAA,OACFC,UADED;EACFC,gBAAAA,EAAAA,OACMC,gBADND;EACMC,oBAAAA,EAAAA,OACIC,oBADJD;CACIC"}

package/dist/tools/index.d.ts

@@ -1,8 +1,17 @@
-import { xaiLiveSearch } from "./live_search.js";
+import { XAILiveSearchTool, XAILiveSearchToolOptions, XAI_LIVE_SEARCH_TOOL_NAME, XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch } from "./live_search.js";
+import { XAIWebSearchTool, XAIWebSearchToolOptions, XAI_WEB_SEARCH_TOOL_TYPE, xaiWebSearch } from "./web_search.js";
+import { XAIXSearchTool, XAIXSearchToolOptions, XAI_X_SEARCH_TOOL_TYPE, xaiXSearch } from "./x_search.js";
+import { XAICodeExecutionTool, XAI_CODE_EXECUTION_TOOL_TYPE, xaiCodeExecution } from "./code_execution.js";
+import { XAICollectionsSearchTool, XAICollectionsSearchToolOptions, XAI_COLLECTIONS_SEARCH_TOOL_TYPE, xaiCollectionsSearch } from "./collections_search.js";
 
 //#region src/tools/index.d.ts
 declare const tools: {
+  /** @deprecated Use xaiWebSearch and xaiXSearch instead */
   xaiLiveSearch: typeof xaiLiveSearch;
+  xaiWebSearch: typeof xaiWebSearch;
+  xaiXSearch: typeof xaiXSearch;
+  xaiCodeExecution: typeof xaiCodeExecution;
+  xaiCollectionsSearch: typeof xaiCollectionsSearch;
 };
 //#endregion
 export { tools };

package/dist/tools/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":["xaiLiveSearch","tools"],"sources":["../../src/tools/index.d.ts"],"sourcesContent":["import { xaiLiveSearch } from \"./live_search.js\";\nexport declare const tools: {\n    xaiLiveSearch: typeof xaiLiveSearch;\n};\n//# sourceMappingURL=index.d.ts.map"],"mappings":";;;cACqBC;wBACKD;AAD1B,CAAA"}
+{"version":3,"file":"index.d.ts","names":["xaiLiveSearch","xaiWebSearch","xaiXSearch","xaiCodeExecution","xaiCollectionsSearch","tools","XAILiveSearchTool","XAILiveSearchToolOptions","XAIWebSearchTool","XAIWebSearchToolOptions","XAIXSearchTool","XAIXSearchToolOptions","XAICodeExecutionTool","XAICollectionsSearchTool","XAICollectionsSearchToolOptions","XAI_LIVE_SEARCH_TOOL_TYPE","XAI_LIVE_SEARCH_TOOL_NAME","XAI_WEB_SEARCH_TOOL_TYPE","XAI_X_SEARCH_TOOL_TYPE","XAI_CODE_EXECUTION_TOOL_TYPE","XAI_COLLECTIONS_SEARCH_TOOL_TYPE"],"sources":["../../src/tools/index.d.ts"],"sourcesContent":["import { xaiLiveSearch } from \"./live_search.js\";\nimport { xaiWebSearch } from \"./web_search.js\";\nimport { xaiXSearch } from \"./x_search.js\";\nimport { xaiCodeExecution } from \"./code_execution.js\";\nimport { xaiCollectionsSearch } from \"./collections_search.js\";\nexport declare const tools: {\n    /** @deprecated Use xaiWebSearch and xaiXSearch instead */\n    xaiLiveSearch: typeof xaiLiveSearch;\n    xaiWebSearch: typeof xaiWebSearch;\n    xaiXSearch: typeof xaiXSearch;\n    xaiCodeExecution: typeof xaiCodeExecution;\n    xaiCollectionsSearch: typeof xaiCollectionsSearch;\n};\nexport type { XAILiveSearchTool, XAILiveSearchToolOptions, } from \"./live_search.js\";\nexport type { XAIWebSearchTool, XAIWebSearchToolOptions, } from \"./web_search.js\";\nexport type { XAIXSearchTool, XAIXSearchToolOptions } from \"./x_search.js\";\nexport type { XAICodeExecutionTool } from \"./code_execution.js\";\nexport type { XAICollectionsSearchTool, XAICollectionsSearchToolOptions, } from \"./collections_search.js\";\nexport { XAI_LIVE_SEARCH_TOOL_TYPE, XAI_LIVE_SEARCH_TOOL_NAME, } from \"./live_search.js\";\nexport { XAI_WEB_SEARCH_TOOL_TYPE } from \"./web_search.js\";\nexport { XAI_X_SEARCH_TOOL_TYPE } from \"./x_search.js\";\nexport { XAI_CODE_EXECUTION_TOOL_TYPE } from \"./code_execution.js\";\nexport { XAI_COLLECTIONS_SEARCH_TOOL_TYPE } from \"./collections_search.js\";\n//# sourceMappingURL=index.d.ts.map"],"mappings":";;;;;;;cAKqBK;;EAAAA,aAOpB,EAAA,OALyBL,aAKzB;EALyBA,YAAAA,EAAAA,OACDC,YADCD;EACDC,UAAAA,EAAAA,OACFC,UADED;EACFC,gBAAAA,EAAAA,OACMC,gBADND;EACMC,oBAAAA,EAAAA,OACIC,oBADJD;CACIC"}

package/dist/tools/index.js

@@ -1,7 +1,17 @@
-import { xaiLiveSearch } from "./live_search.js";
+import { XAI_LIVE_SEARCH_TOOL_NAME, XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch } from "./live_search.js";
+import { XAI_WEB_SEARCH_TOOL_TYPE, xaiWebSearch } from "./web_search.js";
+import { XAI_X_SEARCH_TOOL_TYPE, xaiXSearch } from "./x_search.js";
+import { XAI_CODE_EXECUTION_TOOL_TYPE, xaiCodeExecution } from "./code_execution.js";
+import { XAI_COLLECTIONS_SEARCH_TOOL_TYPE, xaiCollectionsSearch } from "./collections_search.js";
 
 //#region src/tools/index.ts
-const tools = { xaiLiveSearch };
+const tools = {
+	xaiLiveSearch,
+	xaiWebSearch,
+	xaiXSearch,
+	xaiCodeExecution,
+	xaiCollectionsSearch
+};
 
 //#endregion
 export { tools };

package/dist/tools/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/tools/index.ts"],"sourcesContent":["import { xaiLiveSearch } from \"./live_search.js\";\n\nexport const tools = {\n  xaiLiveSearch,\n};\n"],"mappings":";;;AAEA,MAAa,QAAQ,EACnB,cACD"}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/tools/index.ts"],"sourcesContent":["import { xaiLiveSearch } from \"./live_search.js\";\nimport { xaiWebSearch } from \"./web_search.js\";\nimport { xaiXSearch } from \"./x_search.js\";\nimport { xaiCodeExecution } from \"./code_execution.js\";\nimport { xaiCollectionsSearch } from \"./collections_search.js\";\n\nexport const tools = {\n  /** @deprecated Use xaiWebSearch and xaiXSearch instead */\n  xaiLiveSearch,\n  xaiWebSearch,\n  xaiXSearch,\n  xaiCodeExecution,\n  xaiCollectionsSearch,\n};\n\n// Re-export types for convenience\nexport type {\n  XAILiveSearchTool,\n  XAILiveSearchToolOptions,\n} from \"./live_search.js\";\nexport type {\n  XAIWebSearchTool,\n  XAIWebSearchToolOptions,\n} from \"./web_search.js\";\nexport type { XAIXSearchTool, XAIXSearchToolOptions } from \"./x_search.js\";\nexport type { XAICodeExecutionTool } from \"./code_execution.js\";\nexport type {\n  XAICollectionsSearchTool,\n  XAICollectionsSearchToolOptions,\n} from \"./collections_search.js\";\n\n// Re-export tool type constants\nexport {\n  XAI_LIVE_SEARCH_TOOL_TYPE,\n  XAI_LIVE_SEARCH_TOOL_NAME,\n} from \"./live_search.js\";\nexport { XAI_WEB_SEARCH_TOOL_TYPE } from \"./web_search.js\";\nexport { XAI_X_SEARCH_TOOL_TYPE } from \"./x_search.js\";\nexport { XAI_CODE_EXECUTION_TOOL_TYPE } from \"./code_execution.js\";\nexport { XAI_COLLECTIONS_SEARCH_TOOL_TYPE } from \"./collections_search.js\";\n"],"mappings":";;;;;;;AAMA,MAAa,QAAQ;CAEnB;CACA;CACA;CACA;CACA;AACD"}

package/dist/tools/live_search.cjs

@@ -43,6 +43,19 @@ function mapToolSourceToSearchSource(source) {
 *
 * This tool is executed server-side by the xAI API.
 *
+* @deprecated The Live Search API was deprecated by xAI on December 15, 2025.
+* Use the new agentic tool calling API instead with `xaiWebSearch()` and `xaiXSearch()`.
+*
+* @example Migration to new tools:
+* ```typescript
+* // Old (deprecated):
+* const searchTool = tools.xaiLiveSearch({ maxSearchResults: 5 });
+*
+* // New (recommended):
+* const webSearch = tools.xaiWebSearch({ allowedDomains: ["example.com"] });
+* const xSearch = tools.xaiXSearch({ allowedXHandles: ["elonmusk"] });
+* ```
+*
 * @example
 * ```typescript
 * import { ChatXAI, tools } from "@langchain/xai";
@@ -75,6 +88,7 @@ function xaiLiveSearch(options = {}) {
 }
 
 //#endregion
+exports.XAI_LIVE_SEARCH_TOOL_NAME = XAI_LIVE_SEARCH_TOOL_NAME;
 exports.XAI_LIVE_SEARCH_TOOL_TYPE = XAI_LIVE_SEARCH_TOOL_TYPE;
 exports.xaiLiveSearch = xaiLiveSearch;
 //# sourceMappingURL=live_search.cjs.map

package/dist/tools/live_search.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"live_search.cjs","names":["source: XAISearchToolSource","_exhaustive: never","options: XAILiveSearchToolOptions"],"sources":["../../src/tools/live_search.ts"],"sourcesContent":["import type { XAISearchParameters, XAISearchSource } from \"../live_search.js\";\n\n/**\n * xAI's deprecated live_search tool type.\n */\nexport const XAI_LIVE_SEARCH_TOOL_TYPE = \"live_search_deprecated_20251215\";\nexport const XAI_LIVE_SEARCH_TOOL_NAME = \"live_search\";\n\n/**\n * xAI's built-in live_search tool type.\n * Enables the model to search the web for real-time information.\n */\nexport interface XAILiveSearchTool extends XAISearchParameters {\n  /**\n   * The name of the tool. Must be \"live_search\" for xAI's built-in search.\n   */\n  name: typeof XAI_LIVE_SEARCH_TOOL_NAME;\n  /**\n   * The type of the tool. This uses a deprecated Live Search API shape:\n   * the advanced agentic search capabilities powering grok.com are generally\n   * available in the new agentic tool calling API, and the Live Search API\n   * will be deprecated by December 15, 2025.\n   */\n  type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;\n}\n\n/**\n * Web search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIWebSource` internally.\n */\nexport interface XAIWebSearchToolSource {\n  type: \"web\";\n  country?: string;\n  excludedWebsites?: string[];\n  allowedWebsites?: string[];\n  safeSearch?: boolean;\n}\n\n/**\n * News search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAINewsSource` internally.\n */\nexport interface XAINewsSearchToolSource {\n  type: \"news\";\n  country?: string;\n  excludedWebsites?: string[];\n  safeSearch?: boolean;\n}\n\n/**\n * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIXSource` internally.\n */\nexport interface XAIXSearchToolSource {\n  type: \"x\";\n  includedXHandles?: string[];\n  excludedXHandles?: string[];\n  postFavoriteCount?: number;\n  postViewCount?: number;\n}\n\n/**\n * RSS feed search source configuration for the xAI live search tool.\n * The structure matches `XAIRssSource` (only `links`).\n */\nexport interface XAIRssSearchToolSource {\n  type: \"rss\";\n  links: string[];\n}\n\nexport type XAISearchToolSource =\n  | XAIWebSearchToolSource\n  | XAINewsSearchToolSource\n  | XAIXSearchToolSource\n  | XAIRssSearchToolSource;\n\n/**\n * Options for the xAI live search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the underlying `XAISearchParameters`\n * object that is sent to xAI's deprecated Live Search API.\n */\nexport interface XAILiveSearchToolOptions {\n  /**\n   * Controls when the model should perform a search.\n   * - \"auto\": Let the model decide when to search (default)\n   * - \"on\": Always search for every request\n   * - \"off\": Never search\n   */\n  mode?: \"auto\" | \"on\" | \"off\";\n  /**\n   * Maximum number of search results to return.\n   * @default 20\n   */\n  maxSearchResults?: number;\n  /**\n   * Filter search results to only include content from after this date.\n   * Format: ISO 8601 date string (e.g., \"2024-01-01\")\n   */\n  fromDate?: string;\n  /**\n   * Filter search results to only include content from before this date.\n   * Format: ISO 8601 date string (e.g., \"2024-12-31\")\n   */\n  toDate?: string;\n  /**\n   * Whether to return citations/sources for the search results.\n   * @default true\n   */\n  returnCitations?: boolean;\n  /**\n   * Specific web/news/X/RSS sources that can be used for the search.\n   * These are converted to the snake_case `XAISearchSource` structures\n   * used by the underlying xAI Live Search API.\n   */\n  sources?: XAISearchToolSource[];\n}\n\nfunction mapToolSourceToSearchSource(\n  source: XAISearchToolSource\n): XAISearchSource {\n  switch (source.type) {\n    case \"web\":\n      return {\n        type: \"web\",\n        ...(source.country !== undefined && { country: source.country }),\n        ...(source.allowedWebsites !== undefined && {\n          allowed_websites: source.allowedWebsites,\n        }),\n        ...(source.excludedWebsites !== undefined && {\n          excluded_websites: source.excludedWebsites,\n        }),\n        ...(source.safeSearch !== undefined && {\n          safe_search: source.safeSearch,\n        }),\n      };\n    case \"news\":\n      return {\n        type: \"news\",\n        ...(source.country !== undefined && { country: source.country }),\n        ...(source.excludedWebsites !== undefined && {\n          excluded_websites: source.excludedWebsites,\n        }),\n        ...(source.safeSearch !== undefined && {\n          safe_search: source.safeSearch,\n        }),\n      };\n    case \"x\":\n      return {\n        type: \"x\",\n        ...(source.includedXHandles !== undefined && {\n          included_x_handles: source.includedXHandles,\n        }),\n        ...(source.excludedXHandles !== undefined && {\n          excluded_x_handles: source.excludedXHandles,\n        }),\n        ...(source.postFavoriteCount !== undefined && {\n          post_favorite_count: source.postFavoriteCount,\n        }),\n        ...(source.postViewCount !== undefined && {\n          post_view_count: source.postViewCount,\n        }),\n      };\n    case \"rss\":\n      return {\n        type: \"rss\",\n        links: source.links,\n      };\n    default: {\n      const _exhaustive: never = source;\n      return _exhaustive;\n    }\n  }\n}\n\n/**\n * Creates an xAI built-in live search tool.\n * Enables the model to search the web for real-time information.\n *\n * This tool is executed server-side by the xAI API.\n *\n * @example\n * ```typescript\n * import { ChatXAI, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAI({\n *   model: \"grok-beta\",\n * });\n *\n * const searchTool = tools.xaiLiveSearch({\n *   maxSearchResults: 5,\n *   fromDate: \"2024-01-01\",\n *   returnCitations: true\n * });\n *\n * const llmWithSearch = llm.bindTools([searchTool]);\n * const result = await llmWithSearch.invoke(\"What happened in tech today?\");\n * ```\n */\nexport function xaiLiveSearch(\n  options: XAILiveSearchToolOptions = {}\n): XAILiveSearchTool {\n  return {\n    type: XAI_LIVE_SEARCH_TOOL_TYPE,\n    name: XAI_LIVE_SEARCH_TOOL_NAME,\n    mode: options?.mode,\n    max_search_results: options?.maxSearchResults,\n    from_date: options?.fromDate,\n    to_date: options?.toDate,\n    return_citations: options?.returnCitations,\n    sources: options?.sources?.map(mapToolSourceToSearchSource),\n  } satisfies XAILiveSearchTool;\n}\n"],"mappings":";;;;;AAKA,MAAa,4BAA4B;AACzC,MAAa,4BAA4B;AAgHzC,SAAS,4BACPA,QACiB;AACjB,SAAQ,OAAO,MAAf;EACE,KAAK,MACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,YAAY,UAAa,EAAE,SAAS,OAAO,QAAS;GAC/D,GAAI,OAAO,oBAAoB,UAAa,EAC1C,kBAAkB,OAAO,gBAC1B;GACD,GAAI,OAAO,qBAAqB,UAAa,EAC3C,mBAAmB,OAAO,iBAC3B;GACD,GAAI,OAAO,eAAe,UAAa,EACrC,aAAa,OAAO,WACrB;EACF;EACH,KAAK,OACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,YAAY,UAAa,EAAE,SAAS,OAAO,QAAS;GAC/D,GAAI,OAAO,qBAAqB,UAAa,EAC3C,mBAAmB,OAAO,iBAC3B;GACD,GAAI,OAAO,eAAe,UAAa,EACrC,aAAa,OAAO,WACrB;EACF;EACH,KAAK,IACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,qBAAqB,UAAa,EAC3C,oBAAoB,OAAO,iBAC5B;GACD,GAAI,OAAO,qBAAqB,UAAa,EAC3C,oBAAoB,OAAO,iBAC5B;GACD,GAAI,OAAO,sBAAsB,UAAa,EAC5C,qBAAqB,OAAO,kBAC7B;GACD,GAAI,OAAO,kBAAkB,UAAa,EACxC,iBAAiB,OAAO,cACzB;EACF;EACH,KAAK,MACH,QAAO;GACL,MAAM;GACN,OAAO,OAAO;EACf;EACH,SAAS;GACP,MAAMC,cAAqB;AAC3B,UAAO;EACR;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;AA0BD,SAAgB,cACdC,UAAoC,CAAE,GACnB;AACnB,QAAO;EACL,MAAM;EACN,MAAM;EACN,MAAM,SAAS;EACf,oBAAoB,SAAS;EAC7B,WAAW,SAAS;EACpB,SAAS,SAAS;EAClB,kBAAkB,SAAS;EAC3B,SAAS,SAAS,SAAS,IAAI,4BAA4B;CAC5D;AACF"}
+{"version":3,"file":"live_search.cjs","names":["source: XAISearchToolSource","_exhaustive: never","options: XAILiveSearchToolOptions"],"sources":["../../src/tools/live_search.ts"],"sourcesContent":["import type { XAISearchParameters, XAISearchSource } from \"../live_search.js\";\n\n/**\n * xAI's deprecated live_search tool type.\n */\nexport const XAI_LIVE_SEARCH_TOOL_TYPE = \"live_search_deprecated_20251215\";\nexport const XAI_LIVE_SEARCH_TOOL_NAME = \"live_search\";\n\n/**\n * xAI's built-in live_search tool type.\n * Enables the model to search the web for real-time information.\n */\nexport interface XAILiveSearchTool extends XAISearchParameters {\n  /**\n   * The name of the tool. Must be \"live_search\" for xAI's built-in search.\n   */\n  name: typeof XAI_LIVE_SEARCH_TOOL_NAME;\n  /**\n   * The type of the tool. This uses a deprecated Live Search API shape:\n   * the advanced agentic search capabilities powering grok.com are generally\n   * available in the new agentic tool calling API, and the Live Search API\n   * will be deprecated by December 15, 2025.\n   */\n  type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;\n}\n\n/**\n * Web search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIWebSource` internally.\n */\nexport interface XAIWebSearchToolSource {\n  type: \"web\";\n  country?: string;\n  excludedWebsites?: string[];\n  allowedWebsites?: string[];\n  safeSearch?: boolean;\n}\n\n/**\n * News search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAINewsSource` internally.\n */\nexport interface XAINewsSearchToolSource {\n  type: \"news\";\n  country?: string;\n  excludedWebsites?: string[];\n  safeSearch?: boolean;\n}\n\n/**\n * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIXSource` internally.\n */\nexport interface XAIXSearchToolSource {\n  type: \"x\";\n  includedXHandles?: string[];\n  excludedXHandles?: string[];\n  postFavoriteCount?: number;\n  postViewCount?: number;\n}\n\n/**\n * RSS feed search source configuration for the xAI live search tool.\n * The structure matches `XAIRssSource` (only `links`).\n */\nexport interface XAIRssSearchToolSource {\n  type: \"rss\";\n  links: string[];\n}\n\nexport type XAISearchToolSource =\n  | XAIWebSearchToolSource\n  | XAINewsSearchToolSource\n  | XAIXSearchToolSource\n  | XAIRssSearchToolSource;\n\n/**\n * Options for the xAI live search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the underlying `XAISearchParameters`\n * object that is sent to xAI's deprecated Live Search API.\n */\nexport interface XAILiveSearchToolOptions {\n  /**\n   * Controls when the model should perform a search.\n   * - \"auto\": Let the model decide when to search (default)\n   * - \"on\": Always search for every request\n   * - \"off\": Never search\n   */\n  mode?: \"auto\" | \"on\" | \"off\";\n  /**\n   * Maximum number of search results to return.\n   * @default 20\n   */\n  maxSearchResults?: number;\n  /**\n   * Filter search results to only include content from after this date.\n   * Format: ISO 8601 date string (e.g., \"2024-01-01\")\n   */\n  fromDate?: string;\n  /**\n   * Filter search results to only include content from before this date.\n   * Format: ISO 8601 date string (e.g., \"2024-12-31\")\n   */\n  toDate?: string;\n  /**\n   * Whether to return citations/sources for the search results.\n   * @default true\n   */\n  returnCitations?: boolean;\n  /**\n   * Specific web/news/X/RSS sources that can be used for the search.\n   * These are converted to the snake_case `XAISearchSource` structures\n   * used by the underlying xAI Live Search API.\n   */\n  sources?: XAISearchToolSource[];\n}\n\nfunction mapToolSourceToSearchSource(\n  source: XAISearchToolSource\n): XAISearchSource {\n  switch (source.type) {\n    case \"web\":\n      return {\n        type: \"web\",\n        ...(source.country !== undefined && { country: source.country }),\n        ...(source.allowedWebsites !== undefined && {\n          allowed_websites: source.allowedWebsites,\n        }),\n        ...(source.excludedWebsites !== undefined && {\n          excluded_websites: source.excludedWebsites,\n        }),\n        ...(source.safeSearch !== undefined && {\n          safe_search: source.safeSearch,\n        }),\n      };\n    case \"news\":\n      return {\n        type: \"news\",\n        ...(source.country !== undefined && { country: source.country }),\n        ...(source.excludedWebsites !== undefined && {\n          excluded_websites: source.excludedWebsites,\n        }),\n        ...(source.safeSearch !== undefined && {\n          safe_search: source.safeSearch,\n        }),\n      };\n    case \"x\":\n      return {\n        type: \"x\",\n        ...(source.includedXHandles !== undefined && {\n          included_x_handles: source.includedXHandles,\n        }),\n        ...(source.excludedXHandles !== undefined && {\n          excluded_x_handles: source.excludedXHandles,\n        }),\n        ...(source.postFavoriteCount !== undefined && {\n          post_favorite_count: source.postFavoriteCount,\n        }),\n        ...(source.postViewCount !== undefined && {\n          post_view_count: source.postViewCount,\n        }),\n      };\n    case \"rss\":\n      return {\n        type: \"rss\",\n        links: source.links,\n      };\n    default: {\n      const _exhaustive: never = source;\n      return _exhaustive;\n    }\n  }\n}\n\n/**\n * Creates an xAI built-in live search tool.\n * Enables the model to search the web for real-time information.\n *\n * This tool is executed server-side by the xAI API.\n *\n * @deprecated The Live Search API was deprecated by xAI on December 15, 2025.\n * Use the new agentic tool calling API instead with `xaiWebSearch()` and `xaiXSearch()`.\n *\n * @example Migration to new tools:\n * ```typescript\n * // Old (deprecated):\n * const searchTool = tools.xaiLiveSearch({ maxSearchResults: 5 });\n *\n * // New (recommended):\n * const webSearch = tools.xaiWebSearch({ allowedDomains: [\"example.com\"] });\n * const xSearch = tools.xaiXSearch({ allowedXHandles: [\"elonmusk\"] });\n * ```\n *\n * @example\n * ```typescript\n * import { ChatXAI, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAI({\n *   model: \"grok-beta\",\n * });\n *\n * const searchTool = tools.xaiLiveSearch({\n *   maxSearchResults: 5,\n *   fromDate: \"2024-01-01\",\n *   returnCitations: true\n * });\n *\n * const llmWithSearch = llm.bindTools([searchTool]);\n * const result = await llmWithSearch.invoke(\"What happened in tech today?\");\n * ```\n */\nexport function xaiLiveSearch(\n  options: XAILiveSearchToolOptions = {}\n): XAILiveSearchTool {\n  return {\n    type: XAI_LIVE_SEARCH_TOOL_TYPE,\n    name: XAI_LIVE_SEARCH_TOOL_NAME,\n    mode: options?.mode,\n    max_search_results: options?.maxSearchResults,\n    from_date: options?.fromDate,\n    to_date: options?.toDate,\n    return_citations: options?.returnCitations,\n    sources: options?.sources?.map(mapToolSourceToSearchSource),\n  } satisfies XAILiveSearchTool;\n}\n"],"mappings":";;;;;AAKA,MAAa,4BAA4B;AACzC,MAAa,4BAA4B;AAgHzC,SAAS,4BACPA,QACiB;AACjB,SAAQ,OAAO,MAAf;EACE,KAAK,MACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,YAAY,UAAa,EAAE,SAAS,OAAO,QAAS;GAC/D,GAAI,OAAO,oBAAoB,UAAa,EAC1C,kBAAkB,OAAO,gBAC1B;GACD,GAAI,OAAO,qBAAqB,UAAa,EAC3C,mBAAmB,OAAO,iBAC3B;GACD,GAAI,OAAO,eAAe,UAAa,EACrC,aAAa,OAAO,WACrB;EACF;EACH,KAAK,OACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,YAAY,UAAa,EAAE,SAAS,OAAO,QAAS;GAC/D,GAAI,OAAO,qBAAqB,UAAa,EAC3C,mBAAmB,OAAO,iBAC3B;GACD,GAAI,OAAO,eAAe,UAAa,EACrC,aAAa,OAAO,WACrB;EACF;EACH,KAAK,IACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,qBAAqB,UAAa,EAC3C,oBAAoB,OAAO,iBAC5B;GACD,GAAI,OAAO,qBAAqB,UAAa,EAC3C,oBAAoB,OAAO,iBAC5B;GACD,GAAI,OAAO,sBAAsB,UAAa,EAC5C,qBAAqB,OAAO,kBAC7B;GACD,GAAI,OAAO,kBAAkB,UAAa,EACxC,iBAAiB,OAAO,cACzB;EACF;EACH,KAAK,MACH,QAAO;GACL,MAAM;GACN,OAAO,OAAO;EACf;EACH,SAAS;GACP,MAAMC,cAAqB;AAC3B,UAAO;EACR;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCD,SAAgB,cACdC,UAAoC,CAAE,GACnB;AACnB,QAAO;EACL,MAAM;EACN,MAAM;EACN,MAAM,SAAS;EACf,oBAAoB,SAAS;EAC7B,WAAW,SAAS;EACpB,SAAS,SAAS;EAClB,kBAAkB,SAAS;EAC3B,SAAS,SAAS,SAAS,IAAI,4BAA4B;CAC5D;AACF"}

package/dist/tools/live_search.d.cts

@@ -112,6 +112,19 @@ interface XAILiveSearchToolOptions {
  *
  * This tool is executed server-side by the xAI API.
  *
+ * @deprecated The Live Search API was deprecated by xAI on December 15, 2025.
+ * Use the new agentic tool calling API instead with `xaiWebSearch()` and `xaiXSearch()`.
+ *
+ * @example Migration to new tools:
+ * ```typescript
+ * // Old (deprecated):
+ * const searchTool = tools.xaiLiveSearch({ maxSearchResults: 5 });
+ *
+ * // New (recommended):
+ * const webSearch = tools.xaiWebSearch({ allowedDomains: ["example.com"] });
+ * const xSearch = tools.xaiXSearch({ allowedXHandles: ["elonmusk"] });
+ * ```
+ *
  * @example
  * ```typescript
  * import { ChatXAI, tools } from "@langchain/xai";
@@ -132,5 +145,5 @@ interface XAILiveSearchToolOptions {
  */
 declare function xaiLiveSearch(options?: XAILiveSearchToolOptions): XAILiveSearchTool;
 //#endregion
-export { XAILiveSearchTool, xaiLiveSearch };
+export { XAILiveSearchTool, XAILiveSearchToolOptions, XAI_LIVE_SEARCH_TOOL_NAME, XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch };
 //# sourceMappingURL=live_search.d.cts.map

package/dist/tools/live_search.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"live_search.d.cts","names":["XAISearchParameters","XAI_LIVE_SEARCH_TOOL_TYPE","XAI_LIVE_SEARCH_TOOL_NAME","XAILiveSearchTool","XAIWebSearchToolSource","XAINewsSearchToolSource","XAIXSearchToolSource","XAIRssSearchToolSource","XAISearchToolSource","XAILiveSearchToolOptions","xaiLiveSearch"],"sources":["../../src/tools/live_search.d.ts"],"sourcesContent":["import type { XAISearchParameters } from \"../live_search.js\";\n/**\n * xAI's deprecated live_search tool type.\n */\nexport declare const XAI_LIVE_SEARCH_TOOL_TYPE = \"live_search_deprecated_20251215\";\nexport declare const XAI_LIVE_SEARCH_TOOL_NAME = \"live_search\";\n/**\n * xAI's built-in live_search tool type.\n * Enables the model to search the web for real-time information.\n */\nexport interface XAILiveSearchTool extends XAISearchParameters {\n    /**\n     * The name of the tool. Must be \"live_search\" for xAI's built-in search.\n     */\n    name: typeof XAI_LIVE_SEARCH_TOOL_NAME;\n    /**\n     * The type of the tool. This uses a deprecated Live Search API shape:\n     * the advanced agentic search capabilities powering grok.com are generally\n     * available in the new agentic tool calling API, and the Live Search API\n     * will be deprecated by December 15, 2025.\n     */\n    type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;\n}\n/**\n * Web search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIWebSource` internally.\n */\nexport interface XAIWebSearchToolSource {\n    type: \"web\";\n    country?: string;\n    excludedWebsites?: string[];\n    allowedWebsites?: string[];\n    safeSearch?: boolean;\n}\n/**\n * News search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAINewsSource` internally.\n */\nexport interface XAINewsSearchToolSource {\n    type: \"news\";\n    country?: string;\n    excludedWebsites?: string[];\n    safeSearch?: boolean;\n}\n/**\n * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIXSource` internally.\n */\nexport interface XAIXSearchToolSource {\n    type: \"x\";\n    includedXHandles?: string[];\n    excludedXHandles?: string[];\n    postFavoriteCount?: number;\n    postViewCount?: number;\n}\n/**\n * RSS feed search source configuration for the xAI live search tool.\n * The structure matches `XAIRssSource` (only `links`).\n */\nexport interface XAIRssSearchToolSource {\n    type: \"rss\";\n    links: string[];\n}\nexport type XAISearchToolSource = XAIWebSearchToolSource | XAINewsSearchToolSource | XAIXSearchToolSource | XAIRssSearchToolSource;\n/**\n * Options for the xAI live search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the underlying `XAISearchParameters`\n * object that is sent to xAI's deprecated Live Search API.\n */\nexport interface XAILiveSearchToolOptions {\n    /**\n     * Controls when the model should perform a search.\n     * - \"auto\": Let the model decide when to search (default)\n     * - \"on\": Always search for every request\n     * - \"off\": Never search\n     */\n    mode?: \"auto\" | \"on\" | \"off\";\n    /**\n     * Maximum number of search results to return.\n     * @default 20\n     */\n    maxSearchResults?: number;\n    /**\n     * Filter search results to only include content from after this date.\n     * Format: ISO 8601 date string (e.g., \"2024-01-01\")\n     */\n    fromDate?: string;\n    /**\n     * Filter search results to only include content from before this date.\n     * Format: ISO 8601 date string (e.g., \"2024-12-31\")\n     */\n    toDate?: string;\n    /**\n     * Whether to return citations/sources for the search results.\n     * @default true\n     */\n    returnCitations?: boolean;\n    /**\n     * Specific web/news/X/RSS sources that can be used for the search.\n     * These are converted to the snake_case `XAISearchSource` structures\n     * used by the underlying xAI Live Search API.\n     */\n    sources?: XAISearchToolSource[];\n}\n/**\n * Creates an xAI built-in live search tool.\n * Enables the model to search the web for real-time information.\n *\n * This tool is executed server-side by the xAI API.\n *\n * @example\n * ```typescript\n * import { ChatXAI, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAI({\n *   model: \"grok-beta\",\n * });\n *\n * const searchTool = tools.xaiLiveSearch({\n *   maxSearchResults: 5,\n *   fromDate: \"2024-01-01\",\n *   returnCitations: true\n * });\n *\n * const llmWithSearch = llm.bindTools([searchTool]);\n * const result = await llmWithSearch.invoke(\"What happened in tech today?\");\n * ```\n */\nexport declare function xaiLiveSearch(options?: XAILiveSearchToolOptions): XAILiveSearchTool;\n//# sourceMappingURL=live_search.d.ts.map"],"mappings":";;;;;;AAIA;AACqBE,cADAD,yBAAAA,GACyB,iCAAA;AAK7BE,cALID,yBAAAA,GAKa,aAAA;;;;AAA4B;AAiB7CE,UAjBAD,iBAAAA,SAA0BH,mBAiBJ,CAAA;EAWtBK;AAUjB;AAWA;EAIYG,IAAAA,EAAAA,OAjDKN,yBAiDc;EAAGE;;;;AAAgG;AAOlI;EA2DwBM,IAAAA,EAAAA,OA5GPT,yBA4G+BQ;;;;;;UAtG/BL,sBAAAA;;;;;;;;;;;UAWAC,uBAAAA;;;;;;;;;;UAUAC,oBAAAA;;;;;;;;;;;UAWAC,sBAAAA;;;;KAILC,mBAAAA,GAAsBJ,yBAAyBC,0BAA0BC,uBAAuBC;;;;;;;UAO3FE,wBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAiCHD;;;;;;;;;;;;;;;;;;;;;;;;;;iBA0BUE,aAAAA,WAAwBD,2BAA2BN"}
+{"version":3,"file":"live_search.d.cts","names":["XAISearchParameters","XAI_LIVE_SEARCH_TOOL_TYPE","XAI_LIVE_SEARCH_TOOL_NAME","XAILiveSearchTool","XAIWebSearchToolSource","XAINewsSearchToolSource","XAIXSearchToolSource","XAIRssSearchToolSource","XAISearchToolSource","XAILiveSearchToolOptions","xaiLiveSearch"],"sources":["../../src/tools/live_search.d.ts"],"sourcesContent":["import type { XAISearchParameters } from \"../live_search.js\";\n/**\n * xAI's deprecated live_search tool type.\n */\nexport declare const XAI_LIVE_SEARCH_TOOL_TYPE = \"live_search_deprecated_20251215\";\nexport declare const XAI_LIVE_SEARCH_TOOL_NAME = \"live_search\";\n/**\n * xAI's built-in live_search tool type.\n * Enables the model to search the web for real-time information.\n */\nexport interface XAILiveSearchTool extends XAISearchParameters {\n    /**\n     * The name of the tool. Must be \"live_search\" for xAI's built-in search.\n     */\n    name: typeof XAI_LIVE_SEARCH_TOOL_NAME;\n    /**\n     * The type of the tool. This uses a deprecated Live Search API shape:\n     * the advanced agentic search capabilities powering grok.com are generally\n     * available in the new agentic tool calling API, and the Live Search API\n     * will be deprecated by December 15, 2025.\n     */\n    type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;\n}\n/**\n * Web search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIWebSource` internally.\n */\nexport interface XAIWebSearchToolSource {\n    type: \"web\";\n    country?: string;\n    excludedWebsites?: string[];\n    allowedWebsites?: string[];\n    safeSearch?: boolean;\n}\n/**\n * News search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAINewsSource` internally.\n */\nexport interface XAINewsSearchToolSource {\n    type: \"news\";\n    country?: string;\n    excludedWebsites?: string[];\n    safeSearch?: boolean;\n}\n/**\n * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIXSource` internally.\n */\nexport interface XAIXSearchToolSource {\n    type: \"x\";\n    includedXHandles?: string[];\n    excludedXHandles?: string[];\n    postFavoriteCount?: number;\n    postViewCount?: number;\n}\n/**\n * RSS feed search source configuration for the xAI live search tool.\n * The structure matches `XAIRssSource` (only `links`).\n */\nexport interface XAIRssSearchToolSource {\n    type: \"rss\";\n    links: string[];\n}\nexport type XAISearchToolSource = XAIWebSearchToolSource | XAINewsSearchToolSource | XAIXSearchToolSource | XAIRssSearchToolSource;\n/**\n * Options for the xAI live search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the underlying `XAISearchParameters`\n * object that is sent to xAI's deprecated Live Search API.\n */\nexport interface XAILiveSearchToolOptions {\n    /**\n     * Controls when the model should perform a search.\n     * - \"auto\": Let the model decide when to search (default)\n     * - \"on\": Always search for every request\n     * - \"off\": Never search\n     */\n    mode?: \"auto\" | \"on\" | \"off\";\n    /**\n     * Maximum number of search results to return.\n     * @default 20\n     */\n    maxSearchResults?: number;\n    /**\n     * Filter search results to only include content from after this date.\n     * Format: ISO 8601 date string (e.g., \"2024-01-01\")\n     */\n    fromDate?: string;\n    /**\n     * Filter search results to only include content from before this date.\n     * Format: ISO 8601 date string (e.g., \"2024-12-31\")\n     */\n    toDate?: string;\n    /**\n     * Whether to return citations/sources for the search results.\n     * @default true\n     */\n    returnCitations?: boolean;\n    /**\n     * Specific web/news/X/RSS sources that can be used for the search.\n     * These are converted to the snake_case `XAISearchSource` structures\n     * used by the underlying xAI Live Search API.\n     */\n    sources?: XAISearchToolSource[];\n}\n/**\n * Creates an xAI built-in live search tool.\n * Enables the model to search the web for real-time information.\n *\n * This tool is executed server-side by the xAI API.\n *\n * @deprecated The Live Search API was deprecated by xAI on December 15, 2025.\n * Use the new agentic tool calling API instead with `xaiWebSearch()` and `xaiXSearch()`.\n *\n * @example Migration to new tools:\n * ```typescript\n * // Old (deprecated):\n * const searchTool = tools.xaiLiveSearch({ maxSearchResults: 5 });\n *\n * // New (recommended):\n * const webSearch = tools.xaiWebSearch({ allowedDomains: [\"example.com\"] });\n * const xSearch = tools.xaiXSearch({ allowedXHandles: [\"elonmusk\"] });\n * ```\n *\n * @example\n * ```typescript\n * import { ChatXAI, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAI({\n *   model: \"grok-beta\",\n * });\n *\n * const searchTool = tools.xaiLiveSearch({\n *   maxSearchResults: 5,\n *   fromDate: \"2024-01-01\",\n *   returnCitations: true\n * });\n *\n * const llmWithSearch = llm.bindTools([searchTool]);\n * const result = await llmWithSearch.invoke(\"What happened in tech today?\");\n * ```\n */\nexport declare function xaiLiveSearch(options?: XAILiveSearchToolOptions): XAILiveSearchTool;\n//# sourceMappingURL=live_search.d.ts.map"],"mappings":";;;;;;AAIA;AACqBE,cADAD,yBAAAA,GACyB,iCAAA;AAK7BE,cALID,yBAAAA,GAKa,aAAA;;;;AAA4B;AAiB7CE,UAjBAD,iBAAAA,SAA0BH,mBAiBJ,CAAA;EAWtBK;AAUjB;AAWA;EAIYG,IAAAA,EAAAA,OAjDKN,yBAiDc;EAAGE;;;;AAAgG;AAOlI;EAwEwBM,IAAAA,EAAAA,OAzHPT,yBAyH+BQ;;;;;;UAnH/BL,sBAAAA;;;;;;;;;;;UAWAC,uBAAAA;;;;;;;;;;UAUAC,oBAAAA;;;;;;;;;;;UAWAC,sBAAAA;;;;KAILC,mBAAAA,GAAsBJ,yBAAyBC,0BAA0BC,uBAAuBC;;;;;;;UAO3FE,wBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAiCHD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuCUE,aAAAA,WAAwBD,2BAA2BN"}

package/dist/tools/live_search.d.ts

@@ -112,6 +112,19 @@ interface XAILiveSearchToolOptions {
  *
  * This tool is executed server-side by the xAI API.
  *
+ * @deprecated The Live Search API was deprecated by xAI on December 15, 2025.
+ * Use the new agentic tool calling API instead with `xaiWebSearch()` and `xaiXSearch()`.
+ *
+ * @example Migration to new tools:
+ * ```typescript
+ * // Old (deprecated):
+ * const searchTool = tools.xaiLiveSearch({ maxSearchResults: 5 });
+ *
+ * // New (recommended):
+ * const webSearch = tools.xaiWebSearch({ allowedDomains: ["example.com"] });
+ * const xSearch = tools.xaiXSearch({ allowedXHandles: ["elonmusk"] });
+ * ```
+ *
  * @example
  * ```typescript
  * import { ChatXAI, tools } from "@langchain/xai";
@@ -132,5 +145,5 @@ interface XAILiveSearchToolOptions {
  */
 declare function xaiLiveSearch(options?: XAILiveSearchToolOptions): XAILiveSearchTool;
 //#endregion
-export { XAILiveSearchTool, xaiLiveSearch };
+export { XAILiveSearchTool, XAILiveSearchToolOptions, XAI_LIVE_SEARCH_TOOL_NAME, XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch };
 //# sourceMappingURL=live_search.d.ts.map

package/dist/tools/live_search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"live_search.d.ts","names":["XAISearchParameters","XAI_LIVE_SEARCH_TOOL_TYPE","XAI_LIVE_SEARCH_TOOL_NAME","XAILiveSearchTool","XAIWebSearchToolSource","XAINewsSearchToolSource","XAIXSearchToolSource","XAIRssSearchToolSource","XAISearchToolSource","XAILiveSearchToolOptions","xaiLiveSearch"],"sources":["../../src/tools/live_search.d.ts"],"sourcesContent":["import type { XAISearchParameters } from \"../live_search.js\";\n/**\n * xAI's deprecated live_search tool type.\n */\nexport declare const XAI_LIVE_SEARCH_TOOL_TYPE = \"live_search_deprecated_20251215\";\nexport declare const XAI_LIVE_SEARCH_TOOL_NAME = \"live_search\";\n/**\n * xAI's built-in live_search tool type.\n * Enables the model to search the web for real-time information.\n */\nexport interface XAILiveSearchTool extends XAISearchParameters {\n    /**\n     * The name of the tool. Must be \"live_search\" for xAI's built-in search.\n     */\n    name: typeof XAI_LIVE_SEARCH_TOOL_NAME;\n    /**\n     * The type of the tool. This uses a deprecated Live Search API shape:\n     * the advanced agentic search capabilities powering grok.com are generally\n     * available in the new agentic tool calling API, and the Live Search API\n     * will be deprecated by December 15, 2025.\n     */\n    type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;\n}\n/**\n * Web search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIWebSource` internally.\n */\nexport interface XAIWebSearchToolSource {\n    type: \"web\";\n    country?: string;\n    excludedWebsites?: string[];\n    allowedWebsites?: string[];\n    safeSearch?: boolean;\n}\n/**\n * News search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAINewsSource` internally.\n */\nexport interface XAINewsSearchToolSource {\n    type: \"news\";\n    country?: string;\n    excludedWebsites?: string[];\n    safeSearch?: boolean;\n}\n/**\n * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIXSource` internally.\n */\nexport interface XAIXSearchToolSource {\n    type: \"x\";\n    includedXHandles?: string[];\n    excludedXHandles?: string[];\n    postFavoriteCount?: number;\n    postViewCount?: number;\n}\n/**\n * RSS feed search source configuration for the xAI live search tool.\n * The structure matches `XAIRssSource` (only `links`).\n */\nexport interface XAIRssSearchToolSource {\n    type: \"rss\";\n    links: string[];\n}\nexport type XAISearchToolSource = XAIWebSearchToolSource | XAINewsSearchToolSource | XAIXSearchToolSource | XAIRssSearchToolSource;\n/**\n * Options for the xAI live search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the underlying `XAISearchParameters`\n * object that is sent to xAI's deprecated Live Search API.\n */\nexport interface XAILiveSearchToolOptions {\n    /**\n     * Controls when the model should perform a search.\n     * - \"auto\": Let the model decide when to search (default)\n     * - \"on\": Always search for every request\n     * - \"off\": Never search\n     */\n    mode?: \"auto\" | \"on\" | \"off\";\n    /**\n     * Maximum number of search results to return.\n     * @default 20\n     */\n    maxSearchResults?: number;\n    /**\n     * Filter search results to only include content from after this date.\n     * Format: ISO 8601 date string (e.g., \"2024-01-01\")\n     */\n    fromDate?: string;\n    /**\n     * Filter search results to only include content from before this date.\n     * Format: ISO 8601 date string (e.g., \"2024-12-31\")\n     */\n    toDate?: string;\n    /**\n     * Whether to return citations/sources for the search results.\n     * @default true\n     */\n    returnCitations?: boolean;\n    /**\n     * Specific web/news/X/RSS sources that can be used for the search.\n     * These are converted to the snake_case `XAISearchSource` structures\n     * used by the underlying xAI Live Search API.\n     */\n    sources?: XAISearchToolSource[];\n}\n/**\n * Creates an xAI built-in live search tool.\n * Enables the model to search the web for real-time information.\n *\n * This tool is executed server-side by the xAI API.\n *\n * @example\n * ```typescript\n * import { ChatXAI, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAI({\n *   model: \"grok-beta\",\n * });\n *\n * const searchTool = tools.xaiLiveSearch({\n *   maxSearchResults: 5,\n *   fromDate: \"2024-01-01\",\n *   returnCitations: true\n * });\n *\n * const llmWithSearch = llm.bindTools([searchTool]);\n * const result = await llmWithSearch.invoke(\"What happened in tech today?\");\n * ```\n */\nexport declare function xaiLiveSearch(options?: XAILiveSearchToolOptions): XAILiveSearchTool;\n//# sourceMappingURL=live_search.d.ts.map"],"mappings":";;;;;;AAIA;AACqBE,cADAD,yBAAAA,GACyB,iCAAA;AAK7BE,cALID,yBAAAA,GAKa,aAAA;;;;AAA4B;AAiB7CE,UAjBAD,iBAAAA,SAA0BH,mBAiBJ,CAAA;EAWtBK;AAUjB;AAWA;EAIYG,IAAAA,EAAAA,OAjDKN,yBAiDc;EAAGE;;;;AAAgG;AAOlI;EA2DwBM,IAAAA,EAAAA,OA5GPT,yBA4G+BQ;;;;;;UAtG/BL,sBAAAA;;;;;;;;;;;UAWAC,uBAAAA;;;;;;;;;;UAUAC,oBAAAA;;;;;;;;;;;UAWAC,sBAAAA;;;;KAILC,mBAAAA,GAAsBJ,yBAAyBC,0BAA0BC,uBAAuBC;;;;;;;UAO3FE,wBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAiCHD;;;;;;;;;;;;;;;;;;;;;;;;;;iBA0BUE,aAAAA,WAAwBD,2BAA2BN"}
+{"version":3,"file":"live_search.d.ts","names":["XAISearchParameters","XAI_LIVE_SEARCH_TOOL_TYPE","XAI_LIVE_SEARCH_TOOL_NAME","XAILiveSearchTool","XAIWebSearchToolSource","XAINewsSearchToolSource","XAIXSearchToolSource","XAIRssSearchToolSource","XAISearchToolSource","XAILiveSearchToolOptions","xaiLiveSearch"],"sources":["../../src/tools/live_search.d.ts"],"sourcesContent":["import type { XAISearchParameters } from \"../live_search.js\";\n/**\n * xAI's deprecated live_search tool type.\n */\nexport declare const XAI_LIVE_SEARCH_TOOL_TYPE = \"live_search_deprecated_20251215\";\nexport declare const XAI_LIVE_SEARCH_TOOL_NAME = \"live_search\";\n/**\n * xAI's built-in live_search tool type.\n * Enables the model to search the web for real-time information.\n */\nexport interface XAILiveSearchTool extends XAISearchParameters {\n    /**\n     * The name of the tool. Must be \"live_search\" for xAI's built-in search.\n     */\n    name: typeof XAI_LIVE_SEARCH_TOOL_NAME;\n    /**\n     * The type of the tool. This uses a deprecated Live Search API shape:\n     * the advanced agentic search capabilities powering grok.com are generally\n     * available in the new agentic tool calling API, and the Live Search API\n     * will be deprecated by December 15, 2025.\n     */\n    type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;\n}\n/**\n * Web search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIWebSource` internally.\n */\nexport interface XAIWebSearchToolSource {\n    type: \"web\";\n    country?: string;\n    excludedWebsites?: string[];\n    allowedWebsites?: string[];\n    safeSearch?: boolean;\n}\n/**\n * News search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAINewsSource` internally.\n */\nexport interface XAINewsSearchToolSource {\n    type: \"news\";\n    country?: string;\n    excludedWebsites?: string[];\n    safeSearch?: boolean;\n}\n/**\n * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIXSource` internally.\n */\nexport interface XAIXSearchToolSource {\n    type: \"x\";\n    includedXHandles?: string[];\n    excludedXHandles?: string[];\n    postFavoriteCount?: number;\n    postViewCount?: number;\n}\n/**\n * RSS feed search source configuration for the xAI live search tool.\n * The structure matches `XAIRssSource` (only `links`).\n */\nexport interface XAIRssSearchToolSource {\n    type: \"rss\";\n    links: string[];\n}\nexport type XAISearchToolSource = XAIWebSearchToolSource | XAINewsSearchToolSource | XAIXSearchToolSource | XAIRssSearchToolSource;\n/**\n * Options for the xAI live search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the underlying `XAISearchParameters`\n * object that is sent to xAI's deprecated Live Search API.\n */\nexport interface XAILiveSearchToolOptions {\n    /**\n     * Controls when the model should perform a search.\n     * - \"auto\": Let the model decide when to search (default)\n     * - \"on\": Always search for every request\n     * - \"off\": Never search\n     */\n    mode?: \"auto\" | \"on\" | \"off\";\n    /**\n     * Maximum number of search results to return.\n     * @default 20\n     */\n    maxSearchResults?: number;\n    /**\n     * Filter search results to only include content from after this date.\n     * Format: ISO 8601 date string (e.g., \"2024-01-01\")\n     */\n    fromDate?: string;\n    /**\n     * Filter search results to only include content from before this date.\n     * Format: ISO 8601 date string (e.g., \"2024-12-31\")\n     */\n    toDate?: string;\n    /**\n     * Whether to return citations/sources for the search results.\n     * @default true\n     */\n    returnCitations?: boolean;\n    /**\n     * Specific web/news/X/RSS sources that can be used for the search.\n     * These are converted to the snake_case `XAISearchSource` structures\n     * used by the underlying xAI Live Search API.\n     */\n    sources?: XAISearchToolSource[];\n}\n/**\n * Creates an xAI built-in live search tool.\n * Enables the model to search the web for real-time information.\n *\n * This tool is executed server-side by the xAI API.\n *\n * @deprecated The Live Search API was deprecated by xAI on December 15, 2025.\n * Use the new agentic tool calling API instead with `xaiWebSearch()` and `xaiXSearch()`.\n *\n * @example Migration to new tools:\n * ```typescript\n * // Old (deprecated):\n * const searchTool = tools.xaiLiveSearch({ maxSearchResults: 5 });\n *\n * // New (recommended):\n * const webSearch = tools.xaiWebSearch({ allowedDomains: [\"example.com\"] });\n * const xSearch = tools.xaiXSearch({ allowedXHandles: [\"elonmusk\"] });\n * ```\n *\n * @example\n * ```typescript\n * import { ChatXAI, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAI({\n *   model: \"grok-beta\",\n * });\n *\n * const searchTool = tools.xaiLiveSearch({\n *   maxSearchResults: 5,\n *   fromDate: \"2024-01-01\",\n *   returnCitations: true\n * });\n *\n * const llmWithSearch = llm.bindTools([searchTool]);\n * const result = await llmWithSearch.invoke(\"What happened in tech today?\");\n * ```\n */\nexport declare function xaiLiveSearch(options?: XAILiveSearchToolOptions): XAILiveSearchTool;\n//# sourceMappingURL=live_search.d.ts.map"],"mappings":";;;;;;AAIA;AACqBE,cADAD,yBAAAA,GACyB,iCAAA;AAK7BE,cALID,yBAAAA,GAKa,aAAA;;;;AAA4B;AAiB7CE,UAjBAD,iBAAAA,SAA0BH,mBAiBJ,CAAA;EAWtBK;AAUjB;AAWA;EAIYG,IAAAA,EAAAA,OAjDKN,yBAiDc;EAAGE;;;;AAAgG;AAOlI;EAwEwBM,IAAAA,EAAAA,OAzHPT,yBAyH+BQ;;;;;;UAnH/BL,sBAAAA;;;;;;;;;;;UAWAC,uBAAAA;;;;;;;;;;UAUAC,oBAAAA;;;;;;;;;;;UAWAC,sBAAAA;;;;KAILC,mBAAAA,GAAsBJ,yBAAyBC,0BAA0BC,uBAAuBC;;;;;;;UAO3FE,wBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAiCHD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuCUE,aAAAA,WAAwBD,2BAA2BN"}

package/dist/tools/live_search.js

@@ -42,6 +42,19 @@ function mapToolSourceToSearchSource(source) {
 *
 * This tool is executed server-side by the xAI API.
 *
+* @deprecated The Live Search API was deprecated by xAI on December 15, 2025.
+* Use the new agentic tool calling API instead with `xaiWebSearch()` and `xaiXSearch()`.
+*
+* @example Migration to new tools:
+* ```typescript
+* // Old (deprecated):
+* const searchTool = tools.xaiLiveSearch({ maxSearchResults: 5 });
+*
+* // New (recommended):
+* const webSearch = tools.xaiWebSearch({ allowedDomains: ["example.com"] });
+* const xSearch = tools.xaiXSearch({ allowedXHandles: ["elonmusk"] });
+* ```
+*
 * @example
 * ```typescript
 * import { ChatXAI, tools } from "@langchain/xai";
@@ -74,5 +87,5 @@ function xaiLiveSearch(options = {}) {
 }
 
 //#endregion
-export { XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch };
+export { XAI_LIVE_SEARCH_TOOL_NAME, XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch };
 //# sourceMappingURL=live_search.js.map

package/dist/tools/live_search.js.map

@@ -1 +1 @@
-{"version":3,"file":"live_search.js","names":["source: XAISearchToolSource","_exhaustive: never","options: XAILiveSearchToolOptions"],"sources":["../../src/tools/live_search.ts"],"sourcesContent":["import type { XAISearchParameters, XAISearchSource } from \"../live_search.js\";\n\n/**\n * xAI's deprecated live_search tool type.\n */\nexport const XAI_LIVE_SEARCH_TOOL_TYPE = \"live_search_deprecated_20251215\";\nexport const XAI_LIVE_SEARCH_TOOL_NAME = \"live_search\";\n\n/**\n * xAI's built-in live_search tool type.\n * Enables the model to search the web for real-time information.\n */\nexport interface XAILiveSearchTool extends XAISearchParameters {\n  /**\n   * The name of the tool. Must be \"live_search\" for xAI's built-in search.\n   */\n  name: typeof XAI_LIVE_SEARCH_TOOL_NAME;\n  /**\n   * The type of the tool. This uses a deprecated Live Search API shape:\n   * the advanced agentic search capabilities powering grok.com are generally\n   * available in the new agentic tool calling API, and the Live Search API\n   * will be deprecated by December 15, 2025.\n   */\n  type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;\n}\n\n/**\n * Web search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIWebSource` internally.\n */\nexport interface XAIWebSearchToolSource {\n  type: \"web\";\n  country?: string;\n  excludedWebsites?: string[];\n  allowedWebsites?: string[];\n  safeSearch?: boolean;\n}\n\n/**\n * News search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAINewsSource` internally.\n */\nexport interface XAINewsSearchToolSource {\n  type: \"news\";\n  country?: string;\n  excludedWebsites?: string[];\n  safeSearch?: boolean;\n}\n\n/**\n * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIXSource` internally.\n */\nexport interface XAIXSearchToolSource {\n  type: \"x\";\n  includedXHandles?: string[];\n  excludedXHandles?: string[];\n  postFavoriteCount?: number;\n  postViewCount?: number;\n}\n\n/**\n * RSS feed search source configuration for the xAI live search tool.\n * The structure matches `XAIRssSource` (only `links`).\n */\nexport interface XAIRssSearchToolSource {\n  type: \"rss\";\n  links: string[];\n}\n\nexport type XAISearchToolSource =\n  | XAIWebSearchToolSource\n  | XAINewsSearchToolSource\n  | XAIXSearchToolSource\n  | XAIRssSearchToolSource;\n\n/**\n * Options for the xAI live search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the underlying `XAISearchParameters`\n * object that is sent to xAI's deprecated Live Search API.\n */\nexport interface XAILiveSearchToolOptions {\n  /**\n   * Controls when the model should perform a search.\n   * - \"auto\": Let the model decide when to search (default)\n   * - \"on\": Always search for every request\n   * - \"off\": Never search\n   */\n  mode?: \"auto\" | \"on\" | \"off\";\n  /**\n   * Maximum number of search results to return.\n   * @default 20\n   */\n  maxSearchResults?: number;\n  /**\n   * Filter search results to only include content from after this date.\n   * Format: ISO 8601 date string (e.g., \"2024-01-01\")\n   */\n  fromDate?: string;\n  /**\n   * Filter search results to only include content from before this date.\n   * Format: ISO 8601 date string (e.g., \"2024-12-31\")\n   */\n  toDate?: string;\n  /**\n   * Whether to return citations/sources for the search results.\n   * @default true\n   */\n  returnCitations?: boolean;\n  /**\n   * Specific web/news/X/RSS sources that can be used for the search.\n   * These are converted to the snake_case `XAISearchSource` structures\n   * used by the underlying xAI Live Search API.\n   */\n  sources?: XAISearchToolSource[];\n}\n\nfunction mapToolSourceToSearchSource(\n  source: XAISearchToolSource\n): XAISearchSource {\n  switch (source.type) {\n    case \"web\":\n      return {\n        type: \"web\",\n        ...(source.country !== undefined && { country: source.country }),\n        ...(source.allowedWebsites !== undefined && {\n          allowed_websites: source.allowedWebsites,\n        }),\n        ...(source.excludedWebsites !== undefined && {\n          excluded_websites: source.excludedWebsites,\n        }),\n        ...(source.safeSearch !== undefined && {\n          safe_search: source.safeSearch,\n        }),\n      };\n    case \"news\":\n      return {\n        type: \"news\",\n        ...(source.country !== undefined && { country: source.country }),\n        ...(source.excludedWebsites !== undefined && {\n          excluded_websites: source.excludedWebsites,\n        }),\n        ...(source.safeSearch !== undefined && {\n          safe_search: source.safeSearch,\n        }),\n      };\n    case \"x\":\n      return {\n        type: \"x\",\n        ...(source.includedXHandles !== undefined && {\n          included_x_handles: source.includedXHandles,\n        }),\n        ...(source.excludedXHandles !== undefined && {\n          excluded_x_handles: source.excludedXHandles,\n        }),\n        ...(source.postFavoriteCount !== undefined && {\n          post_favorite_count: source.postFavoriteCount,\n        }),\n        ...(source.postViewCount !== undefined && {\n          post_view_count: source.postViewCount,\n        }),\n      };\n    case \"rss\":\n      return {\n        type: \"rss\",\n        links: source.links,\n      };\n    default: {\n      const _exhaustive: never = source;\n      return _exhaustive;\n    }\n  }\n}\n\n/**\n * Creates an xAI built-in live search tool.\n * Enables the model to search the web for real-time information.\n *\n * This tool is executed server-side by the xAI API.\n *\n * @example\n * ```typescript\n * import { ChatXAI, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAI({\n *   model: \"grok-beta\",\n * });\n *\n * const searchTool = tools.xaiLiveSearch({\n *   maxSearchResults: 5,\n *   fromDate: \"2024-01-01\",\n *   returnCitations: true\n * });\n *\n * const llmWithSearch = llm.bindTools([searchTool]);\n * const result = await llmWithSearch.invoke(\"What happened in tech today?\");\n * ```\n */\nexport function xaiLiveSearch(\n  options: XAILiveSearchToolOptions = {}\n): XAILiveSearchTool {\n  return {\n    type: XAI_LIVE_SEARCH_TOOL_TYPE,\n    name: XAI_LIVE_SEARCH_TOOL_NAME,\n    mode: options?.mode,\n    max_search_results: options?.maxSearchResults,\n    from_date: options?.fromDate,\n    to_date: options?.toDate,\n    return_citations: options?.returnCitations,\n    sources: options?.sources?.map(mapToolSourceToSearchSource),\n  } satisfies XAILiveSearchTool;\n}\n"],"mappings":";;;;AAKA,MAAa,4BAA4B;AACzC,MAAa,4BAA4B;AAgHzC,SAAS,4BACPA,QACiB;AACjB,SAAQ,OAAO,MAAf;EACE,KAAK,MACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,YAAY,UAAa,EAAE,SAAS,OAAO,QAAS;GAC/D,GAAI,OAAO,oBAAoB,UAAa,EAC1C,kBAAkB,OAAO,gBAC1B;GACD,GAAI,OAAO,qBAAqB,UAAa,EAC3C,mBAAmB,OAAO,iBAC3B;GACD,GAAI,OAAO,eAAe,UAAa,EACrC,aAAa,OAAO,WACrB;EACF;EACH,KAAK,OACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,YAAY,UAAa,EAAE,SAAS,OAAO,QAAS;GAC/D,GAAI,OAAO,qBAAqB,UAAa,EAC3C,mBAAmB,OAAO,iBAC3B;GACD,GAAI,OAAO,eAAe,UAAa,EACrC,aAAa,OAAO,WACrB;EACF;EACH,KAAK,IACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,qBAAqB,UAAa,EAC3C,oBAAoB,OAAO,iBAC5B;GACD,GAAI,OAAO,qBAAqB,UAAa,EAC3C,oBAAoB,OAAO,iBAC5B;GACD,GAAI,OAAO,sBAAsB,UAAa,EAC5C,qBAAqB,OAAO,kBAC7B;GACD,GAAI,OAAO,kBAAkB,UAAa,EACxC,iBAAiB,OAAO,cACzB;EACF;EACH,KAAK,MACH,QAAO;GACL,MAAM;GACN,OAAO,OAAO;EACf;EACH,SAAS;GACP,MAAMC,cAAqB;AAC3B,UAAO;EACR;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;AA0BD,SAAgB,cACdC,UAAoC,CAAE,GACnB;AACnB,QAAO;EACL,MAAM;EACN,MAAM;EACN,MAAM,SAAS;EACf,oBAAoB,SAAS;EAC7B,WAAW,SAAS;EACpB,SAAS,SAAS;EAClB,kBAAkB,SAAS;EAC3B,SAAS,SAAS,SAAS,IAAI,4BAA4B;CAC5D;AACF"}
+{"version":3,"file":"live_search.js","names":["source: XAISearchToolSource","_exhaustive: never","options: XAILiveSearchToolOptions"],"sources":["../../src/tools/live_search.ts"],"sourcesContent":["import type { XAISearchParameters, XAISearchSource } from \"../live_search.js\";\n\n/**\n * xAI's deprecated live_search tool type.\n */\nexport const XAI_LIVE_SEARCH_TOOL_TYPE = \"live_search_deprecated_20251215\";\nexport const XAI_LIVE_SEARCH_TOOL_NAME = \"live_search\";\n\n/**\n * xAI's built-in live_search tool type.\n * Enables the model to search the web for real-time information.\n */\nexport interface XAILiveSearchTool extends XAISearchParameters {\n  /**\n   * The name of the tool. Must be \"live_search\" for xAI's built-in search.\n   */\n  name: typeof XAI_LIVE_SEARCH_TOOL_NAME;\n  /**\n   * The type of the tool. This uses a deprecated Live Search API shape:\n   * the advanced agentic search capabilities powering grok.com are generally\n   * available in the new agentic tool calling API, and the Live Search API\n   * will be deprecated by December 15, 2025.\n   */\n  type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;\n}\n\n/**\n * Web search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIWebSource` internally.\n */\nexport interface XAIWebSearchToolSource {\n  type: \"web\";\n  country?: string;\n  excludedWebsites?: string[];\n  allowedWebsites?: string[];\n  safeSearch?: boolean;\n}\n\n/**\n * News search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAINewsSource` internally.\n */\nexport interface XAINewsSearchToolSource {\n  type: \"news\";\n  country?: string;\n  excludedWebsites?: string[];\n  safeSearch?: boolean;\n}\n\n/**\n * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).\n * This is converted to the snake_case `XAIXSource` internally.\n */\nexport interface XAIXSearchToolSource {\n  type: \"x\";\n  includedXHandles?: string[];\n  excludedXHandles?: string[];\n  postFavoriteCount?: number;\n  postViewCount?: number;\n}\n\n/**\n * RSS feed search source configuration for the xAI live search tool.\n * The structure matches `XAIRssSource` (only `links`).\n */\nexport interface XAIRssSearchToolSource {\n  type: \"rss\";\n  links: string[];\n}\n\nexport type XAISearchToolSource =\n  | XAIWebSearchToolSource\n  | XAINewsSearchToolSource\n  | XAIXSearchToolSource\n  | XAIRssSearchToolSource;\n\n/**\n * Options for the xAI live search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the underlying `XAISearchParameters`\n * object that is sent to xAI's deprecated Live Search API.\n */\nexport interface XAILiveSearchToolOptions {\n  /**\n   * Controls when the model should perform a search.\n   * - \"auto\": Let the model decide when to search (default)\n   * - \"on\": Always search for every request\n   * - \"off\": Never search\n   */\n  mode?: \"auto\" | \"on\" | \"off\";\n  /**\n   * Maximum number of search results to return.\n   * @default 20\n   */\n  maxSearchResults?: number;\n  /**\n   * Filter search results to only include content from after this date.\n   * Format: ISO 8601 date string (e.g., \"2024-01-01\")\n   */\n  fromDate?: string;\n  /**\n   * Filter search results to only include content from before this date.\n   * Format: ISO 8601 date string (e.g., \"2024-12-31\")\n   */\n  toDate?: string;\n  /**\n   * Whether to return citations/sources for the search results.\n   * @default true\n   */\n  returnCitations?: boolean;\n  /**\n   * Specific web/news/X/RSS sources that can be used for the search.\n   * These are converted to the snake_case `XAISearchSource` structures\n   * used by the underlying xAI Live Search API.\n   */\n  sources?: XAISearchToolSource[];\n}\n\nfunction mapToolSourceToSearchSource(\n  source: XAISearchToolSource\n): XAISearchSource {\n  switch (source.type) {\n    case \"web\":\n      return {\n        type: \"web\",\n        ...(source.country !== undefined && { country: source.country }),\n        ...(source.allowedWebsites !== undefined && {\n          allowed_websites: source.allowedWebsites,\n        }),\n        ...(source.excludedWebsites !== undefined && {\n          excluded_websites: source.excludedWebsites,\n        }),\n        ...(source.safeSearch !== undefined && {\n          safe_search: source.safeSearch,\n        }),\n      };\n    case \"news\":\n      return {\n        type: \"news\",\n        ...(source.country !== undefined && { country: source.country }),\n        ...(source.excludedWebsites !== undefined && {\n          excluded_websites: source.excludedWebsites,\n        }),\n        ...(source.safeSearch !== undefined && {\n          safe_search: source.safeSearch,\n        }),\n      };\n    case \"x\":\n      return {\n        type: \"x\",\n        ...(source.includedXHandles !== undefined && {\n          included_x_handles: source.includedXHandles,\n        }),\n        ...(source.excludedXHandles !== undefined && {\n          excluded_x_handles: source.excludedXHandles,\n        }),\n        ...(source.postFavoriteCount !== undefined && {\n          post_favorite_count: source.postFavoriteCount,\n        }),\n        ...(source.postViewCount !== undefined && {\n          post_view_count: source.postViewCount,\n        }),\n      };\n    case \"rss\":\n      return {\n        type: \"rss\",\n        links: source.links,\n      };\n    default: {\n      const _exhaustive: never = source;\n      return _exhaustive;\n    }\n  }\n}\n\n/**\n * Creates an xAI built-in live search tool.\n * Enables the model to search the web for real-time information.\n *\n * This tool is executed server-side by the xAI API.\n *\n * @deprecated The Live Search API was deprecated by xAI on December 15, 2025.\n * Use the new agentic tool calling API instead with `xaiWebSearch()` and `xaiXSearch()`.\n *\n * @example Migration to new tools:\n * ```typescript\n * // Old (deprecated):\n * const searchTool = tools.xaiLiveSearch({ maxSearchResults: 5 });\n *\n * // New (recommended):\n * const webSearch = tools.xaiWebSearch({ allowedDomains: [\"example.com\"] });\n * const xSearch = tools.xaiXSearch({ allowedXHandles: [\"elonmusk\"] });\n * ```\n *\n * @example\n * ```typescript\n * import { ChatXAI, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAI({\n *   model: \"grok-beta\",\n * });\n *\n * const searchTool = tools.xaiLiveSearch({\n *   maxSearchResults: 5,\n *   fromDate: \"2024-01-01\",\n *   returnCitations: true\n * });\n *\n * const llmWithSearch = llm.bindTools([searchTool]);\n * const result = await llmWithSearch.invoke(\"What happened in tech today?\");\n * ```\n */\nexport function xaiLiveSearch(\n  options: XAILiveSearchToolOptions = {}\n): XAILiveSearchTool {\n  return {\n    type: XAI_LIVE_SEARCH_TOOL_TYPE,\n    name: XAI_LIVE_SEARCH_TOOL_NAME,\n    mode: options?.mode,\n    max_search_results: options?.maxSearchResults,\n    from_date: options?.fromDate,\n    to_date: options?.toDate,\n    return_citations: options?.returnCitations,\n    sources: options?.sources?.map(mapToolSourceToSearchSource),\n  } satisfies XAILiveSearchTool;\n}\n"],"mappings":";;;;AAKA,MAAa,4BAA4B;AACzC,MAAa,4BAA4B;AAgHzC,SAAS,4BACPA,QACiB;AACjB,SAAQ,OAAO,MAAf;EACE,KAAK,MACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,YAAY,UAAa,EAAE,SAAS,OAAO,QAAS;GAC/D,GAAI,OAAO,oBAAoB,UAAa,EAC1C,kBAAkB,OAAO,gBAC1B;GACD,GAAI,OAAO,qBAAqB,UAAa,EAC3C,mBAAmB,OAAO,iBAC3B;GACD,GAAI,OAAO,eAAe,UAAa,EACrC,aAAa,OAAO,WACrB;EACF;EACH,KAAK,OACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,YAAY,UAAa,EAAE,SAAS,OAAO,QAAS;GAC/D,GAAI,OAAO,qBAAqB,UAAa,EAC3C,mBAAmB,OAAO,iBAC3B;GACD,GAAI,OAAO,eAAe,UAAa,EACrC,aAAa,OAAO,WACrB;EACF;EACH,KAAK,IACH,QAAO;GACL,MAAM;GACN,GAAI,OAAO,qBAAqB,UAAa,EAC3C,oBAAoB,OAAO,iBAC5B;GACD,GAAI,OAAO,qBAAqB,UAAa,EAC3C,oBAAoB,OAAO,iBAC5B;GACD,GAAI,OAAO,sBAAsB,UAAa,EAC5C,qBAAqB,OAAO,kBAC7B;GACD,GAAI,OAAO,kBAAkB,UAAa,EACxC,iBAAiB,OAAO,cACzB;EACF;EACH,KAAK,MACH,QAAO;GACL,MAAM;GACN,OAAO,OAAO;EACf;EACH,SAAS;GACP,MAAMC,cAAqB;AAC3B,UAAO;EACR;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCD,SAAgB,cACdC,UAAoC,CAAE,GACnB;AACnB,QAAO;EACL,MAAM;EACN,MAAM;EACN,MAAM,SAAS;EACf,oBAAoB,SAAS;EAC7B,WAAW,SAAS;EACpB,SAAS,SAAS;EAClB,kBAAkB,SAAS;EAC3B,SAAS,SAAS,SAAS,IAAI,4BAA4B;CAC5D;AACF"}

package/dist/tools/web_search.cjs

@@ -0,0 +1,57 @@
+
+//#region src/tools/web_search.ts
+/**
+* xAI Web Search tool type constant.
+*/
+const XAI_WEB_SEARCH_TOOL_TYPE = "web_search";
+/**
+* Creates an xAI web search tool.
+* Enables the model to search the web and browse pages for real-time information.
+*
+* This tool is executed server-side by the xAI API as part of the agentic
+* tool calling workflow.
+*
+* @param options - Configuration options for the web search tool
+* @returns An XAIWebSearchTool object to pass to the model
+*
+* @example Basic usage
+* ```typescript
+* import { ChatXAIResponses, tools } from "@langchain/xai";
+*
+* const llm = new ChatXAIResponses({
+*   model: "grok-4-1-fast",
+* });
+*
+* const webSearch = tools.xaiWebSearch();
+* const result = await llm.invoke("What are the latest AI developments?", {
+*   tools: [webSearch],
+* });
+* ```
+*
+* @example With domain filtering
+* ```typescript
+* const webSearch = tools.xaiWebSearch({
+*   allowedDomains: ["wikipedia.org", "arxiv.org"],
+*   enableImageUnderstanding: true,
+* });
+* ```
+*
+* @example Excluding specific domains
+* ```typescript
+* const webSearch = tools.xaiWebSearch({
+*   excludedDomains: ["example.com"],
+* });
+* ```
+*/
+function xaiWebSearch(options = {}) {
+	const tool = { type: XAI_WEB_SEARCH_TOOL_TYPE };
+	if (options.allowedDomains !== void 0) tool.allowed_domains = options.allowedDomains;
+	if (options.excludedDomains !== void 0) tool.excluded_domains = options.excludedDomains;
+	if (options.enableImageUnderstanding !== void 0) tool.enable_image_understanding = options.enableImageUnderstanding;
+	return tool;
+}
+
+//#endregion
+exports.XAI_WEB_SEARCH_TOOL_TYPE = XAI_WEB_SEARCH_TOOL_TYPE;
+exports.xaiWebSearch = xaiWebSearch;
+//# sourceMappingURL=web_search.cjs.map

package/dist/tools/web_search.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"web_search.cjs","names":["options: XAIWebSearchToolOptions","tool: XAIWebSearchTool"],"sources":["../../src/tools/web_search.ts"],"sourcesContent":["/**\n * xAI Web Search tool type constant.\n */\nexport const XAI_WEB_SEARCH_TOOL_TYPE = \"web_search\";\n\n/**\n * xAI's built-in web search tool interface.\n * Enables the model to search the web and browse pages for real-time information.\n *\n * This tool is part of xAI's agentic tool calling API.\n */\nexport interface XAIWebSearchTool {\n  /**\n   * The type of the tool. Must be \"web_search\".\n   */\n  type: typeof XAI_WEB_SEARCH_TOOL_TYPE;\n  /**\n   * Domains to exclusively include in the search (max 5).\n   * Cannot be used together with `excluded_domains`.\n   */\n  allowed_domains?: string[];\n  /**\n   * Domains to exclude from the search (max 5).\n   * Cannot be used together with `allowed_domains`.\n   */\n  excluded_domains?: string[];\n  /**\n   * Whether to enable image understanding.\n   * When enabled, the model can analyze images encountered during search.\n   */\n  enable_image_understanding?: boolean;\n}\n\n/**\n * Options for the xAI web search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the API request.\n */\nexport interface XAIWebSearchToolOptions {\n  /**\n   * Domains to exclusively include in the search (max 5).\n   * Cannot be used together with `excludedDomains`.\n   *\n   * @example [\"wikipedia.org\", \"github.com\"]\n   */\n  allowedDomains?: string[];\n  /**\n   * Domains to exclude from the search (max 5).\n   * Cannot be used together with `allowedDomains`.\n   *\n   * @example [\"example.com\"]\n   */\n  excludedDomains?: string[];\n  /**\n   * Whether to enable image understanding.\n   * When enabled, the model can analyze images encountered during search.\n   * Note: This increases token usage as images are processed.\n   *\n   * @default false\n   */\n  enableImageUnderstanding?: boolean;\n}\n\n/**\n * Creates an xAI web search tool.\n * Enables the model to search the web and browse pages for real-time information.\n *\n * This tool is executed server-side by the xAI API as part of the agentic\n * tool calling workflow.\n *\n * @param options - Configuration options for the web search tool\n * @returns An XAIWebSearchTool object to pass to the model\n *\n * @example Basic usage\n * ```typescript\n * import { ChatXAIResponses, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAIResponses({\n *   model: \"grok-4-1-fast\",\n * });\n *\n * const webSearch = tools.xaiWebSearch();\n * const result = await llm.invoke(\"What are the latest AI developments?\", {\n *   tools: [webSearch],\n * });\n * ```\n *\n * @example With domain filtering\n * ```typescript\n * const webSearch = tools.xaiWebSearch({\n *   allowedDomains: [\"wikipedia.org\", \"arxiv.org\"],\n *   enableImageUnderstanding: true,\n * });\n * ```\n *\n * @example Excluding specific domains\n * ```typescript\n * const webSearch = tools.xaiWebSearch({\n *   excludedDomains: [\"example.com\"],\n * });\n * ```\n */\nexport function xaiWebSearch(\n  options: XAIWebSearchToolOptions = {}\n): XAIWebSearchTool {\n  const tool: XAIWebSearchTool = {\n    type: XAI_WEB_SEARCH_TOOL_TYPE,\n  };\n\n  if (options.allowedDomains !== undefined) {\n    tool.allowed_domains = options.allowedDomains;\n  }\n\n  if (options.excludedDomains !== undefined) {\n    tool.excluded_domains = options.excludedDomains;\n  }\n\n  if (options.enableImageUnderstanding !== undefined) {\n    tool.enable_image_understanding = options.enableImageUnderstanding;\n  }\n\n  return tool;\n}\n"],"mappings":";;;;;AAGA,MAAa,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmGxC,SAAgB,aACdA,UAAmC,CAAE,GACnB;CAClB,MAAMC,OAAyB,EAC7B,MAAM,yBACP;AAED,KAAI,QAAQ,mBAAmB,QAC7B,KAAK,kBAAkB,QAAQ;AAGjC,KAAI,QAAQ,oBAAoB,QAC9B,KAAK,mBAAmB,QAAQ;AAGlC,KAAI,QAAQ,6BAA6B,QACvC,KAAK,6BAA6B,QAAQ;AAG5C,QAAO;AACR"}

package/dist/tools/web_search.d.cts

@@ -0,0 +1,104 @@
+//#region src/tools/web_search.d.ts
+/**
+ * xAI Web Search tool type constant.
+ */
+declare const XAI_WEB_SEARCH_TOOL_TYPE = "web_search";
+/**
+ * xAI's built-in web search tool interface.
+ * Enables the model to search the web and browse pages for real-time information.
+ *
+ * This tool is part of xAI's agentic tool calling API.
+ */
+interface XAIWebSearchTool {
+  /**
+   * The type of the tool. Must be "web_search".
+   */
+  type: typeof XAI_WEB_SEARCH_TOOL_TYPE;
+  /**
+   * Domains to exclusively include in the search (max 5).
+   * Cannot be used together with `excluded_domains`.
+   */
+  allowed_domains?: string[];
+  /**
+   * Domains to exclude from the search (max 5).
+   * Cannot be used together with `allowed_domains`.
+   */
+  excluded_domains?: string[];
+  /**
+   * Whether to enable image understanding.
+   * When enabled, the model can analyze images encountered during search.
+   */
+  enable_image_understanding?: boolean;
+}
+/**
+ * Options for the xAI web search tool (camelCase).
+ * All fields are camel-cased for the TypeScript API and are mapped to the
+ * corresponding snake_case fields in the API request.
+ */
+interface XAIWebSearchToolOptions {
+  /**
+   * Domains to exclusively include in the search (max 5).
+   * Cannot be used together with `excludedDomains`.
+   *
+   * @example ["wikipedia.org", "github.com"]
+   */
+  allowedDomains?: string[];
+  /**
+   * Domains to exclude from the search (max 5).
+   * Cannot be used together with `allowedDomains`.
+   *
+   * @example ["example.com"]
+   */
+  excludedDomains?: string[];
+  /**
+   * Whether to enable image understanding.
+   * When enabled, the model can analyze images encountered during search.
+   * Note: This increases token usage as images are processed.
+   *
+   * @default false
+   */
+  enableImageUnderstanding?: boolean;
+}
+/**
+ * Creates an xAI web search tool.
+ * Enables the model to search the web and browse pages for real-time information.
+ *
+ * This tool is executed server-side by the xAI API as part of the agentic
+ * tool calling workflow.
+ *
+ * @param options - Configuration options for the web search tool
+ * @returns An XAIWebSearchTool object to pass to the model
+ *
+ * @example Basic usage
+ * ```typescript
+ * import { ChatXAIResponses, tools } from "@langchain/xai";
+ *
+ * const llm = new ChatXAIResponses({
+ *   model: "grok-4-1-fast",
+ * });
+ *
+ * const webSearch = tools.xaiWebSearch();
+ * const result = await llm.invoke("What are the latest AI developments?", {
+ *   tools: [webSearch],
+ * });
+ * ```
+ *
+ * @example With domain filtering
+ * ```typescript
+ * const webSearch = tools.xaiWebSearch({
+ *   allowedDomains: ["wikipedia.org", "arxiv.org"],
+ *   enableImageUnderstanding: true,
+ * });
+ * ```
+ *
+ * @example Excluding specific domains
+ * ```typescript
+ * const webSearch = tools.xaiWebSearch({
+ *   excludedDomains: ["example.com"],
+ * });
+ * ```
+ */
+declare function xaiWebSearch(options?: XAIWebSearchToolOptions): XAIWebSearchTool;
+//#endregion
+export { XAIWebSearchTool, XAIWebSearchToolOptions, XAI_WEB_SEARCH_TOOL_TYPE, xaiWebSearch };
+//# sourceMappingURL=web_search.d.cts.map

package/dist/tools/web_search.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web_search.d.cts","names":["XAI_WEB_SEARCH_TOOL_TYPE","XAIWebSearchTool","XAIWebSearchToolOptions","xaiWebSearch"],"sources":["../../src/tools/web_search.d.ts"],"sourcesContent":["/**\n * xAI Web Search tool type constant.\n */\nexport declare const XAI_WEB_SEARCH_TOOL_TYPE = \"web_search\";\n/**\n * xAI's built-in web search tool interface.\n * Enables the model to search the web and browse pages for real-time information.\n *\n * This tool is part of xAI's agentic tool calling API.\n */\nexport interface XAIWebSearchTool {\n    /**\n     * The type of the tool. Must be \"web_search\".\n     */\n    type: typeof XAI_WEB_SEARCH_TOOL_TYPE;\n    /**\n     * Domains to exclusively include in the search (max 5).\n     * Cannot be used together with `excluded_domains`.\n     */\n    allowed_domains?: string[];\n    /**\n     * Domains to exclude from the search (max 5).\n     * Cannot be used together with `allowed_domains`.\n     */\n    excluded_domains?: string[];\n    /**\n     * Whether to enable image understanding.\n     * When enabled, the model can analyze images encountered during search.\n     */\n    enable_image_understanding?: boolean;\n}\n/**\n * Options for the xAI web search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the API request.\n */\nexport interface XAIWebSearchToolOptions {\n    /**\n     * Domains to exclusively include in the search (max 5).\n     * Cannot be used together with `excludedDomains`.\n     *\n     * @example [\"wikipedia.org\", \"github.com\"]\n     */\n    allowedDomains?: string[];\n    /**\n     * Domains to exclude from the search (max 5).\n     * Cannot be used together with `allowedDomains`.\n     *\n     * @example [\"example.com\"]\n     */\n    excludedDomains?: string[];\n    /**\n     * Whether to enable image understanding.\n     * When enabled, the model can analyze images encountered during search.\n     * Note: This increases token usage as images are processed.\n     *\n     * @default false\n     */\n    enableImageUnderstanding?: boolean;\n}\n/**\n * Creates an xAI web search tool.\n * Enables the model to search the web and browse pages for real-time information.\n *\n * This tool is executed server-side by the xAI API as part of the agentic\n * tool calling workflow.\n *\n * @param options - Configuration options for the web search tool\n * @returns An XAIWebSearchTool object to pass to the model\n *\n * @example Basic usage\n * ```typescript\n * import { ChatXAIResponses, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAIResponses({\n *   model: \"grok-4-1-fast\",\n * });\n *\n * const webSearch = tools.xaiWebSearch();\n * const result = await llm.invoke(\"What are the latest AI developments?\", {\n *   tools: [webSearch],\n * });\n * ```\n *\n * @example With domain filtering\n * ```typescript\n * const webSearch = tools.xaiWebSearch({\n *   allowedDomains: [\"wikipedia.org\", \"arxiv.org\"],\n *   enableImageUnderstanding: true,\n * });\n * ```\n *\n * @example Excluding specific domains\n * ```typescript\n * const webSearch = tools.xaiWebSearch({\n *   excludedDomains: [\"example.com\"],\n * });\n * ```\n */\nexport declare function xaiWebSearch(options?: XAIWebSearchToolOptions): XAIWebSearchTool;\n//# sourceMappingURL=web_search.d.ts.map"],"mappings":";;AAGA;AAOA;AA0BiBE,cAjCIF,wBAAAA,GAiCmB,YAAA;AA+DxC;;;;;;UAzFiBC,gBAAAA;;;;eAIAD;;;;;;;;;;;;;;;;;;;;;;UAsBAE,uBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+DOC,YAAAA,WAAuBD,0BAA0BD"}

package/dist/tools/web_search.d.ts

@@ -0,0 +1,104 @@
+//#region src/tools/web_search.d.ts
+/**
+ * xAI Web Search tool type constant.
+ */
+declare const XAI_WEB_SEARCH_TOOL_TYPE = "web_search";
+/**
+ * xAI's built-in web search tool interface.
+ * Enables the model to search the web and browse pages for real-time information.
+ *
+ * This tool is part of xAI's agentic tool calling API.
+ */
+interface XAIWebSearchTool {
+  /**
+   * The type of the tool. Must be "web_search".
+   */
+  type: typeof XAI_WEB_SEARCH_TOOL_TYPE;
+  /**
+   * Domains to exclusively include in the search (max 5).
+   * Cannot be used together with `excluded_domains`.
+   */
+  allowed_domains?: string[];
+  /**
+   * Domains to exclude from the search (max 5).
+   * Cannot be used together with `allowed_domains`.
+   */
+  excluded_domains?: string[];
+  /**
+   * Whether to enable image understanding.
+   * When enabled, the model can analyze images encountered during search.
+   */
+  enable_image_understanding?: boolean;
+}
+/**
+ * Options for the xAI web search tool (camelCase).
+ * All fields are camel-cased for the TypeScript API and are mapped to the
+ * corresponding snake_case fields in the API request.
+ */
+interface XAIWebSearchToolOptions {
+  /**
+   * Domains to exclusively include in the search (max 5).
+   * Cannot be used together with `excludedDomains`.
+   *
+   * @example ["wikipedia.org", "github.com"]
+   */
+  allowedDomains?: string[];
+  /**
+   * Domains to exclude from the search (max 5).
+   * Cannot be used together with `allowedDomains`.
+   *
+   * @example ["example.com"]
+   */
+  excludedDomains?: string[];
+  /**
+   * Whether to enable image understanding.
+   * When enabled, the model can analyze images encountered during search.
+   * Note: This increases token usage as images are processed.
+   *
+   * @default false
+   */
+  enableImageUnderstanding?: boolean;
+}
+/**
+ * Creates an xAI web search tool.
+ * Enables the model to search the web and browse pages for real-time information.
+ *
+ * This tool is executed server-side by the xAI API as part of the agentic
+ * tool calling workflow.
+ *
+ * @param options - Configuration options for the web search tool
+ * @returns An XAIWebSearchTool object to pass to the model
+ *
+ * @example Basic usage
+ * ```typescript
+ * import { ChatXAIResponses, tools } from "@langchain/xai";
+ *
+ * const llm = new ChatXAIResponses({
+ *   model: "grok-4-1-fast",
+ * });
+ *
+ * const webSearch = tools.xaiWebSearch();
+ * const result = await llm.invoke("What are the latest AI developments?", {
+ *   tools: [webSearch],
+ * });
+ * ```
+ *
+ * @example With domain filtering
+ * ```typescript
+ * const webSearch = tools.xaiWebSearch({
+ *   allowedDomains: ["wikipedia.org", "arxiv.org"],
+ *   enableImageUnderstanding: true,
+ * });
+ * ```
+ *
+ * @example Excluding specific domains
+ * ```typescript
+ * const webSearch = tools.xaiWebSearch({
+ *   excludedDomains: ["example.com"],
+ * });
+ * ```
+ */
+declare function xaiWebSearch(options?: XAIWebSearchToolOptions): XAIWebSearchTool;
+//#endregion
+export { XAIWebSearchTool, XAIWebSearchToolOptions, XAI_WEB_SEARCH_TOOL_TYPE, xaiWebSearch };
+//# sourceMappingURL=web_search.d.ts.map

package/dist/tools/web_search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web_search.d.ts","names":["XAI_WEB_SEARCH_TOOL_TYPE","XAIWebSearchTool","XAIWebSearchToolOptions","xaiWebSearch"],"sources":["../../src/tools/web_search.d.ts"],"sourcesContent":["/**\n * xAI Web Search tool type constant.\n */\nexport declare const XAI_WEB_SEARCH_TOOL_TYPE = \"web_search\";\n/**\n * xAI's built-in web search tool interface.\n * Enables the model to search the web and browse pages for real-time information.\n *\n * This tool is part of xAI's agentic tool calling API.\n */\nexport interface XAIWebSearchTool {\n    /**\n     * The type of the tool. Must be \"web_search\".\n     */\n    type: typeof XAI_WEB_SEARCH_TOOL_TYPE;\n    /**\n     * Domains to exclusively include in the search (max 5).\n     * Cannot be used together with `excluded_domains`.\n     */\n    allowed_domains?: string[];\n    /**\n     * Domains to exclude from the search (max 5).\n     * Cannot be used together with `allowed_domains`.\n     */\n    excluded_domains?: string[];\n    /**\n     * Whether to enable image understanding.\n     * When enabled, the model can analyze images encountered during search.\n     */\n    enable_image_understanding?: boolean;\n}\n/**\n * Options for the xAI web search tool (camelCase).\n * All fields are camel-cased for the TypeScript API and are mapped to the\n * corresponding snake_case fields in the API request.\n */\nexport interface XAIWebSearchToolOptions {\n    /**\n     * Domains to exclusively include in the search (max 5).\n     * Cannot be used together with `excludedDomains`.\n     *\n     * @example [\"wikipedia.org\", \"github.com\"]\n     */\n    allowedDomains?: string[];\n    /**\n     * Domains to exclude from the search (max 5).\n     * Cannot be used together with `allowedDomains`.\n     *\n     * @example [\"example.com\"]\n     */\n    excludedDomains?: string[];\n    /**\n     * Whether to enable image understanding.\n     * When enabled, the model can analyze images encountered during search.\n     * Note: This increases token usage as images are processed.\n     *\n     * @default false\n     */\n    enableImageUnderstanding?: boolean;\n}\n/**\n * Creates an xAI web search tool.\n * Enables the model to search the web and browse pages for real-time information.\n *\n * This tool is executed server-side by the xAI API as part of the agentic\n * tool calling workflow.\n *\n * @param options - Configuration options for the web search tool\n * @returns An XAIWebSearchTool object to pass to the model\n *\n * @example Basic usage\n * ```typescript\n * import { ChatXAIResponses, tools } from \"@langchain/xai\";\n *\n * const llm = new ChatXAIResponses({\n *   model: \"grok-4-1-fast\",\n * });\n *\n * const webSearch = tools.xaiWebSearch();\n * const result = await llm.invoke(\"What are the latest AI developments?\", {\n *   tools: [webSearch],\n * });\n * ```\n *\n * @example With domain filtering\n * ```typescript\n * const webSearch = tools.xaiWebSearch({\n *   allowedDomains: [\"wikipedia.org\", \"arxiv.org\"],\n *   enableImageUnderstanding: true,\n * });\n * ```\n *\n * @example Excluding specific domains\n * ```typescript\n * const webSearch = tools.xaiWebSearch({\n *   excludedDomains: [\"example.com\"],\n * });\n * ```\n */\nexport declare function xaiWebSearch(options?: XAIWebSearchToolOptions): XAIWebSearchTool;\n//# sourceMappingURL=web_search.d.ts.map"],"mappings":";;AAGA;AAOA;AA0BiBE,cAjCIF,wBAAAA,GAiCmB,YAAA;AA+DxC;;;;;;UAzFiBC,gBAAAA;;;;eAIAD;;;;;;;;;;;;;;;;;;;;;;UAsBAE,uBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+DOC,YAAAA,WAAuBD,0BAA0BD"}