类class
agentscope.modelXAIChatModel
class XAIChatModel(ChatModelBase)源码Source
agentscope/model/_xai/_model.py:30–454xAI 聊天模型使用官方xai_sdkgRPC 客户端。位于 agentscope.model 包，继承自 ChatModelBase。
This model provides native access to xAI-specific features such as server-side agentic tools (web search, X search, code execution) and reasoning effort control, which are not available through the OpenAI-compatible REST endpoint.
嵌套类摘要Nested Class Summary
| 类Class | 类型Kind | 说明Description |
|---|---|---|
Parameters | 类class | 参数用于 xAI 聊天模型。 The parameters for the xAI chat model. |
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
def __init__(credential: XAICredential, model: str, parameters: 'XAIChatModel.Parameters | None' = None, stream: bool =… | 初始化 `XAIChatModel` 实例。 Initialize the xAI chat model. |
属性摘要Attribute Summary
| 属性Attribute | 类型Type | 说明Description | 值Value |
|---|---|---|---|
type | Literal['xai_chat'] | 类型字段。 | 'xai_chat' |
构造器详情Constructor Detail
XAIChatModel
def __init__(credential: XAICredential, model: str, parameters: 'XAIChatModel.Parameters | None' = None, stream: bool = True, max_retries: int = 3, retry_delay: float = 1.0, context_size: int = 131072, formatter: XAIChatFormatter | None = None, client_kwargs: dict[str, Any] | None = None) -> None初始化 XAIChatModel 实例。
Initialize the xAI chat model.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
credential | XAICredential | 凭证对象（类型 `XAICredential`）。The xAI credential used to authenticate API calls. |
model | str | 模型实例（类型 `str`）。The xAI model name, e.g. `grok-3` or `grok-3-mini`. |
parameters默认default None | 'XAIChatModel.Parameters | None' | 参数（类型 `'XAIChatModel.Parameters | None'`）。The xAI API parameters. When `None`, the default parameters will be used. |
stream默认default True | bool | 判断是否到启用流式输出。Whether to enable streaming output. |
max_retries默认default 3 | int | 最大重试次数（类型 `int`）。The maximum number of retries for the xAI API. |
retry_delay默认default 1.0 | float | 重试延迟（类型 `float`）。Seconds to sleep between retry attempts. |
context_size默认default 131072 | int | 上下文大小（类型 `int`）。The model context size used for context compression. |
formatter默认default None | XAIChatFormatter | None | 格式化器（类型 `XAIChatFormatter | None`）。The formatter that converts `Msg` objects to xai_sdk proto messages. When `None`, an `XAIChatFormatter` instance will be used. |
client_kwargs默认default None | dict[str, Any] | None | 客户端关键字参数（类型 `dict[str, Any] | None`）。Extra keyword arguments forwarded to `xai_sdk.AsyncClient` (e.g. `timeout`, `metadata`, `channel_options`). Keys that overlap with credential-derived arguments (such as `api_key` or `api_host`) take precedence over the credential values. |
源码Source
agentscope/model/_xai/_model.py:93–145属性详情Attribute Detail
type
Literal['xai_chat'] = 'xai_chat'类型字段。声明为 Literal['xai_chat']。
The type field.
源码Source
agentscope/model/_xai/_model.py:90嵌套类详情Nested Class Detail
Parameters
class Parameters参数用于 xAI 聊天模型。位于 agentscope.model 包。
The parameters for the xAI chat model. Declared in agentscope.model.