ChatXAI 集成

使用 LangChain JavaScript 集成 ChatXAI 对话模型。

本页面记录了来自 xAI 的 Grok 模型。不要将 xAI 与 Groq 混淆，Groq 是一个独立的推理提供者。请参阅 Groq 集成。

xAI 开发 Grok 对话模型。有关可用的模型 ID，请参阅 xAI 模型文档。

本指南将帮助您开始使用 ChatXAI 对话模型。有关所有 ChatXAI 功能和配置的详细文档，请前往 API 参考。

概述

集成详情

类	包	可序列化	PY 支持	下载次数	版本
ChatXAI	@langchain/xai	✅	✅

模型功能

请查看表头中的链接，了解如何使用特定功能。

工具调用	结构化输出	图像输入	音频输入	视频输入	Token 级流式输出	Token 使用情况	Logprobs
✅	✅	❌	❌	❌	✅	✅	✅

设置

要访问 ChatXAI 模型，请创建一个 xAI 账户，获取 API 密钥，并安装 @langchain/xai 集成包。

凭证

前往 xAI 网站 注册并生成 API 密钥。设置 XAI_API_KEY 环境变量：

export XAI_API_KEY="your-api-key"

如果您希望自动跟踪您的模型调用，您还可以通过取消注释以下内容来设置您的 LangSmith API 密钥：

# export LANGSMITH_TRACING="true"
# export LANGSMITH_API_KEY="your-api-key"

安装

LangChain ChatXAI 集成位于 @langchain/xai 包中：

npm

npm install @langchain/xai @langchain/core

实例化

现在我们可以实例化我们的模型对象并生成对话补全：

import { ChatXAI } from "@langchain/xai";

const llm = new ChatXAI({
    model: "grok-3-fast",
    temperature: 0,
    maxTokens: undefined,
    maxRetries: 2,
    // other params...
})

调用

const aiMsg = await llm.invoke([
    [
      "system",
      "You are a helpful assistant that translates English to French. Translate the user sentence.",
    ],
    ["human", "I love programming."],
])
console.log(aiMsg)

AIMessage {
  "id": "71d7e3d8-30dd-472c-8038-b6b283dcee63",
  "content": "J'adore programmer.",
  "additional_kwargs": {},
  "response_metadata": {
    "tokenUsage": {
      "promptTokens": 30,
      "completionTokens": 6,
      "totalTokens": 36
    },
    "finish_reason": "stop",
    "usage": {
      "prompt_tokens": 30,
      "completion_tokens": 6,
      "total_tokens": 36
    },
    "system_fingerprint": "fp_3e3898d4ce"
  },
  "tool_calls": [],
  "invalid_tool_calls": [],
  "usage_metadata": {
    "output_tokens": 6,
    "input_tokens": 30,
    "total_tokens": 36,
    "input_token_details": {},
    "output_token_details": {}
  }
}

console.log(aiMsg.content)

J'adore programmer.

---

API 参考

有关所有 ChatXAI 功能和配置的详细文档，请前往 API 参考。

---

官方原文：src/oss/javascript/integrations/chat/xai.mdx · 非官方翻译，译文由 AI 生成，以英文原文为准。