# @frigade/assist-api 中文文档

规范地址：https://npmcn.com/package/%40frigade/assist-api/

版本：1\.4\.0
npm 元数据更新时间：2026-11-03T22:37:21.839Z
中文译文更新时间：2026-11-15T14:21:00.005Z
软件包许可：SEE LICENSE IN LICENSE

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

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

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

- 包体积（解压后）：202 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:24:31.297Z
- 最新版本发布：2026-11-02T21:32:30.695Z
- 近 30 天下载量：2901（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

Frigade Assistance API - 向您的代理添加产品答案和现场指导

## 安装

```sh
npm install @frigade/assist-api
```

也可以使用：`pnpm add @frigade/assist-api`、`yarn add @frigade/assist-api`、`bun add @frigade/assist-api`

## README

# @frigade/ assist- api

Frigade Assistance API:向自己的AI代理添加产品答案并进行现场直播,页面上的指导.

## 安装

```bash
npm install @frigade/assist-api
```

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

## 使用量

```ts
import * as FrigadeAssistAPI from '@frigade/assist-api';

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

在浏览器里,在你的应用负载之后,给它打电话一次。 然后从你的代理人那里发射一个向导:

```ts
const result = await FrigadeAssistAPI.query({
  intent: 'Invite a teammate',
});
```

或者通过一个 Vercel AI SDK 工具直通(返回) `null` 如果工具电话不是Frigade的:

```ts
const result = await FrigadeAssistAPI.handleToolCall(toolCall);
```

`result.status` 这是其中之一 `started`, (中文(简体) ), `answer`, (中文(简体) ), `needs_clarification`, (中文(简体) ), `cancelled`, (中文(简体) ), `unavailable`,或 `error`. 此前发出的呼吁 `init` 页:1 `unavailable` 有理无据 `not-initialized`; 打电话时 `init` 仍在装入等待.

解除运行指南 :

```ts
FrigadeAssistAPI.close();
```

A 类 `query()` 还在飞行中 `cancelled`,如同用户关闭向导卡时那样。 在此之前 `init`,或者没有向导运行, `close()` 什么也没做.

## 活动

```ts
const unsubscribe = FrigadeAssistAPI.on('complete', () => {
  console.log('Guide completed');
});

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'`。默认浏览器. |

见 `FrigadeAssistAPIConfig` 类型.

## 许可证

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

## 常见问题

### @frigade/assist-api 是什么？

Frigade Assistance API - 向您的代理添加产品答案和现场指导

### 如何安装 @frigade/assist-api？

在项目目录运行 npm install @frigade/assist-api，或使用 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/assist-api 支持 TypeScript 吗？

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

### @frigade/assist-api 支持 ESM 还是 CommonJS？

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

### @frigade/assist-api 可以商用吗？

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

### @frigade/assist-api 的下载量有多少？

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

### @frigade/assist-api 还在维护吗？

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