@ray-js/t-agent-plugin-aistream 0.2.0-beta-1

package/dist/AIStreamTypes.d.ts

@@ -0,0 +1,1413 @@
+export declare enum ButtonRouterType {
+    /**
+     * 创建场景
+     */
+    CREATE_SCENE = "routeSceneCreate",
+    /**
+     * 设置家庭地址
+     */
+    HOME_LOCATION = "routeHomeLocation",
+    /**
+     * 使用指南
+     */
+    HELP_DOC = "routeHelpDoc",
+    /**
+     * 支持的设备列表
+     */
+    SUPPORT_DEVICES = "routeSupportDevices",
+    /**
+     * 家庭管理
+     */
+    FAMILY_MANAGE = "routeHomeManage",
+    /**
+     * 房间管理
+     */
+    ROOM_MANAGE = "routeRoomManage",
+    /**
+     * 告警消息列表
+     */
+    MESSAGE_WARN = "routeWarnMessage",
+    /**
+     * 家庭消息列表
+     */
+    MESSAGE_HOME = "routeHomeMessage",
+    /**
+     * 通知列表
+     */
+    MESSAGE_NOTICE = "routeNotice",
+    /**
+     * 消息设置
+     */
+    MESSAGE_SETTING = "routeMessageSetting",
+    /**
+     * 个人资料
+     */
+    USER_INFO = "routeUserInfo",
+    /**
+     * 账号与安全
+     */
+    ACCOUNT_SECURITY = "routeAccountSecurity",
+    /**
+     * 通用设置
+     */
+    SETTING = "routeSetting",
+    /**
+     * 语音等三方服务
+     */
+    VOICE_SERVICE = "routeVoiceOrThirdService",
+    /**
+     * 问题工单
+     */
+    TICKETS = "routeProblemTickets",
+    /**
+     * 问卷
+     */
+    QUESTIONNAIRE = "routeAiQuestionnaire",
+    /**
+     * 设备配网
+     */
+    PARING = "routeAddDevice",
+    /**
+     * 设备分享
+     */
+    DEVICE_SHARE = "routeDeviceShare"
+}
+export type TextInputBlock = {
+    type: 'text';
+    text: string;
+};
+export type ImageUrlInputBlock = {
+    type: 'image_url';
+    image_url: {
+        url: string;
+    };
+};
+export type ImagePathInputBlock = {
+    type: 'image_path';
+    image_path: {
+        path: string;
+    };
+};
+export type FileUrlInputBlock = {
+    type: 'file_url';
+    file_url: {
+        mimeType: string;
+        url?: string;
+        path?: string;
+    };
+};
+export type FilePathInputBlock = {
+    type: 'file_path';
+    file_path: {
+        mimeType: string;
+        path: string;
+    };
+};
+export type VideoPathInputBlock = {
+    type: 'video_path';
+    video_path: {
+        path: string;
+    };
+};
+/**
+ * 发送 type 是 AI 多模态时，block 参数需要传递的JSON格式
+ */
+export type InputBlock = ImageUrlInputBlock | TextInputBlock | FileUrlInputBlock | ImagePathInputBlock | FilePathInputBlock | VideoPathInputBlock;
+export interface Recommendation {
+    text: string;
+    type: 1 | 2 | 3 | 4;
+    h5Url?: string;
+    miniProgramUrl?: string;
+    nativeUrl?: string;
+}
+export interface ProjectConfig {
+    test?: boolean;
+    aiPtCode: string;
+    aiAssistant?: boolean;
+    scene: 'chat' | 'rule';
+    nameColor: string;
+    powerCode: Record<string, string>;
+    bgImg: string;
+    welcome: {
+        guide: string;
+        guideRecommendation: Recommendation[];
+        daily: string;
+        dailyRecommendation: Recommendation[];
+    };
+    inputMethods: {
+        init: 'text' | 'voice';
+        text: boolean;
+        voice: boolean;
+    };
+    feedback?: {
+        enabled: boolean;
+    };
+    boardMenu: {
+        switchToOld: {
+            enabled: boolean;
+            iconPathLight: string;
+            iconPathDark: string;
+        };
+        supportDevices: {
+            enabled: boolean;
+            iconPathLight: string;
+            iconPathDark: string;
+        };
+        usageGuide: {
+            enabled: boolean;
+            iconPathLight: string;
+            iconPathDark: string;
+            h5Url: string;
+        };
+    };
+    vas: {
+        free: boolean;
+        catalogCode: string;
+        externalCode: string;
+        deductType: 'home' | 'account';
+        title: string;
+        logo: string;
+        trialBtnText: string;
+        purchaseBtnText: string;
+    };
+    atop?: {
+        deviceList: {
+            api: string;
+            version: string;
+        };
+    };
+}
+/**
+ * 获取小程序自定义配置
+ */
+export type GetMiniAppConfigParams = {
+    complete?: () => void;
+    success?: (params: {
+        /** 小程序自定义配置 */
+        config: any;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+};
+export type MiniProgramAccountInfo = {
+    /** 小程序 appId */
+    appId: string;
+    /**
+     * 小程序版本
+     * develop: 开发版
+     * trail: 体验版
+     * release: 正式版
+     */
+    envVersion: string;
+    /** 小程序版本号 */
+    version: string;
+    /** 小程序名称 */
+    appName: string;
+    /** 小程序图标 */
+    appIcon: string;
+};
+/**
+ * 获取小程序账号信息
+ */
+export type GetAccountInfoParams = {
+    complete?: () => void;
+    success?: (params: {
+        miniProgram: MiniProgramAccountInfo;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+    }) => void;
+};
+/**
+ * atop接口
+ */
+export type ApiRequestByAtopParams = {
+    /**
+     * atop入参数据模型
+     * api api名称
+     */
+    api: string;
+    /** version api版本号 */
+    version?: string;
+    /** postData 入参结构体 */
+    postData: Record<string, any>;
+    /**
+     * extData 额外参数，当前只支持传递gid
+     * 数据格式：{"gid":"xxxx"}
+     */
+    extData?: Record<string, any>;
+    complete?: () => void;
+    success?: (params: {
+        /**
+         * 请求结果
+         * thing_data_ 出参结构体， JSON序列化
+         */
+        thing_json_?: any;
+        /** 元数据 */
+        data: string;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+};
+export declare enum HighwayMethod {
+    /** HTTP 请求 OPTIONS */
+    OPTIONS = "OPTIONS",
+    /** HTTP 请求 GET */
+    GET = "GET",
+    /** HTTP 请求 HEAD */
+    HEAD = "HEAD",
+    /** HTTP 请求 POST */
+    POST = "POST",
+    /** HTTP 请求 PUT */
+    PUT = "PUT",
+    /** HTTP 请求 DELETE */
+    DELETE = "DELETE",
+    /** HTTP 请求 TRACE */
+    TRACE = "TRACE",
+    /** HTTP 请求 TRACE */
+    CONNECT = "CONNECT"
+}
+/**
+ * Highway接口
+ */
+export type ApiRequestByHighwayParams = {
+    /**
+     * api api名称
+     */
+    api: string;
+    /** 入参结构体 */
+    data: Record<string, any>;
+    method: HighwayMethod;
+    complete?: () => void;
+    success?: (params: {
+        /**
+         * 请求结果
+         * thing_data_ 出参结构体， JSON序列化
+         */
+        thingjson?: any;
+        /** 元数据 */
+        data: string;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+    }) => void;
+};
+export type GetCurrentHomeInfoParams = {
+    complete?: () => void;
+    success?: (params: {
+        /** 家庭名称 */
+        homeName: string;
+        /** 家庭id */
+        homeId: string;
+        /** 经度 */
+        longitude: string;
+        /** 维度 */
+        latitude: string;
+        /** 详细地址 */
+        address: string;
+        /**
+         * 是否是管理员
+         * true 是管理员; false 非管理员
+         */
+        admin: boolean;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+};
+export interface AuthorizeParams {
+    /**
+     * scope 权限名称
+     * 举例子：
+     * scope.bluetooth 蓝牙权限
+     * scope.writePhotosAlbum 写入相册权限
+     * scope.userLocationBackground 后台定位权限
+     * scope.record 麦克风权限
+     * scope.camera 摄像头权限
+     * scope.userLocation 低精度定位权限
+     * scope.userPreciseLocation 高精度定位权限
+     * scope.userInfo 用户信息
+     */
+    scope: string;
+    complete?: () => void;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+}
+export interface GetAppInfoParams {
+    complete?: () => void;
+    success?: (params: {
+        /**
+         * App信息
+         * serverTimestamp 云端时间戳
+         * appVersion app版本
+         * language app语言包
+         * countryCode 国家码
+         * regionCode 地区码， 在RN Api中被当作“service”字段
+         */
+        serverTimestamp: number;
+        appVersion: string;
+        language: string;
+        countryCode: string;
+        regionCode: string;
+        /** appName app名称 */
+        appName: string;
+        /** appIcon app图标 */
+        appIcon: string;
+        /**
+         * app环境
+         * 0: 日常
+         * 1: 预发
+         * 2: 线上
+         */
+        appEnv?: number;
+        /** app包名 */
+        appBundleId: string;
+        /** app scheme */
+        appScheme: string;
+        /** app id */
+        appId: string;
+        /** app clientId */
+        clientId?: string;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+}
+export interface CanIUseRouterParams {
+    /** 路由链接 */
+    url: string;
+    complete?: () => void;
+    success?: (params: {
+        /** 路由是否可用 */
+        result: boolean;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+}
+export interface RouterParams {
+    /** 路由链接 */
+    url: string;
+    complete?: () => void;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+}
+export interface NavigateToMiniProgramParams {
+    /** 要打开的小程序appId */
+    appId?: string;
+    /** 要打开的智能体小程序的智能体Id */
+    aiPtChannel?: string;
+    /**
+     * 要打开的小程序智能体的版本。
+     * preview：体验版
+     * release：正式版
+     */
+    aiPtType?: string;
+    /** 打开的页面路径,如果为空则打开首页,path 中 ? 后面的部分会成为 query，在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数 */
+    path?: string;
+    /** 打开小程序的转场方式,分为right|bottom,指代水平和竖直方向 */
+    position?: string;
+    /** 传递给目标小程序的数据,目标小程序可在 `App.onLaunch`，`App.onShow` 中获取到这份数据 */
+    extraData?: Record<string, any>;
+    /**
+     * 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版
+     * trial：体验版
+     * release：正式版
+     */
+    envVersion?: string;
+    /** 小程序链接，当传递该参数后，可以不传 appId 和 path */
+    shortLink?: string;
+    complete?: () => void;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+}
+export interface OpenInnerH5Params {
+    /** url H5链接地址 */
+    url: string;
+    /** title H5标题 */
+    title?: string;
+    complete?: () => void;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+}
+export declare enum AuthorizePolicySign {
+    /** 未授权 */
+    UNAUTHORIZED = 0,
+    /** 需重新授权 */
+    REAUTHORIZATION = 1,
+    /** 已授权 */
+    AUTHORIZED = 2
+}
+export interface AuthorizePolicyStatusParams {
+    type: string;
+    complete?: () => void;
+    success?: (params: {
+        sign: AuthorizePolicySign;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+}
+export interface RegisterChannelParams {
+    /** 事件名称 */
+    eventName: string;
+    complete?: () => void;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+}
+export type EventChannelMessageParams = {
+    /** 事件id */
+    eventId: string;
+    /** 传递事件对象 */
+    event?: any;
+};
+export declare enum WidgetVersionType {
+    /** 线上版本 */
+    release = "release",
+    /** 预发版本 */
+    preview = "preview"
+}
+export declare enum WidgetPosition {
+    /** 居底展示 */
+    bottom = "bottom",
+    /** 居顶展示 */
+    top = "top",
+    /** 居中展示 */
+    center = "center"
+}
+export type OpenMiniWidgetParams = {
+    /** 要打开的小部件appid */
+    appId: string;
+    /** 对应的小部件页面相对url, 如果为空则打开首页,path 中 ? 后面的部分会成为 query */
+    pagePath?: string;
+    /** 面板类型设备id */
+    deviceId?: string;
+    /** 面板群组类型群组id */
+    groupId?: string;
+    /** 小部件样式,默认middle */
+    style?: string;
+    /** 版本类型,默认release */
+    versionType?: WidgetVersionType;
+    /** 版本号 */
+    version?: string;
+    /** 展示位置,默认bottom */
+    position?: WidgetPosition;
+    /** 点击空白处是否关闭 */
+    autoDismiss?: boolean;
+    /**
+     * 是否优先展示默认缓存
+     * 对应属性在小程序容器3.1.0生效
+     */
+    autoCache?: boolean;
+    /** 是否支持深色模式 */
+    supportDark?: boolean;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ * AIStream 相关
+ */
+export declare enum ConnectState {
+    /** 初始化 */
+    INIT = 0,
+    /** 连接中 */
+    CONNECTING = 1,
+    /** 鉴权中 */
+    AUTHORIZING = 2,
+    /** 已连接 */
+    CONNECTED = 3,
+    /** 被云端断开 */
+    DISCONNECTED = 4,
+    /** 主动关闭 */
+    CLOSED = 5
+}
+export declare enum SessionState {
+    /** 会话创建成功 */
+    CREATED = 0,
+    /** 会话创建失败 */
+    CREATE_FAILED = 1,
+    /** 会话被云端关闭 */
+    CLOSED = 2
+}
+export declare enum ConnectClientType {
+    /** 作为设备代理 */
+    DEVICE = 1,
+    /** 作为 App */
+    APP = 2
+}
+export declare enum EventType {
+    /** 事件开始 */
+    EVENT_START = 0,
+    /** 事件数据结束 */
+    EVENT_PAYLOAD_END = 1,
+    /** 事件结束 */
+    EVENT_END = 2,
+    /** 一次性事件 */
+    ONE_SHOT = 3,
+    /** 聊天中断 */
+    CHAT_BREAK = 4,
+    /** 服务端 VAD */
+    SERVER_VAD = 5
+}
+export declare enum StreamFlag {
+    /** 仅一包 */
+    ONLY_ONE = 0,
+    /** 传输开始 */
+    START = 1,
+    /** 传输中 */
+    IN_PROGRESS = 2,
+    /** 传输结束 */
+    END = 3
+}
+export declare enum FileFormat {
+    /** MP4 */
+    MP4 = 1,
+    /** OGG_OPUS */
+    OGG_OPUS = 2,
+    /** PDF */
+    PDF = 3,
+    /** JSON */
+    JSON = 4,
+    /** IPC_LOG */
+    IPC_LOG = 5,
+    /** SweeperMap */
+    SWEEPER_MAP = 6
+}
+export declare enum AIStreamErrorCode {
+    OK = 200,
+    BadRequest = 400,
+    Unauthenticated = 401,
+    NotFound = 404,
+    RequestTimeout = 408,
+    InternalServerError = 500,
+    GatewayTimeout = 504,
+    CloseByClient = 601,
+    CloseByReuse = 602,
+    CloseByIO = 603,
+    CloseByKeepalive = 604,
+    CloseByExpire = 605
+}
+export declare enum BizCode {
+    CHAT = 65537
+}
+export declare enum BizTag {
+    DEFAULT = 0
+}
+export type BizConfig = {
+    /** 业务 code */
+    bizCode: number;
+    /**
+     * 发送数据 code 约定
+     * 例如 ["audio", "video", "text", "image"}
+     */
+    sendData: string[];
+    /**
+     * 接收数据 code 约定
+     * 例如 ["text", "audio"]
+     */
+    revData: string[];
+};
+export declare enum AIStreamAttributeType {
+    AI_CHAT = 1003
+}
+export declare enum AIStreamAttributePayloadType {
+    U_INT8 = 1,
+    U_INT16 = 2,
+    U_INT32 = 3,
+    U_INT64 = 4,
+    BYTES = 5,
+    STRING = 6
+}
+export declare enum AIStreamChatSysWorkflow {
+    ASR_LLM_TTS = "asr-llm-tts",
+    ASR_LLM = "asr-llm",
+    ASR = "asr",
+    LLM = "llm",
+    LLM_TTS = "llm-tts"
+}
+export interface AIStreamChatAttribute {
+    'asr.enableVad'?: 'true' | 'false';
+    'processing.interrupt'?: 'true' | 'false';
+    'sys.workflow'?: AIStreamChatSysWorkflow;
+    [key: string]: string;
+}
+export type Attribute = {
+    /** Attribute 类型 */
+    type: AIStreamAttributeType;
+    /** 数据类型：0x01-UInt8, 0x02-UInt16, 0x03-UInt32, 0x04-UInt64, 0x05-Bytes, 0x06-String */
+    payloadType: AIStreamAttributePayloadType;
+    /** 数据：UInt8~UInt64 数字用字符串传递，Bytes 用 HexString传递， */
+    value: string;
+};
+export type EventBody = {
+    /** 事件 id */
+    eventId: string;
+    /** 会话 id */
+    sessionId: string;
+    /** 事件类型: 0-Event Start, 1-Event Payload End, 2-Event End, 3 - OneShot, 4-Chat Break, 5-Server VAD */
+    eventType: EventType;
+    /** 属性列表 */
+    userData?: Attribute[];
+};
+export type AudioBody = {
+    /** 接收数据通道 */
+    dataChannel: string;
+    /** 数据流类型: 0-仅一包, 1-传输开始, 2-传输中, 3-传输结束 */
+    streamFlag: StreamFlag;
+    /** 音频缓存路径，传输结束后可访问(streamFlag == 1 || StreamFlag == 3) */
+    path: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    /** SessionId 列表, 云端返回，可能为空 */
+    sessionIdList?: string[];
+};
+export type VideoBody = {
+    /** 接收数据通道 */
+    dataChannel: string;
+    /** 数据流类型: 0-仅一包, 1-传输开始, 2-传输中, 3-传输结束 */
+    streamFlag: StreamFlag;
+    /** 视频缓存路径，传输结束后可访问(streamFlag == 1 || StreamFlag == 3) */
+    path: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    /** SessionId 列表, 云端返回，可能为空 */
+    sessionIdList?: string[];
+};
+export type ImageBody = {
+    /** 接收数据通道 */
+    dataChannel: string;
+    /** 数据流类型: 0-仅一包, 1-传输开始, 2-传输中, 3-传输结束 */
+    streamFlag: StreamFlag;
+    /** 图片缓存路径，传输结束后可访问(streamFlag == 1 || StreamFlag == 3) */
+    path: string;
+    /** 图片宽度 */
+    width: number;
+    /** 图片高度 */
+    height: number;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    /** SessionId 列表, 云端返回，可能为空 */
+    sessionIdList?: string[];
+};
+export type TextBody = {
+    /** 接收数据通道 */
+    dataChannel: string;
+    /** 数据流类型: 0-仅一包, 1-传输开始, 2-传输中, 3-传输结束 */
+    streamFlag: StreamFlag;
+    /** 文本内容(JSON String，见云端文档定义) */
+    text: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    /** SessionId 列表, 云端返回，可能为空 */
+    sessionIdList?: string[];
+};
+export type FileBody = {
+    /** 接收数据通道 */
+    dataChannel: string;
+    /** 数据流类型: 0-仅一包, 1-传输开始, 2-传输中, 3-传输结束 */
+    streamFlag: StreamFlag;
+    /** 文件缓存路径，传输结束后可访问(streamFlag == 1 || StreamFlag == 3) */
+    path: string;
+    /** 文件类型: 1 - MP4, 2 - OGG_OPUS, 3 - PDF, 4 - JSON, 5 - IPC_LOG, 6 - SweeperMap */
+    format: FileFormat;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    /** SessionId 列表, 云端返回，可能为空 */
+    sessionIdList?: string[];
+};
+export type ConnectStateBody = {
+    /** connection id */
+    connectionId: string;
+    /** 连接状态: 0-初始化，1-连接中，2-鉴权中，3-已连接，4-被云端断开，5-主动关闭 */
+    connectState: ConnectState;
+    /** 被云端断开错误码 */
+    code?: AIStreamErrorCode;
+};
+export type SessionStateBody = {
+    /** 会话 id */
+    sessionId: string;
+    /** 会话状态: 0-会话创建成功, 1-会话创建失败, 2-会话被云端关闭 */
+    sessionState: SessionState;
+    /** 会话被关闭原因 */
+    code?: AIStreamErrorCode;
+};
+export type RecordAmplitudesBody = {
+    /** 振幅数据 */
+    amplitudes: number[];
+};
+export type CheckConnectParams = {
+    /** client 类型: 1-作为设备代理, 2-作为 App */
+    clientType: ConnectClientType;
+    /** 代理的设备ID, clientType == 1 时必传 */
+    deviceId?: string;
+};
+export type CheckConnectResult = {
+    /** 是否已连接 */
+    connected: boolean;
+    /** 通道连接状态: 0-初始化，1-连接中，2-鉴权中，3-已连接，4-被云端断开，5-主动关闭 */
+    state: ConnectState;
+    /** client 类型: 1-作为设备代理, 2-作为 App. */
+    clientType?: ConnectClientType;
+    /** 连接的唯一标识 */
+    connectionId?: string;
+};
+/**
+ *@description 发起通道连接，若此前已连接会直接回调成功
+ */
+export type ConnectParams = {
+    /** client 类型: 1-作为设备代理, 2-作为 App */
+    clientType: ConnectClientType;
+    /** 代理的设备ID, clientType == 1 时必传 */
+    deviceId?: string;
+    success?: (params: {
+        /** 连接的唯一标识 */
+        connectionId: string;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ *@description 查询智能体 token，传递给 createSession
+ */
+export type QueryAgentTokenParams = {
+    /** Owner ID: HomeID 或 设备id */
+    ownerId: string;
+    /** 智能解决方案 code */
+    solutionCode: string;
+    /** 业务接口 */
+    api: string;
+    /** 接口版本 */
+    apiVersion: string;
+    /** 业务额外参数 */
+    extParams: any;
+    success?: (params: {
+        /** 智能体 token */
+        agentToken: string;
+        /** 业务配置 */
+        bizConfig: BizConfig;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ *@description 创建会话
+ */
+export type CreateSessionParams = {
+    /** 业务 tag */
+    bizTag?: BizTag;
+    /** 智能体 token */
+    agentToken: string;
+    /** 会话 id. 不传递则自动生成，传递则使用传递的 */
+    sessionId?: string;
+    /** 业务配置定义（通过 queryAgentToken 传递） */
+    bizConfig: BizConfig;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    /** 是否复用数据通道，默认不复用 */
+    reuseDataChannel?: boolean;
+    success?: (params: {
+        /** 会话 id */
+        sessionId: string;
+        /**
+         * 下发数据通道 列表. (下发数据时，需要使用该列表中的 Code)
+         * 音频视频图片文件都只有一路时，例如 bizCode 65537 ["audio", "video", "text", "image"]
+         * 有多路重复时，例如 双路音视频：["audio_0", "audio_1", "video_0", "video_1", "text", "image"]
+         */
+        sendDataChannels: string[];
+        /**
+         * 接收数据通道 列表. (接收数据时，数据中会使用该列表中的 Code)
+         * 音频视频图片文件都只有一路时，例如 bizCode 65537，接收只有 文本、音频 ["text", "audio"]
+         */
+        revDataChannels: string[];
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ *@description 关闭会话
+ */
+export type CloseSessionParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 关闭原因, 非异常则使用 200 来关闭 */
+    code: AIStreamErrorCode;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ *@description 关闭连接，主要针对作为设备代理的情况，以App身份使用时不需要调用
+ */
+export type DisconnectParams = {
+    /** 需要断连的 connection Id */
+    connectionId: string;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type SendEventStartParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: {
+        /** 事件 id。此后 sendEventPayloadEnd、sendEventEnd、sendEventChatBreak 都需要使用该 eventId 直到下发一次 sendEventStart 生成新 eventId 之前。 */
+        eventId: string;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ *@description 某个数据流传输结束事件
+ */
+export type SendEventPayloadEndParams = {
+    /** 事件 id */
+    eventId: string;
+    /** 会话 id */
+    sessionId: string;
+    /** 发送结束 的 dataChannel */
+    dataChannel: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ *@description 结束事件
+ */
+export type SendEventEndParams = {
+    /** 事件 id */
+    eventId: string;
+    /** 会话 id */
+    sessionId: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ *@description 打断事件。用于：1. 中止自己的发送，2. 中止接收云端的回复
+ */
+export type SendEventChatBreakParams = {
+    /** 事件 id， */
+    eventId: string;
+    /** 会话 id */
+    sessionId: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+/**
+ *@description 开始录制并发送音频数据
+ */
+export type StartRecordAndSendAudioDataParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 下发数据通道，当音频只有单路的时候，可以不传 */
+    dataChannel?: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type StopRecordAndSendAudioDataParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 下发数据通道，当音频只有单路的时候，可以不传 */
+    dataChannel?: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export declare enum VideoCameraType {
+    FRONT = 1,
+    BACK = 2
+}
+export type StartRecordAndSendVideoDataParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 下发数据通道，当音频只有单路的时候，可以不传 */
+    dataChannel?: string;
+    /**
+     * 摄像头类型
+     * 1-前置摄像头, 2-后置摄像头
+     */
+    cameraType: VideoCameraType;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type StopRecordAndSendVideoDataParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 下发数据通道，当音频只有单路的时候，可以不传 */
+    dataChannel?: string;
+    /**
+     * 摄像头类型
+     * 1-前置摄像头, 2-后置摄像头
+     */
+    cameraType: VideoCameraType;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type SendImageDataParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 下发数据通道，当音频只有单路的时候，可以不传 */
+    dataChannel?: string;
+    /** 图片路径 */
+    path: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type SendTextDataParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 下发数据通道，当音频只有单路的时候，可以不传 */
+    dataChannel?: string;
+    /** 文本内容 */
+    text: string;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type SendFileDataParams = {
+    /** 会话 id */
+    sessionId: string;
+    /** 下发数据通道，当音频只有单路的时候，可以不传 */
+    dataChannel?: string;
+    /** 文件路径 */
+    path: string;
+    /** 文件类型: 1 - MP4, 2 - OGG_OPUS, 3 - PDF, 4 - JSON, 5 - IPC_LOG, 6 - SweeperMap */
+    format: FileFormat;
+    /** 扩展属性 */
+    userData?: Attribute[];
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type RecordBody = {
+    /** 记录ID, 自增. (insertRecord 不传, updateRecord 必传, 作为 Response 返回时必有值） */
+    id: number;
+    /** biz Code 大类目，可搜索 */
+    bizCode?: number;
+    /** 智能解决方案 code, 可搜索 */
+    solutionCode?: string;
+    /** 设备 id，可搜索 */
+    devId?: string;
+    /** 家庭 id, 可搜索 */
+    homeId?: number;
+    /** type, 业务自行决定，可搜索 */
+    type?: string;
+    /** 索引, 业务自行决定，可搜索 */
+    index?: string;
+    /** 扩展索引1, 业务自行决定，可搜索 */
+    index1?: string;
+    /** 扩展索引2, 业务自行决定，可搜索 */
+    index2?: string;
+    /** 缓存数据，JSON格式，不可搜索 */
+    data?: string;
+    /** 值，不可搜索 */
+    value?: string;
+    /** 扩展值1，不可搜索 */
+    value1?: string;
+    /** 扩展值2，不可搜索 */
+    value2?: string;
+};
+export type QueryRecordListParams = {
+    /** 自增ID */
+    id?: number[];
+    /** biz Code 大类目，可搜索 */
+    bizCode?: BizCode[];
+    /** 智能解决方案 code, 可搜索 */
+    solutionCode?: string[];
+    /** 设备 id，可搜索 */
+    devId?: string[];
+    /** 家庭 id, 可搜索 */
+    homeId?: number[];
+    /** type, 业务自行决定，可搜索 */
+    type?: string[];
+    /** 索引, 业务自行决定，可搜索 */
+    index?: string[];
+    /** 扩展索引1, 业务自行决定，可搜索 */
+    index1?: string[];
+    /** 扩展索引2, 业务自行决定，可搜索 */
+    index2?: string[];
+    /** offset 分页偏移量（删除时无需传递） */
+    offset?: number;
+    /** limit 分页大小, 不传或传0则不分页（删除时无需传递） */
+    limit?: number;
+    /**
+     * 排序方式，仅用于 `queryRecordList`
+     * - 0: 按 id 降序（默认）
+     * - 1: 按 id 升序
+     */
+    sortType?: number;
+    success?: (params: {
+        /** 记录列表 */
+        records: RecordBody[];
+        /** 记录总数 */
+        total: number;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type DeleteRecordListParams = {
+    /** 自增ID */
+    id?: number[];
+    /** biz Code 大类目，可搜索 */
+    bizCode?: BizCode[];
+    /** 智能解决方案 code, 可搜索 */
+    solutionCode?: string[];
+    /** 设备 id，可搜索 */
+    devId?: string[];
+    /** 家庭 id, 可搜索 */
+    homeId?: number[];
+    /** type, 业务自行决定，可搜索 */
+    type?: string[];
+    /** 索引, 业务自行决定，可搜索 */
+    index?: string[];
+    /** 扩展索引1, 业务自行决定，可搜索 */
+    index1?: string[];
+    /** 扩展索引2, 业务自行决定，可搜索 */
+    index2?: string[];
+    /** offset 分页偏移量（删除时无需传递） */
+    offset?: number;
+    /** limit 分页大小, 不传或传0则不分页（删除时无需传递） */
+    limit?: number;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type UpdateRecordParams = {
+    /** 记录ID, 自增. (insertRecord 不传, updateRecord 必传, 作为 Response 返回时必有值） */
+    id?: number;
+    /** biz Code 大类目，可搜索 */
+    bizCode?: BizCode;
+    /** 智能解决方案 code, 可搜索 */
+    solutionCode?: string;
+    /** 设备 id，可搜索 */
+    devId?: string;
+    /** 家庭 id, 可搜索 */
+    homeId?: number;
+    /** type, 业务自行决定，可搜索 */
+    type?: string;
+    /** 索引, 业务自行决定，可搜索 */
+    index?: string;
+    /** 扩展索引1, 业务自行决定，可搜索 */
+    index1?: string;
+    /** 扩展索引2, 业务自行决定，可搜索 */
+    index2?: string;
+    /** 缓存数据，JSON格式，不可搜索 */
+    data?: string;
+    /** 值，不可搜索 */
+    value?: string;
+    /** 扩展值1，不可搜索 */
+    value1?: string;
+    /** 扩展值2，不可搜索 */
+    value2?: string;
+    success?: (params: null) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export type InsertRecordParams = {
+    /** 记录ID, 自增. (insertRecord 不传, updateRecord 必传, 作为 Response 返回时必有值） */
+    id?: number;
+    /** biz Code 大类目，可搜索 */
+    bizCode?: BizCode;
+    /** 智能解决方案 code, 可搜索 */
+    solutionCode?: string;
+    /** 设备 id，可搜索 */
+    devId?: string;
+    /** 家庭 id, 可搜索 */
+    homeId?: number;
+    /** type, 业务自行决定，可搜索 */
+    type?: string;
+    /** 索引, 业务自行决定，可搜索 */
+    index?: string;
+    /** 扩展索引1, 业务自行决定，可搜索 */
+    index1?: string;
+    /** 扩展索引2, 业务自行决定，可搜索 */
+    index2?: string;
+    /** 缓存数据，JSON格式，不可搜索 */
+    data?: string;
+    /** 值，不可搜索 */
+    value?: string;
+    /** 扩展值1，不可搜索 */
+    value1?: string;
+    /** 扩展值2，不可搜索 */
+    value2?: string;
+    success?: (params: {
+        /** 记录ID */
+        id: number;
+    }) => void;
+    fail?: (params: {
+        errorMsg: string;
+        errorCode: string | number;
+        innerError: {
+            errorCode: string | number;
+            errorMsg: string;
+        };
+    }) => void;
+    complete?: () => void;
+};
+export declare enum ReceivedTextPacketType {
+    ASR = "ASR",
+    SKILL = "SKILL",
+    NLG = "NLG"
+}
+export declare enum ReceivedTextPacketEof {
+    CONTINUE = 0,
+    END = 1
+}
+export interface ReceivedTextPacketBase<T extends ReceivedTextPacketType, D> {
+    /** 业务 ID */
+    bizId: string;
+    /** 业务类型 */
+    bizType: T;
+    /** 是否结束 */
+    eof: ReceivedTextPacketEof;
+    /** 真实数据 */
+    data: D;
+}
+export type ReceivedTextAsrPacket = ReceivedTextPacketBase<ReceivedTextPacketType.ASR, {
+    text: string;
+}>;
+export type ReceivedTextNlgPacket = ReceivedTextPacketBase<ReceivedTextPacketType.NLG, {
+    content: string;
+    appendMode: 'append';
+    finish: boolean;
+}>;
+export type ReceivedTextSkillPacket<T = any> = ReceivedTextPacketBase<ReceivedTextPacketType.SKILL, {
+    code: string;
+    skillContent: T;
+    text: string[];
+}>;
+export type ReceivedTextPacket = ReceivedTextAsrPacket | ReceivedTextNlgPacket | ReceivedTextSkillPacket;