@ahxlo/lite-ai-websdk

Ahxlo 智能体 Web 嵌入聊天 SDK。支持 npm（ESM） 与 CDN（IIFE） 接入。

要求

| 项 | 说明 | | --- | --- | | 开放 API | 已部署 Ahxlo 开放接口，基路径形如 https://your-api.example.com/indexApi；应用已开启嵌入 | | npm 宿主 | vue@^3.5（peerDependency，ESM 接入时由宿主提供） | | 浏览器 | ES2020+、SSE |

安装

npm

npm install @ahxlo/lite-ai-websdk

CDN

从 npm 发布产物加载（推荐固定版本号）：

| 源 | 地址 | | --- | --- | | jsDelivr | https://cdn.jsdelivr.net/npm/@ahxlo/lite-ai-websdk@1/dist/aigc-widget.js | | unpkg | https://unpkg.com/@ahxlo/lite-ai-websdk@1/dist/aigc-widget.js |

• 使用 @1：始终解析为最新 1.x（如 1.0.2），一般无需每次 patch 改 URL。
• 使用 @1.0.2：锁定该版本，升级 SDK 时需手动改地址。
• 亦可自托管 dist/aigc-widget.js。

快速接入

CDN（IIFE）

<script src="https://cdn.jsdelivr.net/npm/@ahxlo/lite-ai-websdk@1/dist/aigc-widget.js"></script>
<script>
  window.AigcEmbed.init({
    appId: 'YOUR_APP_ID',
    apiBase: 'https://your-api.example.com/indexApi',
    user: { id: 'user-1', name: '访客' }
  });
</script>

• 加载完成后调用 window.AigcEmbed.init，必须传入 appId、apiBase。
• 样式已内联，无需额外 CSS。
• 脚本使用 async / defer 时，在 onload 或 DOMContentLoaded 后再调用 init。

npm（ESM）

import { createAigcEmbed } from '@ahxlo/lite-ai-websdk';

const embed = createAigcEmbed({
  appId: 'YOUR_APP_ID',
  apiBase: 'https://your-api.example.com/indexApi'
});

embed.init({ user: { id: 'user-1', name: '访客' } });
embed.open();
embed.close();
embed.destroy();

• 不挂载 window.AigcEmbed。
• 同一 appId 多次调用 createAigcEmbed 返回同一实例。

API

window.AigcEmbed（CDN）

| 方法 | 签名 | 说明 | | --- | --- | --- | | init | (options: EmbedInitOptions) => void | 挂载；appId、apiBase 必填 | | open | (appId?: string \| number) => void | 打开面板 | | close | (appId?: string \| number) => void | 关闭面板 | | destroy | (appId?: string \| number) => void | 销毁实例 |

createAigcEmbed（npm）

function createAigcEmbed(options: {
  appId: string | number;
  apiBase: string;
  cssUrl?: string;
  webSdkConfig?: EmbedWebSdkConfigInput;
}): AigcEmbedInstance;

| 成员 | 签名 | 说明 | | --- | --- | --- | | init | (options?: EmbedInitOptions) => void | 挂载 | | open | () => void | 打开面板 | | close | () => void | 关闭面板 | | destroy | () => void | 销毁实例 |

EmbedInitOptions

| 字段 | 类型 | 说明 | | --- | --- | --- | | appId | string \| number | 应用 ID | | apiBase | string | 开放 API 根路径（含 /indexApi） | | cssUrl | string | 外链样式表（可选） | | user | EmbedUserInfo | 访客身份 | | user.id | string | 业务用户 ID | | user.name | string | 展示名称 | | position | 'right-bottom' \| 'left-bottom' | FAB 位置，默认 right-bottom | | zIndex | number | 层级，默认 2147483000 | | webSdkConfig | EmbedWebSdkConfigInput | 窗体 / FAB 外观覆盖 |

类型见 dist/index.d.ts、dist/types.d.ts。

包内容

| 路径 | 说明 | | --- | --- | | dist/index.esm.js | ESM | | dist/aigc-widget.js | IIFE（CDN） | | dist/index.d.ts | 入口类型 | | dist/types.d.ts | 选项类型 |

许可证

Apache License 2.0