@quec-wx-mp/api-ai 0.1.4

package/dist/modules/memory.d.ts

@@ -0,0 +1,298 @@
+/**
+ * @module 记忆体
+ */
+/**
+ * 查询 SAAS 设备列表
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.findListV2({
+ *     success (res) {},
+ *     fail (res) {},
+ *     complete (res) { }
+ * })
+ * ```
+ */
+export declare function findListV2(options: {
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 获取设备的当前角色和音色
+ * @desc 获取设备的当前角色与音色。（deviceInfoId 与 （productKey、deviceKey、endUserId） 二选一）
+ *
+ * @example
+ *
+ * ```js
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.findDeviceRoleVoiceRelV2({
+ *   productKey: '',
+ *   deviceKey: '',
+ *   endUserId: '',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function findDeviceRoleVoiceRelV2(options: {
+    /** 设备信息ID（优先以deviceInfoId为主，没有的话处理pk、dk、endUserId） */
+    deviceInfoId?: number;
+    /** 设备PK */
+    productKey?: string;
+    /** 设备DK */
+    deviceKey?: string;
+    /** 终端用户ID */
+    endUserId?: string;
+    /** 接口调用成功的回调函数 */
+    success: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 切换角色/音色
+ *
+ * @desc 切换角色/音色步骤：
+ * 1、调用 plugin.ai.editDeviceRoleVoiceV2 API设置
+ * 2、确保websocket已连接(如未连接调用plugin.socket.connect连接)，调用plugin.socket.send 向设备下发 重新进房指令
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.editDeviceRoleVoiceV2({
+ *   productKey: '',
+ *   deviceKey: '',
+ *   endUserId: '',
+ *   roleId: '',
+ *   voiceId: '',
+ *   success (res) {
+ *      //连接websocket(plugin.socket.connect)后，调用plugin.socket.send 向设备下发 重新进房指令
+ *   },
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function editDeviceRoleVoiceV2(options: {
+    /** 角色ID */
+    roleId: number;
+    /** 音色ID */
+    voiceId: number;
+    /** 设备信息ID */
+    deviceInfoId?: number;
+    /** 设备PK */
+    productKey?: string;
+    /** 设备DK */
+    deviceKey?: string;
+    /** 终端用户ID */
+    endUserId?: string;
+    /** 接口调用成功的回调函数 */
+    success: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 获取设备历史聊天消息列表
+ *
+ * @example
+ * ```js
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.deviceMessageV2({
+ *   roleId: '',
+ *   status: 0,
+ *   productKey: '',
+ *   deviceKey: '',
+ *   endUserId: '',
+ *   limit: 10,
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function deviceMessageV2(options: {
+    /** 角色ID */
+    roleId: number;
+    /** 刷新：0，加载：1 */
+    status: number;
+    /** 设备信息ID（优先以deviceInfoId为主，没有的话处理pk、dk、endUserId） */
+    deviceInfoId?: number;
+    /** 设备PK */
+    productKey?: string;
+    /** 设备DK */
+    deviceKey?: string;
+    /** 终端用户ID */
+    endUserId?: string;
+    /** status=0:指定为返回结果中的 lastId；status=1:指定为返回结果中的 firstId */
+    afterId?: string;
+    /** 每页条数 */
+    limit?: number;
+    /** 接口调用成功的回调函数 */
+    success: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 查询聊天总结
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.getSummaryV2({
+ *   day: '',
+ *   productKey: '',
+ *   deviceKey: '',
+ *   deviceInfoId: '',
+ *   endUserId: '',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function getSummaryV2(options: {
+    /** 时间格式：（YYYYMMDD）如：20250606 */
+    day: string;
+    /** 设备信息ID */
+    deviceInfoId?: number;
+    /** 设备PK */
+    productKey?: string;
+    /** 设备DK */
+    deviceKey?: string;
+    /** 终端用户ID */
+    endUserId?: string;
+    /** 接口调用成功的回调函数 */
+    success: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 恢复出厂设置
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.deviceResetV2({
+ *   productKey: '',
+ *   deviceKey: '',
+ *   deviceInfoId: '',
+ *   endUserId: '',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function deviceResetV2(options: {
+    /** 设备信息ID */
+    deviceInfoId?: number;
+    /** 设备PK */
+    productKey?: string;
+    /** 设备DK */
+    deviceKey?: string;
+    /** 终端用户ID */
+    endUserId?: string;
+    /** 接口调用成功的回调函数 */
+    success?: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail?: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 设备迁移接口
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.deviceShiftV2({
+ *   deviceInfoIdOld: '',
+ *   deviceInfoIdNew: '',
+ *   productKeyNew: '',
+ *   deviceKeyNew: '',
+ *   endUserIdNew: '',
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function deviceShiftV2(options: {
+    /** 旧设备信息ID */
+    deviceInfoIdOld: number;
+    /** 新设备信息ID */
+    deviceInfoIdNew: number;
+    /** 新设备PK */
+    productKeyNew?: string;
+    /** 新设备DK */
+    deviceKeyNew?: string;
+    /** 新终端用户ID */
+    endUserIdNew?: string;
+    /** 接口调用成功的回调函数 */
+    success: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;
+/**
+ * 长记忆删除接口
+ *
+ * @example
+ * ```
+ * const plugin = requirePlugin('quecPlugin')
+ * plugin.ai.deleteMemoryV2({
+ *   roleIds:[1],
+ *   success (res) {},
+ *   fail (res) {},
+ *   complete (res) { }
+ * })
+ * ```
+ */
+export declare function deleteMemoryV2(options: {
+    /** 角色ID列表 */
+    roleIds: number[];
+    /** 设备信息ID（优先以 deviceInfoId 为主，没有的话处理 pk、dk、endUserId） */
+    deviceInfoId?: number;
+    /** 设备PK */
+    productKey?: string;
+    /** 设备DK */
+    deviceKey?: string;
+    /** 终端用户ID */
+    endUserId?: string;
+    /** 接口调用成功的回调函数 */
+    success: (res: ResponseData) => void;
+    /** 接口调用失败的回调函数 */
+    fail: (res: Error) => void;
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete: () => void;
+}, 
+/** @ignore */
+requestMethod: RequestFunction): void;