# @frigade/assistant 中文文档

规范地址：https://npmcn.com/package/%40frigade/assistant/

版本：1\.6\.0
npm 元数据更新时间：2026-11-12T20:08:58.477Z
中文译文更新时间：2026-11-15T14:17:10.558Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%40frigade/assistant
原文对照：https://npmcn.com/package/%40frigade/assistant/?lang=original

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

- 包体积（解压后）：319 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：16 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2026-09-28T19:25:02.166Z
- 最新版本发布：2026-11-12T20:08:58.186Z
- 近 30 天下载量：17977（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

Frigade Assistant - 一个利用软件学习软件的内出类拔萃助理

## 安装

```sh
npm install @frigade/assistant
```

也可以使用：`pnpm add @frigade/assistant`、`yarn add @frigade/assistant`、`bun add @frigade/assistant`

## README

# @frigade/ 协助员

Frigade Assistant:一个在网络应用中解答用户问题的出品助理.

## 安装

```bash
npm install @frigade/assistant
```

要求数 `react` 财务报告和审定财务报表 `react-dom` 18-19作为同龄人依赖关系.

## 使用量

```ts
import * as FrigadeAssistant from '@frigade/assistant';

FrigadeAssistant.init({
  apiKey: 'YOUR_FRIGADE_PUBLIC_API_KEY',
  apiUrl: 'https://api.frigade.ai',
  userId: 'user-123',
});
```

在浏览器里,在你的应用负载之后,给它打电话一次.

## 控件

```ts
FrigadeAssistant.show(); // open the assistant, ready for a question
FrigadeAssistant.hide(); // take it off the page; it keeps running
FrigadeAssistant.close(); // end the conversation, back to the collapsed button
FrigadeAssistant.ask({ question: 'What can you do?' });
FrigadeAssistant.getMode(); // 'pre-init', 'hidden', 'collapsed', 'input', ...
```

在助手挂起之前拨打的电话, 一旦挂起就排队运行 . `getMode()` 返回时 `'pre-init'` 直到那时.

## 活动

```ts
const unsubscribe = FrigadeAssistant.on('ask', ({ query }) => {
  console.log('User asked', query);
});

unsubscribe();
```

处理器可在 `init`。 。 。 . `off(event, handler)` 也删除处理器。 见 `EventType` 类型.

## 选项

| 选项 | 类型 | 说明 |
| --- | --- | --- |
| `apiKey` | `string` | **要求.** 你的Frigade公共API密钥. |
| `apiUrl` | `string` | **要求.** Frigade API URL (英语). |
| `userId` | `string` | 签名用户的ID. |
| `userProperties` | `Record<string, unknown>` | 用户的额外属性 . |
| `assistantId` | `string` | 范围要求具体助理. |
| `locale` | `string` | 强制UI语言(例如. `'es-MX'`。默认浏览器. |
| `defaultVisible` | `boolean` | 助理是否在负载中可见 。 默认为 `true`。 。 。 . |

见 `FrigadeAssistantConfig` 类型.

## 许可证

见 [自由主义](https://npmcn.com/package/%40frigade/assistant/LICENSE)。 。 。 .

## 常见问题

### @frigade/assistant 是什么？

Frigade Assistant - 一个利用软件学习软件的内出类拔萃助理

### 如何安装 @frigade/assistant？

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

### @frigade/assistant 支持 TypeScript 吗？

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

### @frigade/assistant 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @frigade/assistant 可以商用吗？

@frigade/assistant 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @frigade/assistant 的下载量有多少？

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

### @frigade/assistant 还在维护吗？

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