@langchain/xai 0.0.1 → 0.0.2

package/dist/chat_models.cjs

@@ -16,9 +16,9 @@ const openai_1 = require("@langchain/openai");
  * export XAI_API_KEY="your-api-key"
  * ```
  *
- * ## [Constructor args](https://api.js.langchain.com/classes/langchain_xai.ChatXAI.html#constructor)
+ * ## [Constructor args](https://api.js.langchain.com/classes/_langchain_xai.ChatXAI.html#constructor)
  *
- * ## [Runtime args](https://api.js.langchain.com/interfaces/langchain_xai.ChatXAICallOptions.html)
+ * ## [Runtime args](https://api.js.langchain.com/interfaces/_langchain_xai.ChatXAICallOptions.html)
  *
  * Runtime args can be passed as the second argument to any of the base runnable methods `.invoke`. `.stream`, `.batch`, etc.
  * They can also be passed via `.bind`, or the second arg in `.bindTools`, like shown in the examples below:
@@ -334,7 +334,7 @@ class ChatXAI extends openai_1.ChatOpenAI {
         return "ChatXAI";
     }
     _llmType() {
-        return "xAI";
+        return "xai";
     }
     get lc_secrets() {
         return {
@@ -411,5 +411,33 @@ class ChatXAI extends openai_1.ChatOpenAI {
         }
         return super.completionWithRetry(newRequest, options);
     }
+    _convertOpenAIDeltaToBaseMessageChunk(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    delta, rawResponse, defaultRole) {
+        const messageChunk = super._convertOpenAIDeltaToBaseMessageChunk(delta, rawResponse, defaultRole);
+        // Make concatenating chunks work without merge warning
+        if (!rawResponse.choices[0]?.finish_reason) {
+            delete messageChunk.response_metadata.usage;
+            delete messageChunk.usage_metadata;
+        }
+        else {
+            messageChunk.usage_metadata = messageChunk.response_metadata.usage;
+        }
+        return messageChunk;
+    }
+    _convertOpenAIChatCompletionMessageToBaseMessage(message, rawResponse) {
+        const langChainMessage = super._convertOpenAIChatCompletionMessageToBaseMessage(message, rawResponse);
+        langChainMessage.additional_kwargs.reasoning_content =
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            message.reasoning_content;
+        return langChainMessage;
+    }
+    withStructuredOutput(outputSchema, config) {
+        const ensuredConfig = { ...config };
+        if (ensuredConfig?.method === undefined) {
+            ensuredConfig.method = "functionCalling";
+        }
+        return super.withStructuredOutput(outputSchema, ensuredConfig);
+    }
 }
 exports.ChatXAI = ChatXAI;

package/dist/chat_models.d.ts

@@ -1,6 +1,10 @@
+import { BaseLanguageModelInput } from "@langchain/core/language_models/base";
 import { BaseChatModelCallOptions, BindToolsInput, LangSmithParams, type BaseChatModelParams } from "@langchain/core/language_models/chat_models";
 import { Serialized } from "@langchain/core/load/serializable";
-import { type OpenAICoreRequestOptions, type OpenAIClient, ChatOpenAI, OpenAIToolChoice } from "@langchain/openai";
+import { AIMessageChunk, BaseMessage } from "@langchain/core/messages";
+import { Runnable } from "@langchain/core/runnables";
+import { type OpenAICoreRequestOptions, type OpenAIClient, ChatOpenAI, OpenAIToolChoice, ChatOpenAIStructuredOutputMethodOptions } from "@langchain/openai";
+import { z } from "zod";
 type ChatXAIToolType = BindToolsInput | OpenAIClient.ChatCompletionTool;
 export interface ChatXAICallOptions extends BaseChatModelCallOptions {
     headers?: Record<string, string>;
@@ -57,9 +61,9 @@ export interface ChatXAIInput extends BaseChatModelParams {
  * export XAI_API_KEY="your-api-key"
  * ```
  *
- * ## [Constructor args](https://api.js.langchain.com/classes/langchain_xai.ChatXAI.html#constructor)
+ * ## [Constructor args](https://api.js.langchain.com/classes/_langchain_xai.ChatXAI.html#constructor)
  *
- * ## [Runtime args](https://api.js.langchain.com/interfaces/langchain_xai.ChatXAICallOptions.html)
+ * ## [Runtime args](https://api.js.langchain.com/interfaces/_langchain_xai.ChatXAICallOptions.html)
  *
  * Runtime args can be passed as the second argument to any of the base runnable methods `.invoke`. `.stream`, `.batch`, etc.
  * They can also be passed via `.bind`, or the second arg in `.bindTools`, like shown in the examples below:
@@ -383,5 +387,16 @@ export declare class ChatXAI extends ChatOpenAI<ChatXAICallOptions> {
     getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
     completionWithRetry(request: OpenAIClient.Chat.ChatCompletionCreateParamsStreaming, options?: OpenAICoreRequestOptions): Promise<AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>>;
     completionWithRetry(request: OpenAIClient.Chat.ChatCompletionCreateParamsNonStreaming, options?: OpenAICoreRequestOptions): Promise<OpenAIClient.Chat.Completions.ChatCompletion>;
+    protected _convertOpenAIDeltaToBaseMessageChunk(delta: Record<string, any>, rawResponse: OpenAIClient.ChatCompletionChunk, defaultRole?: "function" | "user" | "system" | "developer" | "assistant" | "tool"): AIMessageChunk;
+    protected _convertOpenAIChatCompletionMessageToBaseMessage(message: OpenAIClient.ChatCompletionMessage, rawResponse: OpenAIClient.ChatCompletion): BaseMessage;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: z.ZodType<RunOutput> | Record<string, any>, config?: ChatOpenAIStructuredOutputMethodOptions<false>): Runnable<BaseLanguageModelInput, RunOutput>;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: z.ZodType<RunOutput> | Record<string, any>, config?: ChatOpenAIStructuredOutputMethodOptions<true>): Runnable<BaseLanguageModelInput, {
+        raw: BaseMessage;
+        parsed: RunOutput;
+    }>;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: z.ZodType<RunOutput> | Record<string, any>, config?: ChatOpenAIStructuredOutputMethodOptions<boolean>): Runnable<BaseLanguageModelInput, RunOutput> | Runnable<BaseLanguageModelInput, {
+        raw: BaseMessage;
+        parsed: RunOutput;
+    }>;
 }
 export {};

package/dist/chat_models.js

@@ -13,9 +13,9 @@ import { ChatOpenAI, } from "@langchain/openai";
  * export XAI_API_KEY="your-api-key"
  * ```
  *
- * ## [Constructor args](https://api.js.langchain.com/classes/langchain_xai.ChatXAI.html#constructor)
+ * ## [Constructor args](https://api.js.langchain.com/classes/_langchain_xai.ChatXAI.html#constructor)
  *
- * ## [Runtime args](https://api.js.langchain.com/interfaces/langchain_xai.ChatXAICallOptions.html)
+ * ## [Runtime args](https://api.js.langchain.com/interfaces/_langchain_xai.ChatXAICallOptions.html)
  *
  * Runtime args can be passed as the second argument to any of the base runnable methods `.invoke`. `.stream`, `.batch`, etc.
  * They can also be passed via `.bind`, or the second arg in `.bindTools`, like shown in the examples below:
@@ -331,7 +331,7 @@ export class ChatXAI extends ChatOpenAI {
         return "ChatXAI";
     }
     _llmType() {
-        return "xAI";
+        return "xai";
     }
     get lc_secrets() {
         return {
@@ -408,4 +408,32 @@ export class ChatXAI extends ChatOpenAI {
         }
         return super.completionWithRetry(newRequest, options);
     }
+    _convertOpenAIDeltaToBaseMessageChunk(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    delta, rawResponse, defaultRole) {
+        const messageChunk = super._convertOpenAIDeltaToBaseMessageChunk(delta, rawResponse, defaultRole);
+        // Make concatenating chunks work without merge warning
+        if (!rawResponse.choices[0]?.finish_reason) {
+            delete messageChunk.response_metadata.usage;
+            delete messageChunk.usage_metadata;
+        }
+        else {
+            messageChunk.usage_metadata = messageChunk.response_metadata.usage;
+        }
+        return messageChunk;
+    }
+    _convertOpenAIChatCompletionMessageToBaseMessage(message, rawResponse) {
+        const langChainMessage = super._convertOpenAIChatCompletionMessageToBaseMessage(message, rawResponse);
+        langChainMessage.additional_kwargs.reasoning_content =
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            message.reasoning_content;
+        return langChainMessage;
+    }
+    withStructuredOutput(outputSchema, config) {
+        const ensuredConfig = { ...config };
+        if (ensuredConfig?.method === undefined) {
+            ensuredConfig.method = "functionCalling";
+        }
+        return super.withStructuredOutput(outputSchema, ensuredConfig);
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/xai",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "xAI integration for LangChain.js",
   "type": "module",
   "engines": {
@@ -35,7 +35,8 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/openai": "~0.3.0"
+    "@langchain/openai": "~0.4.4",
+    "zod": "^3.24.2"
   },
   "peerDependencies": {
     "@langchain/core": ">=0.2.21 <0.4.0"
@@ -67,7 +68,7 @@
     "rollup": "^4.5.2",
     "ts-jest": "^29.1.0",
     "typescript": "<5.2.0",
-    "zod": "^3.22.4"
+    "zod-to-json-schema": "^3.23.1"
   },
   "publishConfig": {
     "access": "public"