@wandox/sdk
v0.1.65
Published
Wandox embeddable AI assistant and playbook execution SDK.
Readme
@wandox/sdk
Wandox 可嵌入式 AI 工作台 SDK。完整工作台通过 mountAssistant 挂载,当前最新版本为 V2;抽屉、剧本执行面板和业务组件 API 保持独立调用方式。
安装
npm install @wandox/sdk使用
import wandox from '@wandox/sdk'
import '@wandox/sdk/style.css'
const sdk = wandox.init({
token: 'YOUR_SSO_TOKEN',
domain: 'maiduo',
username: 'YOUR_USERNAME',
userId: 'YOUR_USER_ID',
})
sdk.mountAssistant('#app')mountAssistant 页面版本
version 用于选择完整工作台协议,缺省使用当前最新版本 2。现有调用无需增加参数即可进入 V2 工作台;需要使用 V1 Assistant 体验时显式传入 version: 1。
// 当前最新工作台,等同于 version: 2
sdk.mountAssistant('#app')
// 显式使用 V1 Assistant 工作台
sdk.mountAssistant('#app', {
version: 1,
})version 只影响 mountAssistant 的完整页面。openDrawer、openDrawerOnly、剧本执行面板、业务组件和其他 SDK 方法保持原有调用方式;智能体、剧本及参数仍使用 agentId / agent_id、playbookId / playbook_id、playbookParams / playbook_params。
Web 应用对应的版本入口是 /agent-workbench/v1 和 /agent-workbench/v2。/assistant 与 /console 已从 Web 应用路由移除。SDK 直接把工作台挂载到传入容器,不依赖 Web 路由;容器需要提供明确的宽度和高度,V2 初始化加载状态只覆盖该容器。
客服抽屉模式
通过 openDrawerOnly 打开业务抽屉,并设置 enable_customer_service: true。抽屉头部会显示“人工客服”按钮,用户点击后在新窗口打开客服系统;客服地址和 SSO token 跳转由 SDK 统一处理。
const sdk = wandox.init({
token: 'YOUR_SSO_TOKEN',
domain: 'maiduo',
companyCode: 'YOUR_COMPANY',
})
sdk.openDrawerOnly({
agent_id: 'maiduo_global',
enable_customer_service: true,
})打开抽屉时可以同时发送消息:
sdk.openDrawerOnly({
agent_id: 'maiduo_global',
message: '帮我分析一下当前店铺表现',
enable_customer_service: true,
})camelCase 参数同样受支持:agentId、enableCustomerService。客服入口按单次抽屉调用控制,完整页面和独立执行面板保持原有行为。
应用卸载时清理 SDK:
sdk.destroy()命名导入及类型导入:
import { wandox, type WandoxConfig } from '@wandox/sdk'