xAI 开发 Grok 聊天模型。请参阅 xAI 模型文档 了解可用的模型 ID。

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

概述

集成详情

模型功能

请参阅下表标题中的链接，获取有关如何使用特定功能的指南。

设置

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

凭证

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

如果您想获取模型调用的自动追踪，还可以设置您的 LangSmith API 密钥，方法如下：

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

安装

LangChain ChatXAI 集成位于 @langchain/xai package:

npm install @langchain/xai @langchain/core

yarn add @langchain/xai @langchain/core

pnpm add @langchain/xai @langchain/core

实例化

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

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 参考.