@langchain/xai 1.0.3-dev-1765433794876 → 1.1.0

package/dist/tools/live_search.d.cts

@@ -0,0 +1,136 @@
+import { XAISearchParameters } from "../live_search.cjs";
+
+//#region src/tools/live_search.d.ts
+
+/**
+ * xAI's deprecated live_search tool type.
+ */
+declare const XAI_LIVE_SEARCH_TOOL_TYPE = "live_search_deprecated_20251215";
+declare const XAI_LIVE_SEARCH_TOOL_NAME = "live_search";
+/**
+ * xAI's built-in live_search tool type.
+ * Enables the model to search the web for real-time information.
+ */
+interface XAILiveSearchTool extends XAISearchParameters {
+  /**
+   * The name of the tool. Must be "live_search" for xAI's built-in search.
+   */
+  name: typeof XAI_LIVE_SEARCH_TOOL_NAME;
+  /**
+   * The type of the tool. This uses a deprecated Live Search API shape:
+   * the advanced agentic search capabilities powering grok.com are generally
+   * available in the new agentic tool calling API, and the Live Search API
+   * will be deprecated by December 15, 2025.
+   */
+  type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;
+}
+/**
+ * Web search source configuration for the xAI live search tool (camelCase).
+ * This is converted to the snake_case `XAIWebSource` internally.
+ */
+interface XAIWebSearchToolSource {
+  type: "web";
+  country?: string;
+  excludedWebsites?: string[];
+  allowedWebsites?: string[];
+  safeSearch?: boolean;
+}
+/**
+ * News search source configuration for the xAI live search tool (camelCase).
+ * This is converted to the snake_case `XAINewsSource` internally.
+ */
+interface XAINewsSearchToolSource {
+  type: "news";
+  country?: string;
+  excludedWebsites?: string[];
+  safeSearch?: boolean;
+}
+/**
+ * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).
+ * This is converted to the snake_case `XAIXSource` internally.
+ */
+interface XAIXSearchToolSource {
+  type: "x";
+  includedXHandles?: string[];
+  excludedXHandles?: string[];
+  postFavoriteCount?: number;
+  postViewCount?: number;
+}
+/**
+ * RSS feed search source configuration for the xAI live search tool.
+ * The structure matches `XAIRssSource` (only `links`).
+ */
+interface XAIRssSearchToolSource {
+  type: "rss";
+  links: string[];
+}
+type XAISearchToolSource = XAIWebSearchToolSource | XAINewsSearchToolSource | XAIXSearchToolSource | XAIRssSearchToolSource;
+/**
+ * Options for the xAI live search tool (camelCase).
+ * All fields are camel-cased for the TypeScript API and are mapped to the
+ * corresponding snake_case fields in the underlying `XAISearchParameters`
+ * object that is sent to xAI's deprecated Live Search API.
+ */
+interface XAILiveSearchToolOptions {
+  /**
+   * Controls when the model should perform a search.
+   * - "auto": Let the model decide when to search (default)
+   * - "on": Always search for every request
+   * - "off": Never search
+   */
+  mode?: "auto" | "on" | "off";
+  /**
+   * Maximum number of search results to return.
+   * @default 20
+   */
+  maxSearchResults?: number;
+  /**
+   * Filter search results to only include content from after this date.
+   * Format: ISO 8601 date string (e.g., "2024-01-01")
+   */
+  fromDate?: string;
+  /**
+   * Filter search results to only include content from before this date.
+   * Format: ISO 8601 date string (e.g., "2024-12-31")
+   */
+  toDate?: string;
+  /**
+   * Whether to return citations/sources for the search results.
+   * @default true
+   */
+  returnCitations?: boolean;
+  /**
+   * Specific web/news/X/RSS sources that can be used for the search.
+   * These are converted to the snake_case `XAISearchSource` structures
+   * used by the underlying xAI Live Search API.
+   */
+  sources?: XAISearchToolSource[];
+}
+/**
+ * Creates an xAI built-in live search tool.
+ * Enables the model to search the web for real-time information.
+ *
+ * This tool is executed server-side by the xAI API.
+ *
+ * @example
+ * ```typescript
+ * import { ChatXAI, tools } from "@langchain/xai";
+ *
+ * const llm = new ChatXAI({
+ *   model: "grok-beta",
+ * });
+ *
+ * const searchTool = tools.xaiLiveSearch({
+ *   maxSearchResults: 5,
+ *   fromDate: "2024-01-01",
+ *   returnCitations: true
+ * });
+ *
+ * const llmWithSearch = llm.bindTools([searchTool]);
+ * const result = await llmWithSearch.invoke("What happened in tech today?");
+ * ```
+ */
+declare function xaiLiveSearch(options?: XAILiveSearchToolOptions): XAILiveSearchTool;
+//#endregion
+export { XAILiveSearchTool, xaiLiveSearch };
+//# sourceMappingURL=live_search.d.cts.map

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

@@ -0,0 +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"}

package/dist/tools/live_search.d.ts

@@ -0,0 +1,136 @@
+import { XAISearchParameters } from "../live_search.js";
+
+//#region src/tools/live_search.d.ts
+
+/**
+ * xAI's deprecated live_search tool type.
+ */
+declare const XAI_LIVE_SEARCH_TOOL_TYPE = "live_search_deprecated_20251215";
+declare const XAI_LIVE_SEARCH_TOOL_NAME = "live_search";
+/**
+ * xAI's built-in live_search tool type.
+ * Enables the model to search the web for real-time information.
+ */
+interface XAILiveSearchTool extends XAISearchParameters {
+  /**
+   * The name of the tool. Must be "live_search" for xAI's built-in search.
+   */
+  name: typeof XAI_LIVE_SEARCH_TOOL_NAME;
+  /**
+   * The type of the tool. This uses a deprecated Live Search API shape:
+   * the advanced agentic search capabilities powering grok.com are generally
+   * available in the new agentic tool calling API, and the Live Search API
+   * will be deprecated by December 15, 2025.
+   */
+  type: typeof XAI_LIVE_SEARCH_TOOL_TYPE;
+}
+/**
+ * Web search source configuration for the xAI live search tool (camelCase).
+ * This is converted to the snake_case `XAIWebSource` internally.
+ */
+interface XAIWebSearchToolSource {
+  type: "web";
+  country?: string;
+  excludedWebsites?: string[];
+  allowedWebsites?: string[];
+  safeSearch?: boolean;
+}
+/**
+ * News search source configuration for the xAI live search tool (camelCase).
+ * This is converted to the snake_case `XAINewsSource` internally.
+ */
+interface XAINewsSearchToolSource {
+  type: "news";
+  country?: string;
+  excludedWebsites?: string[];
+  safeSearch?: boolean;
+}
+/**
+ * X (formerly Twitter) search source configuration for the xAI live search tool (camelCase).
+ * This is converted to the snake_case `XAIXSource` internally.
+ */
+interface XAIXSearchToolSource {
+  type: "x";
+  includedXHandles?: string[];
+  excludedXHandles?: string[];
+  postFavoriteCount?: number;
+  postViewCount?: number;
+}
+/**
+ * RSS feed search source configuration for the xAI live search tool.
+ * The structure matches `XAIRssSource` (only `links`).
+ */
+interface XAIRssSearchToolSource {
+  type: "rss";
+  links: string[];
+}
+type XAISearchToolSource = XAIWebSearchToolSource | XAINewsSearchToolSource | XAIXSearchToolSource | XAIRssSearchToolSource;
+/**
+ * Options for the xAI live search tool (camelCase).
+ * All fields are camel-cased for the TypeScript API and are mapped to the
+ * corresponding snake_case fields in the underlying `XAISearchParameters`
+ * object that is sent to xAI's deprecated Live Search API.
+ */
+interface XAILiveSearchToolOptions {
+  /**
+   * Controls when the model should perform a search.
+   * - "auto": Let the model decide when to search (default)
+   * - "on": Always search for every request
+   * - "off": Never search
+   */
+  mode?: "auto" | "on" | "off";
+  /**
+   * Maximum number of search results to return.
+   * @default 20
+   */
+  maxSearchResults?: number;
+  /**
+   * Filter search results to only include content from after this date.
+   * Format: ISO 8601 date string (e.g., "2024-01-01")
+   */
+  fromDate?: string;
+  /**
+   * Filter search results to only include content from before this date.
+   * Format: ISO 8601 date string (e.g., "2024-12-31")
+   */
+  toDate?: string;
+  /**
+   * Whether to return citations/sources for the search results.
+   * @default true
+   */
+  returnCitations?: boolean;
+  /**
+   * Specific web/news/X/RSS sources that can be used for the search.
+   * These are converted to the snake_case `XAISearchSource` structures
+   * used by the underlying xAI Live Search API.
+   */
+  sources?: XAISearchToolSource[];
+}
+/**
+ * Creates an xAI built-in live search tool.
+ * Enables the model to search the web for real-time information.
+ *
+ * This tool is executed server-side by the xAI API.
+ *
+ * @example
+ * ```typescript
+ * import { ChatXAI, tools } from "@langchain/xai";
+ *
+ * const llm = new ChatXAI({
+ *   model: "grok-beta",
+ * });
+ *
+ * const searchTool = tools.xaiLiveSearch({
+ *   maxSearchResults: 5,
+ *   fromDate: "2024-01-01",
+ *   returnCitations: true
+ * });
+ *
+ * const llmWithSearch = llm.bindTools([searchTool]);
+ * const result = await llmWithSearch.invoke("What happened in tech today?");
+ * ```
+ */
+declare function xaiLiveSearch(options?: XAILiveSearchToolOptions): XAILiveSearchTool;
+//#endregion
+export { XAILiveSearchTool, xaiLiveSearch };
+//# sourceMappingURL=live_search.d.ts.map

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

@@ -0,0 +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"}

package/dist/tools/live_search.js

@@ -0,0 +1,78 @@
+//#region src/tools/live_search.ts
+/**
+* xAI's deprecated live_search tool type.
+*/
+const XAI_LIVE_SEARCH_TOOL_TYPE = "live_search_deprecated_20251215";
+const XAI_LIVE_SEARCH_TOOL_NAME = "live_search";
+function mapToolSourceToSearchSource(source) {
+	switch (source.type) {
+		case "web": return {
+			type: "web",
+			...source.country !== void 0 && { country: source.country },
+			...source.allowedWebsites !== void 0 && { allowed_websites: source.allowedWebsites },
+			...source.excludedWebsites !== void 0 && { excluded_websites: source.excludedWebsites },
+			...source.safeSearch !== void 0 && { safe_search: source.safeSearch }
+		};
+		case "news": return {
+			type: "news",
+			...source.country !== void 0 && { country: source.country },
+			...source.excludedWebsites !== void 0 && { excluded_websites: source.excludedWebsites },
+			...source.safeSearch !== void 0 && { safe_search: source.safeSearch }
+		};
+		case "x": return {
+			type: "x",
+			...source.includedXHandles !== void 0 && { included_x_handles: source.includedXHandles },
+			...source.excludedXHandles !== void 0 && { excluded_x_handles: source.excludedXHandles },
+			...source.postFavoriteCount !== void 0 && { post_favorite_count: source.postFavoriteCount },
+			...source.postViewCount !== void 0 && { post_view_count: source.postViewCount }
+		};
+		case "rss": return {
+			type: "rss",
+			links: source.links
+		};
+		default: {
+			const _exhaustive = source;
+			return _exhaustive;
+		}
+	}
+}
+/**
+* Creates an xAI built-in live search tool.
+* Enables the model to search the web for real-time information.
+*
+* This tool is executed server-side by the xAI API.
+*
+* @example
+* ```typescript
+* import { ChatXAI, tools } from "@langchain/xai";
+*
+* const llm = new ChatXAI({
+*   model: "grok-beta",
+* });
+*
+* const searchTool = tools.xaiLiveSearch({
+*   maxSearchResults: 5,
+*   fromDate: "2024-01-01",
+*   returnCitations: true
+* });
+*
+* const llmWithSearch = llm.bindTools([searchTool]);
+* const result = await llmWithSearch.invoke("What happened in tech today?");
+* ```
+*/
+function xaiLiveSearch(options = {}) {
+	return {
+		type: XAI_LIVE_SEARCH_TOOL_TYPE,
+		name: XAI_LIVE_SEARCH_TOOL_NAME,
+		mode: options?.mode,
+		max_search_results: options?.maxSearchResults,
+		from_date: options?.fromDate,
+		to_date: options?.toDate,
+		return_citations: options?.returnCitations,
+		sources: options?.sources?.map(mapToolSourceToSearchSource)
+	};
+}
+
+//#endregion
+export { XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch };
+//# sourceMappingURL=live_search.js.map

package/dist/tools/live_search.js.map

@@ -0,0 +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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/xai",
-  "version": "1.0.3-dev-1765433794876",
+  "version": "1.1.0",
   "description": "xAI integration for LangChain.js",
   "author": "LangChain",
   "license": "MIT",
@@ -14,10 +14,10 @@
   },
   "homepage": "https://github.com/langchain-ai/langchainjs/tree/main/libs/langchain-xai/",
   "dependencies": {
-    "@langchain/openai": "1.2.0-dev-1765433794876"
+    "@langchain/openai": "1.2.0"
   },
   "peerDependencies": {
-    "@langchain/core": "1.1.5-dev-1765433794876"
+    "@langchain/core": "^1.0.0"
   },
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.3",
@@ -31,11 +31,11 @@
     "typescript": "~5.8.3",
     "vitest": "^3.2.4",
     "zod": "^3.25.76",
-    "@langchain/core": "1.1.5-dev-1765433794876",
+    "@langchain/openai": "^1.2.0",
     "@langchain/eslint": "0.1.1",
-    "@langchain/tsconfig": "0.0.1",
-    "@langchain/standard-tests": "0.0.8-dev-1765433794876",
-    "@langchain/openai": "^1.2.0-dev-1765433794876"
+    "@langchain/standard-tests": "0.0.8",
+    "@langchain/core": "1.1.5",
+    "@langchain/tsconfig": "0.0.1"
   },
   "publishConfig": {
     "access": "public"