# @airweave/sdk 中文文档

规范地址：https://npmcn.com/package/%40airweave/sdk/

版本：0\.9\.62
npm 元数据更新时间：2026-04-07T17:49:05.991Z
中文译文更新时间：2026-11-05T22:49:43.670Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40airweave/sdk
原文对照：https://npmcn.com/package/%40airweave/sdk/?lang=original
项目主页：https://github.com/airweave-ai/typescript-sdk#readme
源码仓库：https://github.com/airweave-ai/typescript-sdk

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

- 包体积（解压后）：718 kB，607 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2025-02-02T17:56:44.208Z
- 最新版本发布：2026-04-07T17:49:05.840Z
- 近 30 天下载量：10781（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：302（近 12 个月 106 个）

## 中文简介

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fairweave-ai%2Ftypescript-sdk) \[npm屏蔽

## 安装

```sh
npm install @airweave/sdk
```

也可以使用：`pnpm add @airweave/sdk`、`yarn add @airweave/sdk`、`bun add @airweave/sdk`

## README

# 空织类型脚本库

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fairweave-ai%2Ftypescript-sdk) [![npm shield](https://img.shields.io/npm/v/@airweave/sdk)](https://www.npmjs.com/package/@airweave/sdk)

Airweave TypeScript库提供从TypeScript获取Airweave API的方便通道.

## 目录

-   [安装](https://npmcn.com/package/%40airweave/sdk/#readme-installation)
-   [参考文献](https://npmcn.com/package/%40airweave/sdk/#readme-reference)
-   [使用量](https://npmcn.com/package/%40airweave/sdk/#readme-usage)
-   [请求和答复类型](https://npmcn.com/package/%40airweave/sdk/#readme-request-and-response-types)
-   [例外处理](https://npmcn.com/package/%40airweave/sdk/#readme-exception-handling)
-   [高级](https://npmcn.com/package/%40airweave/sdk/#readme-advanced)
    -   [其他信头](https://npmcn.com/package/%40airweave/sdk/#readme-additional-headers)
    -   [其它查询字符串参数](https://npmcn.com/package/%40airweave/sdk/#readme-additional-query-string-parameters)
    -   [检索](https://npmcn.com/package/%40airweave/sdk/#readme-retries)
    -   [超时](https://npmcn.com/package/%40airweave/sdk/#readme-timeouts)
    -   [中止请求](https://npmcn.com/package/%40airweave/sdk/#readme-aborting-requests)
    -   [访问原始响应数据](https://npmcn.com/package/%40airweave/sdk/#readme-access-raw-response-data)
    -   [运行时间相容性](https://npmcn.com/package/%40airweave/sdk/#readme-runtime-compatibility)
-   [捐款](https://npmcn.com/package/%40airweave/sdk/#readme-contributing)

## 安装

```sh
npm i -s @airweave/sdk
```

## 参考文献

该图书馆的全部参考资料可供查阅 [这里](https://github.com/airweave-ai/typescript-sdk/blob/HEAD/reference.md)。 。 。 .

## 使用量

以下列方式证明和使用客户端:

```typescript
import { AirweaveSDKClient } from "@airweave/sdk";

const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" });
await client.collections.create({
    name: "Finance Data",
    readable_id: "finance-data-reports",
});
```

## 请求和答复类型

SDK导出所有请求和响应类型为TypeScript接口. 只需用 以下命名空间:

```typescript
import { AirweaveSDK } from "@airweave/sdk";

const request: AirweaveSDK.ListCollectionsGetRequest = {
    ...
};
```

## 例外处理

当 API 返回一个非成功状态代码( 4xx 或 5xx 响应) 时, 以下错误的子类 将会被扔出.

```typescript
import { AirweaveSDKError } from "@airweave/sdk";

try {
    await client.collections.create(...);
} catch (err) {
    if (err instanceof AirweaveSDKError) {
        console.log(err.statusCode);
        console.log(err.message);
        console.log(err.body);
        console.log(err.rawResponse);
    }
}
```

## 高级

### 其他信头

如果您希望作为请求的一部分发送额外的信头,请使用 `headers` 请求选项.

```typescript
const response = await client.collections.create(..., {
    headers: {
        'X-Custom-Header': 'custom value'
    }
});
```

### 其它查询字符串参数

如果您希望作为请求的一部分发送额外的查询字符串参数,请使用 `queryParams` 请求选项.

```typescript
const response = await client.collections.create(..., {
    queryParams: {
        'customQueryParamKey': 'custom query param value'
    }
});
```

### 检索

SDK是用有指数回放的自动回放装置. 申请要等会再审 由于请求被认为可以重试,且重试的次数没有超过所配置的 重试限制( 默认: 2) .

当返回以下任一 HTTP 状态代码时, 请求被视为可重试 :

-   [408 (简体中文)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (超时)
-   [429个](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (太多请求)
-   [第5XX条](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (内部服务器出错)

使用 `maxRetries` 请求选项来配置此行为.

```typescript
const response = await client.collections.create(..., {
    maxRetries: 0 // override maxRetries at the request level
});
```

### 超时

SDK默认为60第二次超时. 使用 `timeoutInSeconds` 选项来配置此行为.

```typescript
const response = await client.collections.create(..., {
    timeoutInSeconds: 30 // override timeout to 30s
});
```

### 中止请求

SDK允许用户在任何时刻通过一个中止信号来中止请求.

```typescript
const controller = new AbortController();
const response = await client.collections.create(..., {
    abortSignal: controller.signal
});
controller.abort(); // aborts the request
```

### 访问原始响应数据

SDK通过下列方式提供原始响应数据,包括信头: `.withRawResponse()` 方法. 这个 `.withRawResponse()` 方法返回给一个带有 `data` (单位:千美元) `rawResponse` 属性.

```typescript
const { data, rawResponse } = await client.collections.create(...).withRawResponse();

console.log(data);
console.log(rawResponse.headers['X-My-Header']);
```

### 运行时间相容性

SDK工作时间如下:

-   节点.js 18+
-   维塞尔
-   云花岗工人
-   德诺v1.25+
-   1.0+号舱
-   原生反应

### 自定义获取客户端

SDK为您提供了自定义 HTTP 客户端/ 获取功能的方法 。 如果你正在运行在一个 不支持的环境,这为您提供了一个打破玻璃并确保SDK工作的方法.

```typescript
import { AirweaveSDKClient } from "@airweave/sdk";

const client = new AirweaveSDKClient({
    ...
    fetcher: // provide your implementation here
});
```

## 捐款

虽然我们重视对SDK的开源贡献,但这个库是程序生成的. 直接给这个图书馆增加的代码 得转到我们一代人的代码上, 否则,它们将被覆盖 在下一次产生的释放。 随便打开公关吧 是一个概念的证明, 但知道我们将无法 合并它作为一个。 我们建议开放 先和我们讨论一个问题!

另一方面,对 " README " 的贡献总是非常受欢迎的!

## 常见问题

### @airweave/sdk 是什么？

\[npm屏蔽

### 如何安装 @airweave/sdk？

在项目目录运行 npm install @airweave/sdk，或使用 pnpm add / yarn add / bun add。

### @airweave/sdk 支持 TypeScript 吗？

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

### @airweave/sdk 支持 ESM 还是 CommonJS？

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

### @airweave/sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @airweave/sdk 可以商用吗？

@airweave/sdk 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @airweave/sdk 的下载量有多少？

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

### @airweave/sdk 还在维护吗？

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