@langchain/xai 1.2.2 → 1.3.1

package/dist/tools/web_search.js

@@ -0,0 +1,55 @@
+//#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
+export { XAI_WEB_SEARCH_TOOL_TYPE, xaiWebSearch };
+//# sourceMappingURL=web_search.js.map

package/dist/tools/web_search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web_search.js","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/x_search.cjs

@@ -0,0 +1,63 @@
+
+//#region src/tools/x_search.ts
+/**
+* xAI X Search tool type constant.
+*/
+const XAI_X_SEARCH_TOOL_TYPE = "x_search";
+/**
+* Creates an xAI X search tool.
+* Enables the model to perform keyword search, semantic search, user search,
+* and thread fetch on X (formerly Twitter).
+*
+* This tool is executed server-side by the xAI API as part of the agentic
+* tool calling workflow.
+*
+* @param options - Configuration options for the X search tool
+* @returns An XAIXSearchTool 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 xSearch = tools.xaiXSearch();
+* const result = await llm.invoke("What is the current status of xAI?", {
+*   tools: [xSearch],
+* });
+* ```
+*
+* @example With handle filtering
+* ```typescript
+* const xSearch = tools.xaiXSearch({
+*   allowedXHandles: ["elonmusk", "xai"],
+*   enableImageUnderstanding: true,
+* });
+* ```
+*
+* @example With date range
+* ```typescript
+* const xSearch = tools.xaiXSearch({
+*   fromDate: "2024-10-01",
+*   toDate: "2024-10-31",
+*   enableVideoUnderstanding: true,
+* });
+* ```
+*/
+function xaiXSearch(options = {}) {
+	const tool = { type: XAI_X_SEARCH_TOOL_TYPE };
+	if (options.allowedXHandles !== void 0) tool.allowed_x_handles = options.allowedXHandles;
+	if (options.excludedXHandles !== void 0) tool.excluded_x_handles = options.excludedXHandles;
+	if (options.fromDate !== void 0) tool.from_date = options.fromDate;
+	if (options.toDate !== void 0) tool.to_date = options.toDate;
+	if (options.enableImageUnderstanding !== void 0) tool.enable_image_understanding = options.enableImageUnderstanding;
+	if (options.enableVideoUnderstanding !== void 0) tool.enable_video_understanding = options.enableVideoUnderstanding;
+	return tool;
+}
+
+//#endregion
+exports.XAI_X_SEARCH_TOOL_TYPE = XAI_X_SEARCH_TOOL_TYPE;
+exports.xaiXSearch = xaiXSearch;
+//# sourceMappingURL=x_search.cjs.map

package/dist/tools/x_search.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"x_search.cjs","names":["options: XAIXSearchToolOptions","tool: XAIXSearchTool"],"sources":["../../src/tools/x_search.ts"],"sourcesContent":["/**\n * xAI X Search tool type constant.\n */\nexport const XAI_X_SEARCH_TOOL_TYPE = \"x_search\";\n\n/**\n * xAI's built-in X (formerly Twitter) search tool interface.\n * Enables the model to perform keyword search, semantic search, user search,\n * and thread fetch on X.\n *\n * This tool is part of xAI's agentic tool calling API.\n */\nexport interface XAIXSearchTool {\n  /**\n   * The type of the tool. Must be \"x_search\".\n   */\n  type: typeof XAI_X_SEARCH_TOOL_TYPE;\n  /**\n   * X handles to exclusively include in the search (max 10).\n   * Cannot be used together with `excluded_x_handles`.\n   */\n  allowed_x_handles?: string[];\n  /**\n   * X handles to exclude from the search (max 10).\n   * Cannot be used together with `allowed_x_handles`.\n   */\n  excluded_x_handles?: string[];\n  /**\n   * Start date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n   * Only posts from this date onwards will be included.\n   */\n  from_date?: string;\n  /**\n   * End date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n   * Only posts up to this date will be included.\n   */\n  to_date?: string;\n  /**\n   * Whether to enable image understanding.\n   * When enabled, the model can analyze images in X posts.\n   */\n  enable_image_understanding?: boolean;\n  /**\n   * Whether to enable video understanding.\n   * When enabled, the model can analyze videos in X posts.\n   */\n  enable_video_understanding?: boolean;\n}\n\n/**\n * Options for the xAI X 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 XAIXSearchToolOptions {\n  /**\n   * X handles to exclusively include in the search (max 10).\n   * Cannot be used together with `excludedXHandles`.\n   *\n   * @example [\"elonmusk\", \"xai\"]\n   */\n  allowedXHandles?: string[];\n  /**\n   * X handles to exclude from the search (max 10).\n   * Cannot be used together with `allowedXHandles`.\n   *\n   * @example [\"spamaccount\"]\n   */\n  excludedXHandles?: string[];\n  /**\n   * Start date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n   * Only posts from this date onwards will be included.\n   *\n   * @example \"2024-01-01\"\n   */\n  fromDate?: string;\n  /**\n   * End date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n   * Only posts up to this date will be included.\n   *\n   * @example \"2024-12-31\"\n   */\n  toDate?: string;\n  /**\n   * Whether to enable image understanding.\n   * When enabled, the model can analyze images in X posts.\n   * Note: This increases token usage as images are processed.\n   *\n   * @default false\n   */\n  enableImageUnderstanding?: boolean;\n  /**\n   * Whether to enable video understanding.\n   * When enabled, the model can analyze videos in X posts.\n   * Note: This increases token usage as video content is processed.\n   *\n   * @default false\n   */\n  enableVideoUnderstanding?: boolean;\n}\n\n/**\n * Creates an xAI X search tool.\n * Enables the model to perform keyword search, semantic search, user search,\n * and thread fetch on X (formerly Twitter).\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 X search tool\n * @returns An XAIXSearchTool 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 xSearch = tools.xaiXSearch();\n * const result = await llm.invoke(\"What is the current status of xAI?\", {\n *   tools: [xSearch],\n * });\n * ```\n *\n * @example With handle filtering\n * ```typescript\n * const xSearch = tools.xaiXSearch({\n *   allowedXHandles: [\"elonmusk\", \"xai\"],\n *   enableImageUnderstanding: true,\n * });\n * ```\n *\n * @example With date range\n * ```typescript\n * const xSearch = tools.xaiXSearch({\n *   fromDate: \"2024-10-01\",\n *   toDate: \"2024-10-31\",\n *   enableVideoUnderstanding: true,\n * });\n * ```\n */\nexport function xaiXSearch(\n  options: XAIXSearchToolOptions = {}\n): XAIXSearchTool {\n  const tool: XAIXSearchTool = {\n    type: XAI_X_SEARCH_TOOL_TYPE,\n  };\n\n  if (options.allowedXHandles !== undefined) {\n    tool.allowed_x_handles = options.allowedXHandles;\n  }\n\n  if (options.excludedXHandles !== undefined) {\n    tool.excluded_x_handles = options.excludedXHandles;\n  }\n\n  if (options.fromDate !== undefined) {\n    tool.from_date = options.fromDate;\n  }\n\n  if (options.toDate !== undefined) {\n    tool.to_date = options.toDate;\n  }\n\n  if (options.enableImageUnderstanding !== undefined) {\n    tool.enable_image_understanding = options.enableImageUnderstanding;\n  }\n\n  if (options.enableVideoUnderstanding !== undefined) {\n    tool.enable_video_understanding = options.enableVideoUnderstanding;\n  }\n\n  return tool;\n}\n"],"mappings":";;;;;AAGA,MAAa,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4ItC,SAAgB,WACdA,UAAiC,CAAE,GACnB;CAChB,MAAMC,OAAuB,EAC3B,MAAM,uBACP;AAED,KAAI,QAAQ,oBAAoB,QAC9B,KAAK,oBAAoB,QAAQ;AAGnC,KAAI,QAAQ,qBAAqB,QAC/B,KAAK,qBAAqB,QAAQ;AAGpC,KAAI,QAAQ,aAAa,QACvB,KAAK,YAAY,QAAQ;AAG3B,KAAI,QAAQ,WAAW,QACrB,KAAK,UAAU,QAAQ;AAGzB,KAAI,QAAQ,6BAA6B,QACvC,KAAK,6BAA6B,QAAQ;AAG5C,KAAI,QAAQ,6BAA6B,QACvC,KAAK,6BAA6B,QAAQ;AAG5C,QAAO;AACR"}

package/dist/tools/x_search.d.cts

@@ -0,0 +1,145 @@
+//#region src/tools/x_search.d.ts
+/**
+ * xAI X Search tool type constant.
+ */
+declare const XAI_X_SEARCH_TOOL_TYPE = "x_search";
+/**
+ * xAI's built-in X (formerly Twitter) search tool interface.
+ * Enables the model to perform keyword search, semantic search, user search,
+ * and thread fetch on X.
+ *
+ * This tool is part of xAI's agentic tool calling API.
+ */
+interface XAIXSearchTool {
+  /**
+   * The type of the tool. Must be "x_search".
+   */
+  type: typeof XAI_X_SEARCH_TOOL_TYPE;
+  /**
+   * X handles to exclusively include in the search (max 10).
+   * Cannot be used together with `excluded_x_handles`.
+   */
+  allowed_x_handles?: string[];
+  /**
+   * X handles to exclude from the search (max 10).
+   * Cannot be used together with `allowed_x_handles`.
+   */
+  excluded_x_handles?: string[];
+  /**
+   * Start date for search results (ISO-8601 format: "YYYY-MM-DD").
+   * Only posts from this date onwards will be included.
+   */
+  from_date?: string;
+  /**
+   * End date for search results (ISO-8601 format: "YYYY-MM-DD").
+   * Only posts up to this date will be included.
+   */
+  to_date?: string;
+  /**
+   * Whether to enable image understanding.
+   * When enabled, the model can analyze images in X posts.
+   */
+  enable_image_understanding?: boolean;
+  /**
+   * Whether to enable video understanding.
+   * When enabled, the model can analyze videos in X posts.
+   */
+  enable_video_understanding?: boolean;
+}
+/**
+ * Options for the xAI X 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 XAIXSearchToolOptions {
+  /**
+   * X handles to exclusively include in the search (max 10).
+   * Cannot be used together with `excludedXHandles`.
+   *
+   * @example ["elonmusk", "xai"]
+   */
+  allowedXHandles?: string[];
+  /**
+   * X handles to exclude from the search (max 10).
+   * Cannot be used together with `allowedXHandles`.
+   *
+   * @example ["spamaccount"]
+   */
+  excludedXHandles?: string[];
+  /**
+   * Start date for search results (ISO-8601 format: "YYYY-MM-DD").
+   * Only posts from this date onwards will be included.
+   *
+   * @example "2024-01-01"
+   */
+  fromDate?: string;
+  /**
+   * End date for search results (ISO-8601 format: "YYYY-MM-DD").
+   * Only posts up to this date will be included.
+   *
+   * @example "2024-12-31"
+   */
+  toDate?: string;
+  /**
+   * Whether to enable image understanding.
+   * When enabled, the model can analyze images in X posts.
+   * Note: This increases token usage as images are processed.
+   *
+   * @default false
+   */
+  enableImageUnderstanding?: boolean;
+  /**
+   * Whether to enable video understanding.
+   * When enabled, the model can analyze videos in X posts.
+   * Note: This increases token usage as video content is processed.
+   *
+   * @default false
+   */
+  enableVideoUnderstanding?: boolean;
+}
+/**
+ * Creates an xAI X search tool.
+ * Enables the model to perform keyword search, semantic search, user search,
+ * and thread fetch on X (formerly Twitter).
+ *
+ * This tool is executed server-side by the xAI API as part of the agentic
+ * tool calling workflow.
+ *
+ * @param options - Configuration options for the X search tool
+ * @returns An XAIXSearchTool 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 xSearch = tools.xaiXSearch();
+ * const result = await llm.invoke("What is the current status of xAI?", {
+ *   tools: [xSearch],
+ * });
+ * ```
+ *
+ * @example With handle filtering
+ * ```typescript
+ * const xSearch = tools.xaiXSearch({
+ *   allowedXHandles: ["elonmusk", "xai"],
+ *   enableImageUnderstanding: true,
+ * });
+ * ```
+ *
+ * @example With date range
+ * ```typescript
+ * const xSearch = tools.xaiXSearch({
+ *   fromDate: "2024-10-01",
+ *   toDate: "2024-10-31",
+ *   enableVideoUnderstanding: true,
+ * });
+ * ```
+ */
+declare function xaiXSearch(options?: XAIXSearchToolOptions): XAIXSearchTool;
+//#endregion
+export { XAIXSearchTool, XAIXSearchToolOptions, XAI_X_SEARCH_TOOL_TYPE, xaiXSearch };
+//# sourceMappingURL=x_search.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"x_search.d.cts","names":["XAI_X_SEARCH_TOOL_TYPE","XAIXSearchTool","XAIXSearchToolOptions","xaiXSearch"],"sources":["../../src/tools/x_search.d.ts"],"sourcesContent":["/**\n * xAI X Search tool type constant.\n */\nexport declare const XAI_X_SEARCH_TOOL_TYPE = \"x_search\";\n/**\n * xAI's built-in X (formerly Twitter) search tool interface.\n * Enables the model to perform keyword search, semantic search, user search,\n * and thread fetch on X.\n *\n * This tool is part of xAI's agentic tool calling API.\n */\nexport interface XAIXSearchTool {\n    /**\n     * The type of the tool. Must be \"x_search\".\n     */\n    type: typeof XAI_X_SEARCH_TOOL_TYPE;\n    /**\n     * X handles to exclusively include in the search (max 10).\n     * Cannot be used together with `excluded_x_handles`.\n     */\n    allowed_x_handles?: string[];\n    /**\n     * X handles to exclude from the search (max 10).\n     * Cannot be used together with `allowed_x_handles`.\n     */\n    excluded_x_handles?: string[];\n    /**\n     * Start date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n     * Only posts from this date onwards will be included.\n     */\n    from_date?: string;\n    /**\n     * End date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n     * Only posts up to this date will be included.\n     */\n    to_date?: string;\n    /**\n     * Whether to enable image understanding.\n     * When enabled, the model can analyze images in X posts.\n     */\n    enable_image_understanding?: boolean;\n    /**\n     * Whether to enable video understanding.\n     * When enabled, the model can analyze videos in X posts.\n     */\n    enable_video_understanding?: boolean;\n}\n/**\n * Options for the xAI X 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 XAIXSearchToolOptions {\n    /**\n     * X handles to exclusively include in the search (max 10).\n     * Cannot be used together with `excludedXHandles`.\n     *\n     * @example [\"elonmusk\", \"xai\"]\n     */\n    allowedXHandles?: string[];\n    /**\n     * X handles to exclude from the search (max 10).\n     * Cannot be used together with `allowedXHandles`.\n     *\n     * @example [\"spamaccount\"]\n     */\n    excludedXHandles?: string[];\n    /**\n     * Start date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n     * Only posts from this date onwards will be included.\n     *\n     * @example \"2024-01-01\"\n     */\n    fromDate?: string;\n    /**\n     * End date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n     * Only posts up to this date will be included.\n     *\n     * @example \"2024-12-31\"\n     */\n    toDate?: string;\n    /**\n     * Whether to enable image understanding.\n     * When enabled, the model can analyze images in X posts.\n     * Note: This increases token usage as images are processed.\n     *\n     * @default false\n     */\n    enableImageUnderstanding?: boolean;\n    /**\n     * Whether to enable video understanding.\n     * When enabled, the model can analyze videos in X posts.\n     * Note: This increases token usage as video content is processed.\n     *\n     * @default false\n     */\n    enableVideoUnderstanding?: boolean;\n}\n/**\n * Creates an xAI X search tool.\n * Enables the model to perform keyword search, semantic search, user search,\n * and thread fetch on X (formerly Twitter).\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 X search tool\n * @returns An XAIXSearchTool 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 xSearch = tools.xaiXSearch();\n * const result = await llm.invoke(\"What is the current status of xAI?\", {\n *   tools: [xSearch],\n * });\n * ```\n *\n * @example With handle filtering\n * ```typescript\n * const xSearch = tools.xaiXSearch({\n *   allowedXHandles: [\"elonmusk\", \"xai\"],\n *   enableImageUnderstanding: true,\n * });\n * ```\n *\n * @example With date range\n * ```typescript\n * const xSearch = tools.xaiXSearch({\n *   fromDate: \"2024-10-01\",\n *   toDate: \"2024-10-31\",\n *   enableVideoUnderstanding: true,\n * });\n * ```\n */\nexport declare function xaiXSearch(options?: XAIXSearchToolOptions): XAIXSearchTool;\n//# sourceMappingURL=x_search.d.ts.map"],"mappings":";;AAGA;AAQA;AAyCiBE,cAjDIF,sBAAAA,GAiDiB,UAAA;AAwFtC;;;;;;;UAjIiBC,cAAAA;;;;eAIAD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAqCAE,qBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAwFOC,UAAAA,WAAqBD,wBAAwBD"}

package/dist/tools/x_search.d.ts

@@ -0,0 +1,145 @@
+//#region src/tools/x_search.d.ts
+/**
+ * xAI X Search tool type constant.
+ */
+declare const XAI_X_SEARCH_TOOL_TYPE = "x_search";
+/**
+ * xAI's built-in X (formerly Twitter) search tool interface.
+ * Enables the model to perform keyword search, semantic search, user search,
+ * and thread fetch on X.
+ *
+ * This tool is part of xAI's agentic tool calling API.
+ */
+interface XAIXSearchTool {
+  /**
+   * The type of the tool. Must be "x_search".
+   */
+  type: typeof XAI_X_SEARCH_TOOL_TYPE;
+  /**
+   * X handles to exclusively include in the search (max 10).
+   * Cannot be used together with `excluded_x_handles`.
+   */
+  allowed_x_handles?: string[];
+  /**
+   * X handles to exclude from the search (max 10).
+   * Cannot be used together with `allowed_x_handles`.
+   */
+  excluded_x_handles?: string[];
+  /**
+   * Start date for search results (ISO-8601 format: "YYYY-MM-DD").
+   * Only posts from this date onwards will be included.
+   */
+  from_date?: string;
+  /**
+   * End date for search results (ISO-8601 format: "YYYY-MM-DD").
+   * Only posts up to this date will be included.
+   */
+  to_date?: string;
+  /**
+   * Whether to enable image understanding.
+   * When enabled, the model can analyze images in X posts.
+   */
+  enable_image_understanding?: boolean;
+  /**
+   * Whether to enable video understanding.
+   * When enabled, the model can analyze videos in X posts.
+   */
+  enable_video_understanding?: boolean;
+}
+/**
+ * Options for the xAI X 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 XAIXSearchToolOptions {
+  /**
+   * X handles to exclusively include in the search (max 10).
+   * Cannot be used together with `excludedXHandles`.
+   *
+   * @example ["elonmusk", "xai"]
+   */
+  allowedXHandles?: string[];
+  /**
+   * X handles to exclude from the search (max 10).
+   * Cannot be used together with `allowedXHandles`.
+   *
+   * @example ["spamaccount"]
+   */
+  excludedXHandles?: string[];
+  /**
+   * Start date for search results (ISO-8601 format: "YYYY-MM-DD").
+   * Only posts from this date onwards will be included.
+   *
+   * @example "2024-01-01"
+   */
+  fromDate?: string;
+  /**
+   * End date for search results (ISO-8601 format: "YYYY-MM-DD").
+   * Only posts up to this date will be included.
+   *
+   * @example "2024-12-31"
+   */
+  toDate?: string;
+  /**
+   * Whether to enable image understanding.
+   * When enabled, the model can analyze images in X posts.
+   * Note: This increases token usage as images are processed.
+   *
+   * @default false
+   */
+  enableImageUnderstanding?: boolean;
+  /**
+   * Whether to enable video understanding.
+   * When enabled, the model can analyze videos in X posts.
+   * Note: This increases token usage as video content is processed.
+   *
+   * @default false
+   */
+  enableVideoUnderstanding?: boolean;
+}
+/**
+ * Creates an xAI X search tool.
+ * Enables the model to perform keyword search, semantic search, user search,
+ * and thread fetch on X (formerly Twitter).
+ *
+ * This tool is executed server-side by the xAI API as part of the agentic
+ * tool calling workflow.
+ *
+ * @param options - Configuration options for the X search tool
+ * @returns An XAIXSearchTool 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 xSearch = tools.xaiXSearch();
+ * const result = await llm.invoke("What is the current status of xAI?", {
+ *   tools: [xSearch],
+ * });
+ * ```
+ *
+ * @example With handle filtering
+ * ```typescript
+ * const xSearch = tools.xaiXSearch({
+ *   allowedXHandles: ["elonmusk", "xai"],
+ *   enableImageUnderstanding: true,
+ * });
+ * ```
+ *
+ * @example With date range
+ * ```typescript
+ * const xSearch = tools.xaiXSearch({
+ *   fromDate: "2024-10-01",
+ *   toDate: "2024-10-31",
+ *   enableVideoUnderstanding: true,
+ * });
+ * ```
+ */
+declare function xaiXSearch(options?: XAIXSearchToolOptions): XAIXSearchTool;
+//#endregion
+export { XAIXSearchTool, XAIXSearchToolOptions, XAI_X_SEARCH_TOOL_TYPE, xaiXSearch };
+//# sourceMappingURL=x_search.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"x_search.d.ts","names":["XAI_X_SEARCH_TOOL_TYPE","XAIXSearchTool","XAIXSearchToolOptions","xaiXSearch"],"sources":["../../src/tools/x_search.d.ts"],"sourcesContent":["/**\n * xAI X Search tool type constant.\n */\nexport declare const XAI_X_SEARCH_TOOL_TYPE = \"x_search\";\n/**\n * xAI's built-in X (formerly Twitter) search tool interface.\n * Enables the model to perform keyword search, semantic search, user search,\n * and thread fetch on X.\n *\n * This tool is part of xAI's agentic tool calling API.\n */\nexport interface XAIXSearchTool {\n    /**\n     * The type of the tool. Must be \"x_search\".\n     */\n    type: typeof XAI_X_SEARCH_TOOL_TYPE;\n    /**\n     * X handles to exclusively include in the search (max 10).\n     * Cannot be used together with `excluded_x_handles`.\n     */\n    allowed_x_handles?: string[];\n    /**\n     * X handles to exclude from the search (max 10).\n     * Cannot be used together with `allowed_x_handles`.\n     */\n    excluded_x_handles?: string[];\n    /**\n     * Start date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n     * Only posts from this date onwards will be included.\n     */\n    from_date?: string;\n    /**\n     * End date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n     * Only posts up to this date will be included.\n     */\n    to_date?: string;\n    /**\n     * Whether to enable image understanding.\n     * When enabled, the model can analyze images in X posts.\n     */\n    enable_image_understanding?: boolean;\n    /**\n     * Whether to enable video understanding.\n     * When enabled, the model can analyze videos in X posts.\n     */\n    enable_video_understanding?: boolean;\n}\n/**\n * Options for the xAI X 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 XAIXSearchToolOptions {\n    /**\n     * X handles to exclusively include in the search (max 10).\n     * Cannot be used together with `excludedXHandles`.\n     *\n     * @example [\"elonmusk\", \"xai\"]\n     */\n    allowedXHandles?: string[];\n    /**\n     * X handles to exclude from the search (max 10).\n     * Cannot be used together with `allowedXHandles`.\n     *\n     * @example [\"spamaccount\"]\n     */\n    excludedXHandles?: string[];\n    /**\n     * Start date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n     * Only posts from this date onwards will be included.\n     *\n     * @example \"2024-01-01\"\n     */\n    fromDate?: string;\n    /**\n     * End date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n     * Only posts up to this date will be included.\n     *\n     * @example \"2024-12-31\"\n     */\n    toDate?: string;\n    /**\n     * Whether to enable image understanding.\n     * When enabled, the model can analyze images in X posts.\n     * Note: This increases token usage as images are processed.\n     *\n     * @default false\n     */\n    enableImageUnderstanding?: boolean;\n    /**\n     * Whether to enable video understanding.\n     * When enabled, the model can analyze videos in X posts.\n     * Note: This increases token usage as video content is processed.\n     *\n     * @default false\n     */\n    enableVideoUnderstanding?: boolean;\n}\n/**\n * Creates an xAI X search tool.\n * Enables the model to perform keyword search, semantic search, user search,\n * and thread fetch on X (formerly Twitter).\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 X search tool\n * @returns An XAIXSearchTool 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 xSearch = tools.xaiXSearch();\n * const result = await llm.invoke(\"What is the current status of xAI?\", {\n *   tools: [xSearch],\n * });\n * ```\n *\n * @example With handle filtering\n * ```typescript\n * const xSearch = tools.xaiXSearch({\n *   allowedXHandles: [\"elonmusk\", \"xai\"],\n *   enableImageUnderstanding: true,\n * });\n * ```\n *\n * @example With date range\n * ```typescript\n * const xSearch = tools.xaiXSearch({\n *   fromDate: \"2024-10-01\",\n *   toDate: \"2024-10-31\",\n *   enableVideoUnderstanding: true,\n * });\n * ```\n */\nexport declare function xaiXSearch(options?: XAIXSearchToolOptions): XAIXSearchTool;\n//# sourceMappingURL=x_search.d.ts.map"],"mappings":";;AAGA;AAQA;AAyCiBE,cAjDIF,sBAAAA,GAiDiB,UAAA;AAwFtC;;;;;;;UAjIiBC,cAAAA;;;;eAIAD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAqCAE,qBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAwFOC,UAAAA,WAAqBD,wBAAwBD"}

package/dist/tools/x_search.js

@@ -0,0 +1,61 @@
+//#region src/tools/x_search.ts
+/**
+* xAI X Search tool type constant.
+*/
+const XAI_X_SEARCH_TOOL_TYPE = "x_search";
+/**
+* Creates an xAI X search tool.
+* Enables the model to perform keyword search, semantic search, user search,
+* and thread fetch on X (formerly Twitter).
+*
+* This tool is executed server-side by the xAI API as part of the agentic
+* tool calling workflow.
+*
+* @param options - Configuration options for the X search tool
+* @returns An XAIXSearchTool 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 xSearch = tools.xaiXSearch();
+* const result = await llm.invoke("What is the current status of xAI?", {
+*   tools: [xSearch],
+* });
+* ```
+*
+* @example With handle filtering
+* ```typescript
+* const xSearch = tools.xaiXSearch({
+*   allowedXHandles: ["elonmusk", "xai"],
+*   enableImageUnderstanding: true,
+* });
+* ```
+*
+* @example With date range
+* ```typescript
+* const xSearch = tools.xaiXSearch({
+*   fromDate: "2024-10-01",
+*   toDate: "2024-10-31",
+*   enableVideoUnderstanding: true,
+* });
+* ```
+*/
+function xaiXSearch(options = {}) {
+	const tool = { type: XAI_X_SEARCH_TOOL_TYPE };
+	if (options.allowedXHandles !== void 0) tool.allowed_x_handles = options.allowedXHandles;
+	if (options.excludedXHandles !== void 0) tool.excluded_x_handles = options.excludedXHandles;
+	if (options.fromDate !== void 0) tool.from_date = options.fromDate;
+	if (options.toDate !== void 0) tool.to_date = options.toDate;
+	if (options.enableImageUnderstanding !== void 0) tool.enable_image_understanding = options.enableImageUnderstanding;
+	if (options.enableVideoUnderstanding !== void 0) tool.enable_video_understanding = options.enableVideoUnderstanding;
+	return tool;
+}
+
+//#endregion
+export { XAI_X_SEARCH_TOOL_TYPE, xaiXSearch };
+//# sourceMappingURL=x_search.js.map

package/dist/tools/x_search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"x_search.js","names":["options: XAIXSearchToolOptions","tool: XAIXSearchTool"],"sources":["../../src/tools/x_search.ts"],"sourcesContent":["/**\n * xAI X Search tool type constant.\n */\nexport const XAI_X_SEARCH_TOOL_TYPE = \"x_search\";\n\n/**\n * xAI's built-in X (formerly Twitter) search tool interface.\n * Enables the model to perform keyword search, semantic search, user search,\n * and thread fetch on X.\n *\n * This tool is part of xAI's agentic tool calling API.\n */\nexport interface XAIXSearchTool {\n  /**\n   * The type of the tool. Must be \"x_search\".\n   */\n  type: typeof XAI_X_SEARCH_TOOL_TYPE;\n  /**\n   * X handles to exclusively include in the search (max 10).\n   * Cannot be used together with `excluded_x_handles`.\n   */\n  allowed_x_handles?: string[];\n  /**\n   * X handles to exclude from the search (max 10).\n   * Cannot be used together with `allowed_x_handles`.\n   */\n  excluded_x_handles?: string[];\n  /**\n   * Start date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n   * Only posts from this date onwards will be included.\n   */\n  from_date?: string;\n  /**\n   * End date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n   * Only posts up to this date will be included.\n   */\n  to_date?: string;\n  /**\n   * Whether to enable image understanding.\n   * When enabled, the model can analyze images in X posts.\n   */\n  enable_image_understanding?: boolean;\n  /**\n   * Whether to enable video understanding.\n   * When enabled, the model can analyze videos in X posts.\n   */\n  enable_video_understanding?: boolean;\n}\n\n/**\n * Options for the xAI X 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 XAIXSearchToolOptions {\n  /**\n   * X handles to exclusively include in the search (max 10).\n   * Cannot be used together with `excludedXHandles`.\n   *\n   * @example [\"elonmusk\", \"xai\"]\n   */\n  allowedXHandles?: string[];\n  /**\n   * X handles to exclude from the search (max 10).\n   * Cannot be used together with `allowedXHandles`.\n   *\n   * @example [\"spamaccount\"]\n   */\n  excludedXHandles?: string[];\n  /**\n   * Start date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n   * Only posts from this date onwards will be included.\n   *\n   * @example \"2024-01-01\"\n   */\n  fromDate?: string;\n  /**\n   * End date for search results (ISO-8601 format: \"YYYY-MM-DD\").\n   * Only posts up to this date will be included.\n   *\n   * @example \"2024-12-31\"\n   */\n  toDate?: string;\n  /**\n   * Whether to enable image understanding.\n   * When enabled, the model can analyze images in X posts.\n   * Note: This increases token usage as images are processed.\n   *\n   * @default false\n   */\n  enableImageUnderstanding?: boolean;\n  /**\n   * Whether to enable video understanding.\n   * When enabled, the model can analyze videos in X posts.\n   * Note: This increases token usage as video content is processed.\n   *\n   * @default false\n   */\n  enableVideoUnderstanding?: boolean;\n}\n\n/**\n * Creates an xAI X search tool.\n * Enables the model to perform keyword search, semantic search, user search,\n * and thread fetch on X (formerly Twitter).\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 X search tool\n * @returns An XAIXSearchTool 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 xSearch = tools.xaiXSearch();\n * const result = await llm.invoke(\"What is the current status of xAI?\", {\n *   tools: [xSearch],\n * });\n * ```\n *\n * @example With handle filtering\n * ```typescript\n * const xSearch = tools.xaiXSearch({\n *   allowedXHandles: [\"elonmusk\", \"xai\"],\n *   enableImageUnderstanding: true,\n * });\n * ```\n *\n * @example With date range\n * ```typescript\n * const xSearch = tools.xaiXSearch({\n *   fromDate: \"2024-10-01\",\n *   toDate: \"2024-10-31\",\n *   enableVideoUnderstanding: true,\n * });\n * ```\n */\nexport function xaiXSearch(\n  options: XAIXSearchToolOptions = {}\n): XAIXSearchTool {\n  const tool: XAIXSearchTool = {\n    type: XAI_X_SEARCH_TOOL_TYPE,\n  };\n\n  if (options.allowedXHandles !== undefined) {\n    tool.allowed_x_handles = options.allowedXHandles;\n  }\n\n  if (options.excludedXHandles !== undefined) {\n    tool.excluded_x_handles = options.excludedXHandles;\n  }\n\n  if (options.fromDate !== undefined) {\n    tool.from_date = options.fromDate;\n  }\n\n  if (options.toDate !== undefined) {\n    tool.to_date = options.toDate;\n  }\n\n  if (options.enableImageUnderstanding !== undefined) {\n    tool.enable_image_understanding = options.enableImageUnderstanding;\n  }\n\n  if (options.enableVideoUnderstanding !== undefined) {\n    tool.enable_video_understanding = options.enableVideoUnderstanding;\n  }\n\n  return tool;\n}\n"],"mappings":";;;;AAGA,MAAa,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4ItC,SAAgB,WACdA,UAAiC,CAAE,GACnB;CAChB,MAAMC,OAAuB,EAC3B,MAAM,uBACP;AAED,KAAI,QAAQ,oBAAoB,QAC9B,KAAK,oBAAoB,QAAQ;AAGnC,KAAI,QAAQ,qBAAqB,QAC/B,KAAK,qBAAqB,QAAQ;AAGpC,KAAI,QAAQ,aAAa,QACvB,KAAK,YAAY,QAAQ;AAG3B,KAAI,QAAQ,WAAW,QACrB,KAAK,UAAU,QAAQ;AAGzB,KAAI,QAAQ,6BAA6B,QACvC,KAAK,6BAA6B,QAAQ;AAG5C,KAAI,QAAQ,6BAA6B,QACvC,KAAK,6BAA6B,QAAQ;AAG5C,QAAO;AACR"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/xai",
-  "version": "1.2.2",
+  "version": "1.3.1",
   "description": "xAI integration for LangChain.js",
   "author": "LangChain",
   "license": "MIT",
@@ -14,7 +14,7 @@
   },
   "homepage": "https://github.com/langchain-ai/langchainjs/tree/main/libs/langchain-xai/",
   "dependencies": {
-    "@langchain/openai": "1.2.3"
+    "@langchain/openai": "1.2.5"
   },
   "peerDependencies": {
     "@langchain/core": "^1.0.0"
@@ -30,10 +30,10 @@
     "typescript": "~5.8.3",
     "vitest": "^3.2.4",
     "zod": "^3.25.76",
+    "@langchain/core": "1.1.19",
     "@langchain/eslint": "0.1.1",
-    "@langchain/openai": "^1.2.3",
-    "@langchain/standard-tests": "0.0.19",
-    "@langchain/core": "1.1.16",
+    "@langchain/openai": "^1.2.5",
+    "@langchain/standard-tests": "0.0.22",
     "@langchain/tsconfig": "0.0.1"
   },
   "publishConfig": {