ChatXAI

本页面将帮助您开始使用 xAI 聊天模型。有关 `ChatXAI` 所有功能和配置的详细文档，请查阅API 参考。

xAI 提供了用于与 Grok 模型交互的 API。

概述

集成详情

类别	包	本地	可序列化	JS 支持	包下载量	最新包版本
ChatXAI	langchain-xai	❌	测试版	✅

模型特性

工具调用	结构化输出	JSON 模式	图片输入	音频输入	视频输入	逐令牌流式传输	原生异步	令牌使用量	对数概率
✅	✅	❌	❌	❌	❌	✅	❌	✅	✅

设置

要访问 xAI 模型，您需要创建一个 xAI 账户，获取一个 API 密钥，并安装 `langchain-xai` 集成包。

凭证

前往此页面注册 xAI 并生成 API 密钥。完成此操作后，请设置 `XAI_API_KEY` 环境变量。

import getpass
import os

if "XAI_API_KEY" not in os.environ:
    os.environ["XAI_API_KEY"] = getpass.getpass("Enter your xAI API key: ")

要启用模型调用的自动跟踪，请设置您的 LangSmith API 密钥

# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
# os.environ["LANGSMITH_TRACING"] = "true"

安装

LangChain xAI 集成位于 `langchain-xai` 包中。

%pip install -qU langchain-xai

实例化

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

from langchain_xai import ChatXAI

llm = ChatXAI(
    model="grok-beta",
    temperature=0,
    max_tokens=None,
    timeout=None,
    max_retries=2,
    # other params...
)

API 参考：ChatXAI

调用

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

AIMessage(content="J'adore programmer.", additional_kwargs={'refusal': None}, response_metadata={'token_usage': {'completion_tokens': 6, 'prompt_tokens': 30, 'total_tokens': 36, 'completion_tokens_details': None, 'prompt_tokens_details': None}, 'model_name': 'grok-beta', 'system_fingerprint': 'fp_14b89b2dfc', 'finish_reason': 'stop', 'logprobs': None}, id='run-adffb7a3-e48a-4f52-b694-340d85abe5c3-0', usage_metadata={'input_tokens': 30, 'output_tokens': 6, 'total_tokens': 36, 'input_token_details': {}, 'output_token_details': {}})

print(ai_msg.content)

J'adore programmer.

链式调用

我们可以像这样将模型与提示模板链式连接起来

from langchain_core.prompts import ChatPromptTemplate

prompt = ChatPromptTemplate.from_messages(
    [
        (
            "system",
            "You are a helpful assistant that translates {input_language} to {output_language}.",
        ),
        ("human", "{input}"),
    ]
)

chain = prompt | llm
chain.invoke(
    {
        "input_language": "English",
        "output_language": "German",
        "input": "I love programming.",
    }
)

API 参考：ChatPromptTemplate

AIMessage(content='Ich liebe das Programmieren.', additional_kwargs={'refusal': None}, response_metadata={'token_usage': {'completion_tokens': 7, 'prompt_tokens': 25, 'total_tokens': 32, 'completion_tokens_details': None, 'prompt_tokens_details': None}, 'model_name': 'grok-beta', 'system_fingerprint': 'fp_14b89b2dfc', 'finish_reason': 'stop', 'logprobs': None}, id='run-569fc8dc-101b-4e6d-864e-d4fa80df2b63-0', usage_metadata={'input_tokens': 25, 'output_tokens': 7, 'total_tokens': 32, 'input_token_details': {}, 'output_token_details': {}})

工具调用

ChatXAI 具有工具调用（我们在此处互换使用“工具调用”和“函数调用”）API，它允许您描述工具及其参数，并让模型返回一个 JSON 对象，其中包含要调用的工具及其输入。工具调用对于构建使用工具的链和代理，以及更普遍地从模型获取结构化输出非常有用。

ChatXAI.bind_tools()

通过 `ChatXAI.bind_tools`，我们可以轻松地将 Pydantic 类、字典模式、LangChain 工具，甚至函数作为工具传递给模型。在底层，这些会转换为一个 OpenAI 工具模式，其形式如下：

{
    "name": "...",
    "description": "...",
    "parameters": {...}  # JSONSchema
}

并传递给每次模型调用。

from pydantic import BaseModel, Field


class GetWeather(BaseModel):
    """Get the current weather in a given location"""

    location: str = Field(..., description="The city and state, e.g. San Francisco, CA")


llm_with_tools = llm.bind_tools([GetWeather])

ai_msg = llm_with_tools.invoke(
    "what is the weather like in San Francisco",
)
ai_msg

AIMessage(content='I am retrieving the current weather for San Francisco.', additional_kwargs={'tool_calls': [{'id': '0', 'function': {'arguments': '{"location":"San Francisco, CA"}', 'name': 'GetWeather'}, 'type': 'function'}], 'refusal': None}, response_metadata={'token_usage': {'completion_tokens': 11, 'prompt_tokens': 151, 'total_tokens': 162, 'completion_tokens_details': None, 'prompt_tokens_details': None}, 'model_name': 'grok-beta', 'system_fingerprint': 'fp_14b89b2dfc', 'finish_reason': 'tool_calls', 'logprobs': None}, id='run-73707da7-afec-4a52-bee1-a176b0ab8585-0', tool_calls=[{'name': 'GetWeather', 'args': {'location': 'San Francisco, CA'}, 'id': '0', 'type': 'tool_call'}], usage_metadata={'input_tokens': 151, 'output_tokens': 11, 'total_tokens': 162, 'input_token_details': {}, 'output_token_details': {}})

实时搜索

xAI 支持实时搜索功能，使 Grok 能够利用网页搜索结果来验证其答案。

from langchain_xai import ChatXAI

llm = ChatXAI(
    model="grok-3-latest",
    search_parameters={
        "mode": "auto",
        # Example optional parameters below:
        "max_search_results": 3,
        "from_date": "2025-05-26",
        "to_date": "2025-05-27",
    },
)

llm.invoke("Provide me a digest of world news in the last 24 hours.")

API 参考：ChatXAI

请参阅xAI 文档以获取完整的网页搜索选项。

API 参考

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

相关

• 聊天模型概念指南
• 聊天模型操作指南