# @guava-ai/guava-sdk 中文文档

规范地址：https://npmcn.com/package/%40guava-ai/guava-sdk/

版本：0\.44\.0
npm 元数据更新时间：2026-11-11T01:13:21.721Z
中文译文更新时间：2026-11-17T07:24:31.508Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：1 MB，192 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：3 个
- peer 依赖：openai ^6\.16\.0
- 首次发布：2026-01-18T08:31:45.130Z
- 最新版本发布：2026-11-11T01:13:21.292Z
- 近 30 天下载量：5206（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：48（近 12 个月 48 个）

## 中文简介

官方TypeScript SDK为建设瓜瓦语音代理.

## 安装

```sh
npm install @guava-ai/guava-sdk
```

也可以使用：`pnpm add @guava-ai/guava-sdk`、`yarn add @guava-ai/guava-sdk`、`bun add @guava-ai/guava-sdk`

## README

# 瓜娃打字机 SDK

[![NPM Version](https://img.shields.io/npm/v/%40guava-ai%2Fguava-sdk)](https://www.npmjs.com/package/@guava-ai/guava-sdk)

这个库允许您使用 TypeScript 或 Javascript 构建 Guava 语音代理 。 目前只有NodeJS作为主SDK的运行时间被官方支持. SDK的WebRTC部分可以从浏览器中被使用.

## 文档

TypeScript SDK 的全部文档可见于 [https://goguava.ai/docs/ (中文(简体) )](https://goguava.ai/docs/)。 SDK 实例可见于 [./举例说明/](https://github.com/goguava-ai/typescript-sdk/tree/main/examples)。 。 。 .

## 认证

登录使用 [瓜娃 CLI](https://goguava.ai/docs/quickstart)数字 :

```shell
guava login
```

或者,通过环境变量提供 API 键.

```shell
$ export GUAVA_API_KEY="..." # Your API key for authentication.
$ export GUAVA_AGENT_NUMBER="..." # A phone number for your agent to use.
```

## 尝试示例

使用 `npx`。用自己的号码替换电话号码,你的经纪人会给你打电话.

```bash
$ npx @guava-ai/guava-sdk@latest scheduling-outbound phone +15556667777 # Your agent will call this number.
```

## 安装

使用您的首选软件包管理器安装 SDK .

```bash
$ npm install @guava-ai/guava-sdk
$ yarn add @guava-ai/guava-sdk
$ pnpm add @guava-ai/guava-sdk
```

SDK可以使用Javascript,但TypeScript被高度推荐.

## 使用浏览器中的 WebRTC

使用捆绑器从浏览器调用您的代理, 将 SDK 安装为上方并导入自 `@guava-ai/guava-sdk/webrtc`。 。 。 .

```typescript
import * as Guava from "@guava-ai/guava-sdk/webrtc";

const call = new Guava.Call({ webrtcCode: "..." });
await call.start();
```

也可以从CDN上装入预装的捆绑.

```html
<script
  src="https://cdn.jsdelivr.net/npm/@guava-ai/guava-sdk@0.44.0/dist/guava-webrtc.min.js"
  integrity="sha384-CqOmyWgWQBezum+sb7uPDUvYIN4/0eKmWbgs/LEjsn+KmW8PoP9zwB1FVQR7v3c3"
  crossorigin="anonymous"
></script>
<script>
  const call = new Guava.Call({ webrtcCode: "..." });
  call.start();
</script>
```

或作为ES模块:

```html
<script type="importmap">
  {
    "integrity": {
      "https://cdn.jsdelivr.net/npm/@guava-ai/guava-sdk@0.44.0/dist/guava-webrtc.esm.min.js": "sha384-Lf/SBkHjXX4aPSR9S2XcqQXaI21CnugMUu7ROfHLJGnvtPMS0lFNuYTnUal6eAZ8"
    }
  }
</script>
<script type="module">
  import * as Guava from "https://cdn.jsdelivr.net/npm/@guava-ai/guava-sdk@0.44.0/dist/guava-webrtc.esm.min.js";
  const call = new Guava.Call({ webrtcCode: "..." });
  await call.start();
</script>
```

见 [WebRTC 呼叫指南](https://docs.goguava.ai/guides/webrtc-calls) 关于如何与瓜娃一起创建WebRTC代理的更多细节.

## 常见问题

### @guava-ai/guava-sdk 是什么？

官方TypeScript SDK为建设瓜瓦语音代理\.

### 如何安装 @guava-ai/guava-sdk？

在项目目录运行 npm install @guava-ai/guava-sdk，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 guava-example，可以用 npx guava-example 直接运行。

### @guava-ai/guava-sdk 支持 TypeScript 吗？

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

### @guava-ai/guava-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

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

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

### @guava-ai/guava-sdk 可以商用吗？

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

### @guava-ai/guava-sdk 的下载量有多少？

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

### @guava-ai/guava-sdk 还在维护吗？

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

