@nocobase/plugin-ai 2.1.0-beta.25 → 2.1.0-beta.26

package/dist/node_modules/@langchain/xai/dist/tools/live_search.d.cts

@@ -0,0 +1,149 @@
+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.
+ *
+ * @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";
+ *
+ * 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, XAILiveSearchToolOptions, XAI_LIVE_SEARCH_TOOL_NAME, XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch };
+//# sourceMappingURL=live_search.d.cts.map

package/dist/node_modules/@langchain/xai/dist/tools/live_search.d.ts

@@ -0,0 +1,149 @@
+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.
+ *
+ * @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";
+ *
+ * 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, XAILiveSearchToolOptions, XAI_LIVE_SEARCH_TOOL_NAME, XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch };
+//# sourceMappingURL=live_search.d.ts.map

package/dist/node_modules/@langchain/xai/dist/tools/live_search.js

@@ -0,0 +1,91 @@
+//#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.
+*
+* @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";
+*
+* 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_NAME, XAI_LIVE_SEARCH_TOOL_TYPE, xaiLiveSearch };
+//# sourceMappingURL=live_search.js.map

package/dist/node_modules/@langchain/xai/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/node_modules/@langchain/xai/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/node_modules/@langchain/xai/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