# @ant-design/x-sdk 中文文档

规范地址：https://npmcn.com/package/%40ant-design/x-sdk/

版本：2\.10\.0
npm 元数据更新时间：2026-10-29T09:07:58.599Z
中文译文更新时间：2026-11-06T06:02:44.679Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ant-design/x-sdk
原文对照：https://npmcn.com/package/%40ant-design/x-sdk/?lang=original
项目主页：https://x.ant.design/x-sdks/introduce
源码仓库：https://github.com/ant-design/x

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：3.3 MB，83 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=18\.0\.0，react-dom \>=18\.0\.0
- 首次发布：2025-08-05T07:59:04.795Z
- 最新版本发布：2026-10-29T09:07:58.410Z
- 近 30 天下载量：80550（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 27 个）

## 中文简介

@ant-design/x-sdk 的占位符

## 安装

```sh
npm install @ant-design/x-sdk
```

也可以使用：`pnpm add @ant-design/x-sdk`、`yarn add @ant-design/x-sdk`、`bun add @ant-design/x-sdk`

## README

![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*eco6RrQhxbMAAAAAAAAAAAAADgCCAQ/original)

# 蚂蚁设计 X SDK

有效管理大型模型数据流

[![CI status](https://github.com/ant-design/x/actions/workflows/main.yml/badge.svg)](https://github.com/ant-design/x/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/ant-design/x/graph/badge.svg?token=wrCCsyTmdi)](https://codecov.io/gh/ant-design/x) [![NPM version](https://img.shields.io/npm/v/@ant-design/x-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@ant-design/x-sdk)

[![NPM downloads](https://img.shields.io/npm/dm/@ant-design/x-sdk.svg?style=flat-square)](https://npmjs.org/package/@ant-design/x-sdk) [![](https://badgen.net/bundlephobia/minzip/@ant-design/x-sdk?style=flat-square)](https://bundlephobia.com/package/@ant-design/x-sdk) [![antd](https://img.shields.io/badge/-Ant%20Design-blue?labelColor=black&logo=antdesign&style=flat-square)](https://ant.design/) [![Follow zhihu](https://img.shields.io/badge/-Ant%20Design-white?logo=zhihu)](https://www.zhihu.com/column/c_1564262000561106944)

[更改日志](https://npmcn.com/package/%40ant-design/x-sdk/CHANGELOG.md) • 妇女 [报告错误](https://github.com/ant-design/x/issues/new?template=bug-report.yml) • 妇女 [请求特性](https://github.com/ant-design/x/issues/new?template=bug-feature-request.yml) · 英语 [页:1](https://npmcn.com/package/%40ant-design/x-sdk/README-zh_CN.md)

## 导言

`@ant-design/x-sdk` 提供一套工具API,旨在帮助开发者管理AI对话应用数据流出框.

## \* 安装

```bash
npm install @ant-design/x-sdk
```

```bash
yarn add @ant-design/x-sdk
```

```bash
pnpm add @ant-design/x-sdk
```

```bash
ut install @ant-design/x-sdk
```

### 浏览器导入

使用 `script` 财务报告和审定财务报表 `link` 在浏览器中直接导入文件的标签,并使用全局变量 `XSDK`。 。 。 .

我们提供 `x-sdk.js`, (中文(简体) ), `x-sdk.min.js`,以及 `x-sdk.min.js.map` 在 npm 软件包的 dist 目录中.

> **强烈建议不使用已建文件**,因为这样可以防止按需加载,并使得对基础依赖模块难以获得快速的bug修复.

> 说明: `x-sdk.js`, (中文(简体) ), `x-sdk.min.js`,以及 `x-sdk.min.js.map` 取决于 `react` 财务报告和审定财务报表 `react-dom`请确保提前导入这些文件.

## 示例

```tsx
import React from 'react';
import { XRequest } from '@ant-design/x-sdk';

export default () => {
  const [status, setStatus] = React.useState('');
  const [lines, setLines] = React.useState<Record<string, string>[]>([]);

  React.useEffect(() => {
    setStatus('pending');

    XRequest('https://api.example.com/chat', {
      params: {
        model: 'gpt-3.5-turbo',
        messages: [{ role: 'user', content: 'hello, who are u?' }],
        stream: true,
      },
      callbacks: {
        onSuccess: (messages) => {
          setStatus('success');
          console.log('onSuccess', messages);
        },
        onError: (error) => {
          setStatus('error');
          console.error('onError', error);
        },
        onUpdate: (msg) => {
          setLines((pre) => [...pre, msg]);
          console.log('onUpdate', msg);
        },
      },
    });
  }, []);

  return (
    <div>
      <div>Status: {status}</div>
      <div>Lines: {lines.length}</div>
    </div>
  );
};
```

## 企业级LLM组件 离开盒子

`@ant-design/x` 基于 RICH 交互范式,为不同的相互作用阶段提供一组丰富的原子组件,帮助您灵活地构建自己的AI应用. 详情见 [这里](https://npmcn.com/package/%40ant-design/x/README.md)。 。 。 .

## Markdown 渲染器

`@ant-design/x-markdown` 目的是提供流畅、可扩展和高性能的Markdown渲染器。 它支持流线渲染公式,代码突出,美人鱼等. 详情见 [这里](https://npmcn.com/package/%40ant-design/x-markdown/README.md)。 。 。 .

## 如何贡献

在以任何形式参加之前,请先阅读 [贡献者指南](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md)。如果你想作出贡献,请随意提交 [拉请求](https://github.com/ant-design/ant-design/pulls) 或者说 [报告错误](http://new-issue.ant.design/)。 。 。 .

> 我们强烈推荐阅读 [如何问问题 明智的方式](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way), (中文(简体) ), [开放源码社区如何提问](https://github.com/seajs/seajs/issues/545), (中文(简体) ), [如何有效报告臭虫](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs.html),以及 [如何向开源项目提交无法回答的问题](https://zhuanlan.zhihu.com/p/25795393)更好的问题更有可能得到帮助.

## 社区支助

如果在使用过程中遇到问题,您可通过下列渠道寻求帮助。 我们还鼓励有经验的用户通过这些渠道帮助新来者.

在询问关于GitHub讨论的问题时,建议使用 `Q&A` 标签.

1.  [GitHub 讨论](https://github.com/ant-design/x/discussions)
2.  [GitHub 问题](https://github.com/ant-design/x/issues)

[![Contribution Leaderboard](https://openomy.app/svg?repo=ant-design/x&chart=bubble&latestMonth=3)](https://openomy.app/github/ant-design/x)

## 常见问题

### @ant-design/x-sdk 是什么？

@ant-design/x-sdk 的占位符

### 如何安装 @ant-design/x-sdk？

在项目目录运行 npm install @ant-design/x-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18\.0\.0）、react-dom（\>=18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @ant-design/x-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @ant-design/x-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @ant-design/x-sdk 可以商用吗？

@ant-design/x-sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @ant-design/x-sdk 的下载量有多少？

根据 npm 官方下载统计，@ant-design/x-sdk 在 2026/10/06 – 2026/11/04 这 30 天内被下载 80,550 次，日均约 2,685 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @ant-design/x-sdk 还在维护吗？

最新版本 2\.10\.0 发布于 2026/10/29（7 天前）；至今共发布 41 个版本，其中过去 12 个月发布了 27 个；首次发布于 2025/08/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。