@quec-wx-mp/api-ai 0.1.4

package/dist/modules/panel.d.ts

@@ -0,0 +1,445 @@
+/**
+ * @module AI 面板
+ */
+/**
+ * AI面板-查询ws的连接配置(火山版)
+ */
+export declare function findWsConnectConfig(options: {
+    /** TODO clientType */
+    clientType: any;
+    /** 设备 DK */
+    deviceKey: string;
+    /** 产品 PK */
+    productKey: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-续约topic(火山版)
+ */
+export declare function renewTopic(options: {
+    /** Topic */
+    topic: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-获取设备的聊天记录(火山版)
+ */
+export declare function findDevice(options: any, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * AI面板-设置设备的音色与角色
+ */
+export declare function editDeviceRoleVoice(options: {
+    /** TODO 确认接口入参明细 */
+    arr: any;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * AI面板-获取设备的当前角色与音色
+ */
+export declare function findDeviceRoleVoiceRel(options: {
+    /** 设备 DK */
+    deviceKey: string;
+    /** 产品 PK */
+    productKey: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * AI面板-查询声音页
+ */
+export declare function findPage(options: {
+    /** 角色ID */
+    roleId: number;
+    /** 声音类型：device-设备 manager-管理员 */
+    voiceType: 'device' | 'manager';
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 页码 */
+    pageNum: number;
+    /** 页大小 */
+    pageSize: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-智能体参数设置
+ */
+export declare function agentParamConfig(options: {
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /**
+     * configParams
+     * type wakeWord-唤醒词，chatModeSt-聊天模式
+     * data 数据，数组的话，以逗号隔开
+     */
+    configParams: Array<{
+        type: 'wakeWord' | 'chatModeSt';
+        data: string;
+    }>;
+    /** 页码 */
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-coze聊天记录
+ */
+export declare function cozeFindDevice(options: {
+    /** 角色ID */
+    roleId: number;
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 刷新：0，加载：1 默认0 */
+    status: number;
+    /** status=0:指定为返回结果中的 lastId，status=1:指定为返回结果中的 firstId */
+    afterId: number;
+    /** 每页条数 */
+    limit: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-获取可选角色页
+ */
+export declare function roleFindPage(options: {
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 页码 */
+    pageNum: number;
+    /** 页大小 */
+    pageSize: number;
+    /** 角色类型 */
+    roleType: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-智能体角色管理-新增角色
+ */
+export declare function roleAdd(options: {
+    /** 设备PK */
+    productKey: string;
+    /** 产品DK */
+    deviceKey: string;
+    /** 角色名称 */
+    roleName: string;
+    /** 角色提示文本 */
+    prompt?: string;
+    /** 角色描述 */
+    roleDesc?: string;
+    /** 角色图片地址 */
+    rolePicUrl?: string;
+    /** 角色声音Id */
+    voiceId?: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-智能体角色管理-编辑角色
+ */
+export declare function roleEdit(options: {
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 角色名称 */
+    roleName: string;
+    /** 角色ID */
+    roleId: number;
+    /** 角色提示文本 */
+    prompt?: string;
+    /** 角色描述 */
+    roleDesc?: string;
+    /** 角色图片地址 */
+    rolePicUrl?: string;
+    /** 角色声音Id */
+    voiceId?: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-智能体角色管理-角色详情
+ */
+export declare function roleDetail(options: {
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 角色ID */
+    roleId: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-智能体角色管理-角色删除
+ */
+export declare function roleDelete(options: {
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 角色ID */
+    roleId: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * AI面板-删除设备的聊天记录
+ * @since 2025-06-04
+ */
+export declare function deleteHistory(options: {
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 角色ID */
+    roleId: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-查询总结
+ */
+export declare function getSummary(options: {
+    /** 设备PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 时间 格式: YYYYMMDD */
+    day: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-查询产品是否开启音色复刻状态
+ */
+export declare function getAiVoiceCopyStatus(options: {
+    /** 产品PK */
+    productKey: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-智能体基础语音列表
+ */
+export declare function queryAiBotVoiceList(options: {
+    /** 角色ID */
+    botRoleId: number;
+    /** 产品PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 页码 */
+    pageNum: number;
+    /** 页大小 */
+    pageSize: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-自定义音色查询
+ */
+export declare function getEduVoiceCopyAudio(options: {
+    /** 角色ID */
+    botRoleId: number;
+    /** 产品PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-声音发布-下架
+ */
+export declare function changePublishStatus(options: {
+    /** 产品PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** id */
+    id: string;
+    /** 发布状态 */
+    publishStatus: boolean;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-音色名称编辑
+ */
+export declare function setVoiceNameAudio(options: {
+    /** 产品PK */
+    productKey: string;
+    /** 设备DK */
+    deviceKey: string;
+    /** 声音id */
+    voiceId: string;
+    /** 音色名称 */
+    voiceName: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-声音复刻-查询套餐列表
+ */
+export declare function findPackageList(options: {
+    /** 商户号 */
+    merchantNo: string;
+    /** 终端应用 */
+    terminalCode?: string;
+    /** 套餐类型，默认 AI_VOICE_CLONE */
+    packageType?: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ *  AI面板-声音复刻-终端用户创建业务订单
+ */
+export declare function createBizOrder(options: {
+    /** 商户号 */
+    merchantNo: string;
+    /** 套餐版本id */
+    packageVersionId: number;
+    /** 购买份数 */
+    size: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;

package/dist/modules/role.d.ts

@@ -0,0 +1,116 @@
+/**
+ * @module 自定义角色
+ */
+/**
+ * 提示词模板列表
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.promptTemplateList({
+ *   supplier:'',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function promptTemplateList(options: {
+    /** 供应商 */
+    supplier: string;
+    /** 模板标签，多个模板使用","分隔 */
+    tags?: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 提示词模板详情
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.promptTemplateDetail({
+ *   ptcId:'',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function promptTemplateDetail(options: {
+    /** 模板ID */
+    ptcId: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 润色提示词
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.obtainPolishPrompt({
+ *   roleName:'',
+ *   roleInput:'',
+ *   roleDesc:'',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function obtainPolishPrompt(options: {
+    /** 角色名称 */
+    roleName: string;
+    /** 角色补充 */
+    roleInput: string;
+    /** 角色描述 */
+    roleDesc: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 查询给角色设置的音色信息
+ * @desc 可查询最新的声音信息
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.findBotVoice({
+ *   roleId:'',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function findBotVoice(options: {
+    /** 角色ID */
+    roleId: number;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;

package/dist/modules/summary.d.ts

@@ -0,0 +1,115 @@
+/**
+ * @module 互动总结
+ */
+import type { CommonStatusOptionType } from '../types/params';
+/**
+ * 是否显示互动总结/成长建议
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.isShowSummaryAndTask({
+ *   productKey：'',
+ *   type:'SUMMARY',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function isShowSummaryAndTask(options: {
+    /** 设备 PK */
+    productKey: string;
+    /** 类型 */
+    type: CommonStatusOptionType;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 查询互动总结是否生成
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.querySummaryGenerate({
+ *   productKey：'',
+ *   deviceKey:'',
+ *   startTime:'',
+ *   endTime:'',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function querySummaryGenerate(options: {
+    /** 设备 PK */
+    productKey?: string;
+    /** 设备 DK */
+    deviceKey?: string;
+    /** 终端用户 ID */
+    endUserId?: string;
+    /** 设备信息 ID */
+    deviceInfoId?: string;
+    /** 开始时间，毫秒时间戳 */
+    startTime: number;
+    /** 结束时间，毫秒时间戳 */
+    endTime: number;
+    /** 角色ID */
+    roleId?: string;
+    /** 数据维度：device(设备级别 pk、dk 必传); user(用户级别 pk、dk、endUserId 或 deviceInfoId 必传其一) 默认为device */
+    dataDim?: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 查询互动总结内容
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.summaryCommon({
+ *   day:''
+ *   productKey: '',
+ *   deviceKey: '',
+ *   endUserId: '',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function summaryCommon(options: {
+    /** 天数 */
+    day: number;
+    /** 设备信息 ID */
+    deviceInfoId?: string;
+    /** 设备 PK */
+    productKey?: string;
+    /** 设备 DK */
+    deviceKey?: string;
+    /** 终端用户 ID */
+    endUserId?: string;
+    /** 数据维度：device(设备级别 pk、dk 必传); user(用户级别 pk、dk、endUserId 或 deviceInfoId 必传其一) 默认为device */
+    dataDim?: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;