# @gladiaio/sdk 中文文档

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

版本：2\.2\.1
npm 元数据更新时间：2026-11-13T14:48:43.204Z
中文译文更新时间：2026-11-16T15:24:22.478Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：890 kB，145 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- peer 依赖：ws 5\.2\.4 \|\| 6\.2\.3 \|\| 7\.5\.10 \|\| \>=8\.8，undici \>=5，eventemitter3 \>=5
- 首次发布：2025-09-09T15:01:20.684Z
- 最新版本发布：2026-10-23T14:43:10.054Z
- 近 30 天下载量：33868（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：110（近 12 个月 11 个）

## 中文简介

Gladia Java 脚本/ Type 脚本 SDK

## 安装

```sh
npm install @gladiaio/sdk
```

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

## README

# 格拉地亚 Java 脚本 SDK

类型脚本/ JavaScript SDK [格拉迪亚](https://www.gladia.io/) API (英语).

## 所需资源

对于非浏览器环境,你都需要 **节点.js 20+** 或者说 **阿宝** 。 。 。 .

## 安装

```bash
npm install @gladiaio/sdk
```

如果您使用Node.js < 22, 您也需要安装 `ws` 软件包 :

```bash
npm install ws
```

## 使用量

导入 **`GladiaClient`** 并创造实例.

提供 API 密钥 **`apiKey`** 或 **`GLADIA_API_KEY`** 环境变量. [把你的API 密钥拿来](https://docs.gladia.io/chapters/introduction/getting-started) 一分钟内.

您也可以设置 **`GLADIA_API_URL`**对于现场会议, **`GLADIA_REGION`** (单位:千美元)`eu-west` 编号 : `us-west`)仅通过会话创建(`POST /v2/live`) (中文(简体) ).

### 节点.js/浏览器(ESM)

```typescript
import { GladiaClient } from '@gladiaio/sdk'

const gladiaClient = new GladiaClient({
  apiKey: 'your-api-key',
})
```

### 节点.js(共同JS)

```javascript
const { GladiaClient } = require('@gladiaio/sdk')

const gladiaClient = new GladiaClient({
  apiKey: 'your-api-key',
})
```

### 浏览器( 标记)

```html
<script src="https://unpkg.com/@gladiaio/sdk"></script>

<script>
  const gladiaClient = new Gladia.GladiaClient({
    apiKey: 'your-api-key',
  })
</script>
```

## 预先记录的抄录

**`transcribe()`** 接受文件路径(节点), **`http(s)` 網址**, (中文(简体) ), **`File`**,或 **`Blob`**。它在需要时上传,然后是民意调查,直到工作完成.

```typescript
import { GladiaClient } from '@gladiaio/sdk'
import 'dotenv/config'

const gladiaClient = new GladiaClient()
const audioPath = '../data/online-meeting-example.mp4'

const result = await gladiaClient.preRecorded().transcribe(audioPath, {
  language_config: { languages: ['en'] },
})

console.log(result.result?.transcription?.full_transcript ?? '')
```

见所有 [这里支持的语言](https://docs.gladia.io/chapters/language/supported-languages) 来啊!

通过 **选项** 参数以启用从 **[音频智能](https://docs.gladia.io/chapters/pre-recorded-stt/audio-intelligence)** 例如分化、翻译、PII编辑等.

### Async 预录

如果你的运行时间没有顶级 `await`,将电话打入 **`async`** 函数 :

```typescript
async function main() {
  const gladiaClient = new GladiaClient()
  const result = await gladiaClient.preRecorded().transcribe('./audio.mp3')
  console.log(result.result?.transcription?.full_transcript ?? '')
}

main().catch(console.error)
```

## 现场录音

```javascript
const liveSession = gladiaClient.liveV2().startSession({
  model: 'solaria-1',
  encoding: 'wav/pcm',
  sample_rate: 16000,
  bit_depth: 16,
  channels: 1,
  language_config: {
    languages: ['en'],
  },
  messages_config: {
    receive_partial_transcripts: true,
  },
})

liveSession.on('message', (message) => {
  if (message.type === 'transcript') {
    console.log(`${message.data.is_final ? 'F' : 'P'} | ${message.data.utterance.text.trim()}`)
  }
})

liveSession.once('started', () => {
  console.log(`Session ${liveSession.sessionId} started`)
})

liveSession.on('error', (err) => {
  console.error('An error occurred during live session:', err)
})

liveSession.once('ended', () => {
  console.log(`Session ${liveSession.sessionId} ended`)
})

liveSession.sendAudio(/* <audio_chunk> */)
liveSession.stopRecording()
```

见所有 [这里支持的语言](https://docs.gladia.io/chapters/language/supported-languages) 来啊!

通过 **选项** 参数以启用从 **[音频智能](https://docs.gladia.io/chapters/live-stt/audio-intelligence)** 例如分化、翻译、PII编辑等.

### 等待会话结束

改为: **`await`** 关闭后 **`stopRecording()`**,请等待 **`ended`** 事件:

```typescript
import { GladiaClient } from '@gladiaio/sdk'

async function runLive() {
  const gladiaClient = new GladiaClient({ apiKey: 'your-api-key' })
  const liveSession = gladiaClient.liveV2().startSession({
    language_config: { languages: ['en'] },
  })

  const ended = new Promise<void>((resolve) => {
    liveSession.once('ended', () => resolve())
  })

  liveSession.stopRecording()
  await ended
}

runLive().catch(console.error)
```

当您需要会话编号时, 当后端创建会话时 :

```typescript
const sessionId = await liveSession.getSessionId()
```

## 文档

-   [预录快速启动](https://docs.gladia.io/chapters/pre-recorded-stt/quickstart)
-   [快速启动](https://docs.gladia.io/chapters/live-stt/quickstart)

## 许可证

麻省理工学院

## 常见问题

### @gladiaio/sdk 是什么？

Gladia Java 脚本/ Type 脚本 SDK

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

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

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

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

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

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

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

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

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

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

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

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

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

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

