# @byteplus/amk-editor-assistant 中文文档

规范地址：https://npmcn.com/package/%40byteplus/amk-editor-assistant/

版本：1\.0\.6
npm 元数据更新时间：2026-11-06T08:45:36.408Z
中文译文更新时间：2026-11-08T21:59:07.944Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：56.7 MB，753 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.0\.0，react-dom ^18\.2\.0 \|\| ^19\.0\.0
- 首次发布：2026-09-29T15:25:35.265Z
- 最新版本发布：2026-11-06T08:45:36.214Z
- 近 30 天下载量：3532（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：32（近 12 个月 32 个）

## 中文简介

@byteplus/amk-editor的助理集成SDK.

## 安装

```sh
npm install @byteplus/amk-editor-assistant
```

也可以使用：`pnpm add @byteplus/amk-editor-assistant`、`yarn add @byteplus/amk-editor-assistant`、`bun add @byteplus/amk-editor-assistant`

## README

# @byteplus/amk编辑助理

BytePlus AI MediaKit Web Vibe 编辑 SDK将对话代理机与多轨编辑机合并,用于AI辅助和人工视频编辑.

## 文档

见 [整合 Web Vibe 编辑 SDK](https://docs.byteplus.com/en/docs/byteplus-vod/integrating-the-web-vibe-editing-sdk) 用于设置、模型配置、后端代理集成和认证.

## 安装

```bash
npm install @byteplus/amk-editor-assistant react react-dom
```

## 快开始

```ts
import { createAmkEditorAssistant } from '@byteplus/amk-editor-assistant';
import '@byteplus/amk-editor-assistant/styles.css';

const sdk = createAmkEditorAssistant({
  container: document.getElementById('editor')!,
  projectId: 'your-project-id',
  endpoint: '/api/amk-proxy',
  i18n: { locale: 'en-US' },
  assistant: {
    model: 'your-inference-model-id',
    preferMultiModalModels: ['your-audio-model-id', 'your-visual-model-id'],
  },
});

await sdk.whenReady();

// Call sdk.destroy() when the page or component unmounts.
```

在浏览器中以明确大小的容器初始化并替换项目和型号ID. 遵循集成指南启用服务,配置授权,并执行后端代理. 在服务器上保留 API 密钥和永久证书 .

参考布局、主题、媒体整合和定制的整合指南.

## 常见问题

### @byteplus/amk-editor-assistant 是什么？

@byteplus/amk-editor的助理集成SDK\.

### 如何安装 @byteplus/amk-editor-assistant？

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

### @byteplus/amk-editor-assistant 支持 TypeScript 吗？

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

### @byteplus/amk-editor-assistant 支持 ESM 还是 CommonJS？

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

### @byteplus/amk-editor-assistant 需要什么版本的 Node\.js？

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

### @byteplus/amk-editor-assistant 可以商用吗？

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

### @byteplus/amk-editor-assistant 的下载量有多少？

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

### @byteplus/amk-editor-assistant 还在维护吗？

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