@byteplus/amk-editor-assistant

中文文档
1.0.6发布于 2026/11/06MITTypeScriptES Module近 30 天下载 3532

Assistant integration SDK for @byteplus/amk-editor.

原始使用文档
文档目录3 节
  1. Documentation
  2. Installation
  3. Quick start

@byteplus/amk-editor-assistant

The BytePlus AI MediaKit Web Vibe Editing SDK combines a conversational agent with a multitrack editor for AI-assisted and manual video editing.

Documentation

See Integrating the Web Vibe Editing SDK for setup, model configuration, backend proxy integration, and authentication.

Installation

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

Quick start

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.

Initialize in the browser with an explicitly sized container and replace the project and model IDs. Follow the integration guide to enable services, configure authorization, and implement your backend proxy. Keep API keys and permanent credentials on the server.

Refer to the integration guide for layout, themes, media integration, and customization.

版本与发布记录

@byteplus/amk-editor-assistant 共发布 32 个版本,首次发布于 2026/09/29;过去 12 个月发布了 32 个版本。

版本发布日期距今
1.0.6latest2026/11/062 天前
1.0.52026/11/035 天前
1.0.5-beta.3beta2026/11/035 天前
1.0.5-beta.22026/11/026 天前
1.0.5-beta.12026/10/2910 天前
1.0.42026/10/2613 天前

关于 @byteplus/amk-editor-assistant 的常见问题

@byteplus/amk-editor-assistant 是什么?

Assistant integration SDK for @byteplus/amk-editor.

如何安装 @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 和提交记录判断。