@zero-library/chat-agent 2.1.18 → 2.1.20

package/dist/index.d.ts

@@ -1,14 +1,55 @@
-import { createRequest, RenderControl, UserInfo } from '@zero-library/common';
+import { createRequest, RenderControl } from '@zero-library/common';
 import { ButtonProps, ThemeConfig } from 'antd';
 import * as react from 'react';
 import { Conversation, BubbleProps } from '@ant-design/x';
 export * from '@ant-design/x';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+/**
+ * 聊天服务模块
+ * 提供聊天相关的 API 接口定义和类型声明
+ * 包含会话管理、消息处理、智能体操作等功能
+ */
+/**
+ * 用户信息接口
+ * 定义用户的基本信息和权限配置
+ */
+interface UserInfo {
+    /** 用户ID */
+    id: number;
+    /** 机构名称 */
+    orgName?: string;
+    /** 用户姓名 */
+    name: string;
+    /** 用户名 */
+    username?: string;
+    /** 手机号 */
+    mobile?: string;
+    /** 头像地址 */
+    avatar: string;
+    /** 我的邀请码 */
+    myInviteCode?: string;
+    /** 邮箱地址 */
+    email?: string;
+    /** 备注信息 */
+    remark?: string;
+    /** 角色ID列表 */
+    roles?: number[];
+    /** 权限代码列表 */
+    permissions?: string[];
+}
+/**
+ * 会话列表查询参数接口
+ * 用于获取用户的会话列表
+ */
 interface ConversationsQuery extends PageReq {
+    /** 业务数据唯一ID，非必填 */
     businessId?: string;
+    /** 业务类型，非必填 */
     businessType?: number;
+    /** 目标ID（如智能体ID、专家ID等） */
     targetId: string;
+    /** 目标类型：1-用户 2-专家 3-Agent 4-税协 */
     targetType: number;
 }
 /**
@@ -148,299 +189,218 @@ interface ConversationRecentQuery {
      */
     receiverType: number;
 }
+/**
+ * 会话消息查询参数接口
+ * 用于获取指定会话的消息列表
+ */
 interface conversationMessagesQuery extends PageReq {
+    /** 会话ID */
     conversationId: string;
 }
+/**
+ * 输入文件接口
+ * 定义聊天中上传文件的属性
+ */
 interface InputFile {
-    /**
-     * Content，文件内容
-     */
+    /** 文件内容（base64编码或URL） */
     content: string;
-    /**
-     * 文件模式 remote_url local_file
-     */
+    /** 文件模式：remote_url（远程URL）| local_file（本地文件） */
     mode: string;
-    /**
-     * Type，文件类型
-     */
+    /** 文件类型（MIME类型） */
     type: string;
-    /**
-     * 文件扩展名
-     */
+    /** 文件扩展名 */
     extension: string;
-    /**
-     * 文件名
-     */
+    /** 文件名 */
     name: string;
 }
+/**
+ * 消息引用类型
+ * 用于消息回复时的引用信息
+ */
 interface MessageQuoteMsg {
-    /**
-     * Id，消息ID
-     */
+    /** 被引用的消息ID */
     id?: string;
-    /**
-     * Msgcontent，消息内容
-     */
+    /** 被引用的消息内容 */
     msgContent?: string;
-    /**
-     * Msgfiles，附件文件列表
-     */
+    /** 被引用消息的附件文件列表 */
     msgFiles?: InputFile[];
 }
+/**
+ * 消息发送者接口
+ * 定义消息发送者的身份信息
+ */
 interface MessageSender {
-    /**
-     * Curruser，是否为当前用户
-     */
+    /** 是否为当前用户 */
     currUser?: boolean;
-    /**
-     * Id，发送者ID
-     */
+    /** 发送者ID */
     id: string;
-    /**
-     * Type，1-用户 2-专家 3-Agent  4-税协
-     */
+    /** 发送者类型：1-用户 2-专家 3-Agent 4-税协 */
     type: number;
 }
+/**
+ * 会话消息接口
+ * 定义聊天消息的完整信息
+ */
 interface ConversationMessage {
-    /**
-     * Conversationid，会话ID
-     */
+    /** 会话ID */
     conversationId: string;
+    /** 会话标题（WebSocket返回时可能包含） */
     conversationTitle?: string;
+    /** 消息类型：WebSocket流式消息类型 */
     type?: 'TEXT_MESSAGE_START' | 'STEP_STARTED' | 'TEXT_MESSAGE_CONTENT' | 'TEXT_MESSAGE_END' | 'RUN_ERROR';
-    /**
-     * Id，消息ID
-     */
+    /** 消息ID */
     id: string;
-    /**
-     * Msgcontent，消息内容
-     */
+    /** 消息内容 */
     msgContent: string;
-    /**
-     * Msgfeedback，消息反馈
-     */
+    /** 消息反馈：1-赞 2-踩 */
     msgFeedback?: number;
-    /**
-     * Msgfiles，附件文件列表
-     */
+    /** 附件文件列表 */
     msgFiles?: InputFile[];
-    /**
-     * 引消息
-     */
+    /** 引用的消息信息 */
     quoteMsg?: MessageQuoteMsg;
-    /**
-     * 发送者信息
-     */
+    /** 发送者信息 */
     sender?: MessageSender;
-    /**
-     * Sendtime，发送时间
-     */
+    /** 发送时间戳 */
     sendTime: number;
-    /**
-     * Stopflag，是否打断
-     */
+    /** 是否被打断标志 */
     stopFlag?: boolean;
 }
+/**
+ * 消息反馈更新接口
+ * 用于用户对消息进行赞/踩评价
+ */
 interface FeedbackUpdate {
-    /**
-     * Conversationid，会话ID
-     */
+    /** 会话ID */
     conversationId: string;
-    /**
-     * Id，消息ID
-     */
+    /** 消息ID */
     id: string;
-    /**
-     * Msgfeedback，反馈类型：1-赞，2-踩
-     */
+    /** 反馈类型：1-赞 2-踩 */
     msgFeedback: number;
-    /**
-     * Msgfeedbackcontent，消息反馈内容
-     */
+    /** 反馈内容描述，非必填 */
     msgFeedbackContent?: string;
 }
+/**
+ * 消息发送参数接口
+ * 定义发送消息时所需的全部参数
+ */
 interface ConversationMessageSend {
-    /**
-     * Conversationid，会话 ID
-     */
+    /** 会话ID */
     conversationId: string;
-    /**
-     * Msgcontent，消息内容
-     */
+    /** 消息内容 */
     msgContent: string;
-    /**
-     * Msgfiles，附件文件列表
-     */
+    /** 附件文件列表 */
     msgFiles?: InputFile[];
-    /**
-     * Params，业务参数,透传到智能体
-     */
+    /** 业务参数，透传到智能体的JSON字符串 */
     params?: string;
-    /**
-     * Quotemsgid，引用的消息 ID，大于 0 的整数
-     */
+    /** 引用的消息ID，大于0的整数 */
     quoteMsgId?: number;
-    /**
-     * Receiverid，接收者 ID。当 receiverType ≠ 3（非 agent）时，后端需填充此字段
-     */
+    /** 接收者ID，当receiverType≠3时由后端填充 */
     receiverId: string;
-    /**
-     * Receivertype，接收者身份，必填：1-用户；2-专家；3-agent 4-税协
-     */
+    /** 接收者类型：1-用户 2-专家 3-agent 4-税协 */
     receiverType: number;
-    /**
-     * Returntype，返回方式：1-http；2-ws（WebSocket）
-     */
+    /** 返回方式：1-http 2-WebSocket */
     returnType: number;
-    /**
-     * Senderid，发送者 ID
-     */
+    /** 发送者ID */
     senderId: string;
-    /**
-     * Sendertype，发送者身份，必填：1-用户；2-专家；3-agent 4-税协
-     */
+    /** 发送者类型：1-用户 2-专家 3-agent 4-税协 */
     senderType: number;
-    /**
-     * Source，会话来源: 1-罗拉-APP; 2-罗拉-pc端; 3-合作伙伴端 4-税协 5-罗拉-cube 6-api
-     */
+    /** 会话来源：1-罗拉-APP 2-罗拉-pc端 3-合作伙伴端 4-税协 5-罗拉-cube 6-api */
     source: number;
-    /**
-     * Stream，是否启用流式返回响应结果
-     */
+    /** 是否启用流式返回 */
     stream: boolean;
 }
 /**
- * FileUploadConfig，文件上传配置
+ * 文件上传配置接口
+ * 定义智能体的文件上传规则
  */
 interface FileUploadConfig {
-    /**
-     * Allowedfiletypes，允许的文件类型
-     */
+    /** 允许的文件类型列表（MIME类型或扩展名） */
     allowedFileTypes: string[];
-    /**
-     * Enabled，是否启用文件上传
-     */
+    /** 是否启用文件上传功能 */
     enabled: boolean;
-    /**
-     * Maxfilecount，最大文件数量
-     */
+    /** 单次上传最大文件数量 */
     maxFileCount: number;
-    /**
-     * Maxfilesize，最大文件大小
-     */
+    /** 单个文件最大大小（字节） */
     maxFileSize?: number;
 }
 /**
- * QuestionBO，推荐问题或热门问题项
+ * 推荐问题接口
+ * 定义单个推荐问题的结构
  */
 interface RecommendQuestion {
-    /**
-     * Id，问题 ID
-     */
+    /** 问题ID */
     id: number;
-    /**
-     * Question，问题内容
-     */
+    /** 问题内容 */
     question: string;
 }
 /**
- * LabelBO，热门问题标签
+ * 热门问题标签接口
+ * 定义热门问题的分类标签
  */
 interface HotQuestionList {
-    /**
-     * Id，标签 ID
-     */
+    /** 标签ID */
     id: number;
-    /**
-     * Items，标签下的问题列表
-     */
+    /** 标签下的问题列表 */
     items: RecommendQuestion[];
-    /**
-     * Name，标签名称
-     */
+    /** 标签名称 */
     name: string;
 }
+/**
+ * 智能体配置接口
+ * 定义智能体的功能配置信息
+ */
 interface AgentConfig {
-    /**
-     * 文件上传配置
-     */
+    /** 文件上传配置列表 */
     fileUpload?: FileUploadConfig[];
-    /**
-     * Labels，热门问题标签列表
-     */
+    /** 热门问题标签列表 */
     labels?: HotQuestionList[];
-    /**
-     * Recommendquestions，推荐问题列表
-     */
+    /** 推荐问题列表 */
     recommendQuestions?: RecommendQuestion[];
 }
+/**
+ * 智能体信息接口
+ * 定义智能体的基本信息和配置
+ */
 interface AgentInfo {
-    /**
-     * Agentname，名称
-     */
+    /** 智能体名称 */
     agentName: string;
-    /**
-     * Agenttype，智能体类型
-     */
+    /** 智能体类型 */
     agentType: number;
-    /**
-     * 智能体的附带信息
-     */
+    /** 智能体的配置信息 */
     config: AgentConfig;
-    /**
-     * Description，描述
-     */
+    /** 智能体描述 */
     description?: string;
-    /**
-     * Id，主键
-     */
+    /** 智能体ID */
     id: string;
-    /**
-     * Isavailable，是否可用
-     */
+    /** 智能体是否可用 */
     isAvailable?: boolean;
-    /**
-     * Logo，logo
-     */
+    /** 智能体Logo地址 */
     logo: string;
+    /** 智能体特性配置，JSON字符串格式 */
     feature?: string;
 }
+/**
+ * 智能体性格接口
+ * 定义智能体的性格特征配置
+ */
 interface AgentCharacter {
-    /**
-     * Agentid，智能体ID
-     */
+    /** 智能体ID */
     agentId: number;
-    /**
-     * Charactername，性格名称
-     */
+    /** 性格名称 */
     characterName: string;
-    /**
-     * Detaillevel，详细程度：1-10
-     */
+    /** 详细程度评级：1-10 */
     detailLevel: number;
-    /**
-     * Humorlevel，幽默程度：1-10
-     */
+    /** 幽默程度评级：1-10 */
     humorLevel: number;
-    /**
-     * Id，id
-     */
+    /** 性格配置ID */
     id: number;
-    /**
-     * Logo，头像，存储图片路径
-     */
+    /** 性格头像图片路径 */
     logo: string;
-    /**
-     * Professionallevel，专业程度：1-10
-     */
+    /** 专业程度评级：1-10 */
     professionalLevel: number;
-    /**
-     * Selected，是否已选择
-     */
+    /** 是否为当前选择的性格 */
     selected: boolean;
-    /**
-     * Sex，性别：1-男，2-女
-     */
+    /** 性别设置：1-男 2-女 */
     sex: number;
 }
 /**
@@ -505,77 +465,177 @@ declare const createFileService: (request: ReturnType<typeof createRequest>) =>
     fileCreate: (fileContent: string, fileName?: string, targetFormat?: string) => Promise<void>;
 };
 
+/**
+ * 会话策略类型
+ * 1-最近会话：获取用户最近的会话继续对话
+ * 2-新会话：创建全新的会话开始对话
+ */
 type ConversationStrategy = 1 | 2;
+/**
+ * 引用内容接口
+ * 扩展消息引用信息，支持更多引用格式
+ */
 interface ReferencesContent extends MessageQuoteMsg {
+    /** 引用名称 */
     name?: string;
+    /** Markdown格式的引用内容 */
     markdown?: string;
+    /** 其他扩展属性 */
     [key: string]: any;
 }
+/**
+ * 引用类型接口
+ * 定义消息引用的各种类型和参数
+ */
 interface ReferencesType {
+    /** 引用类型：1-markdown引用（拼正文发） 2-文案引用（不发正文） 3-消息引用 */
     type: number;
+    /** 引用内容 */
     content: ReferencesContent;
+    /** 引用参数 */
     params?: ObjectType<any>;
 }
+/**
+ * 聊天组件生命周期钩子接口
+ * 定义聊天组件在各种事件发生时的回调函数
+ */
 interface ChatHooks {
+    /** 初始化前回调 */
     onBeforeInit?: () => void;
+    /** 初始化后回调 */
     onAfterInit?: () => void;
+    /** 输入框聚焦回调 */
     onSenderFocus?: () => void;
+    /** 头部关闭回调 */
     onHeaderClose?: () => void;
+    /** 发送消息前回调，可阻止发送 */
     onBeforeSend?: (message: ConversationMessageSend['msgContent'], files: InputFile[]) => boolean | Promise<boolean> | void;
+    /** 发送消息后回调 */
     onAfterSend?: () => void;
+    /** 切换智能体前回调，可阻止切换 */
     onBeforeSwitchAgent?: (agentId: string) => boolean | Promise<boolean> | void;
+    /** 切换智能体后回调 */
     onAfterSwitchAgent?: (agent: AgentInfo) => void;
+    /** 切换会话前回调，可阻止切换 */
     onBeforeSwitchConversation?: (conversationId: string) => boolean | Promise<boolean> | void;
+    /** 切换会话后回调 */
     onAfterSwitchConversation?: (conversationId: string) => void;
+    /** 初始化消息前回调，可阻止初始化 */
     onBeforeInitMessages?: (conversationId: string) => boolean | Promise<boolean> | void;
+    /** 初始化消息后回调 */
     onAfterInitMessages?: (messages: ConversationMessage[]) => void;
+    /** 删除会话前回调，可阻止删除 */
     onBeforeDelConversation?: (conversationId: string) => boolean | Promise<boolean> | void;
+    /** 删除会话后回调 */
     onAfterDelConversation?: (conversationId: string, isCurrentConversation: boolean) => void;
 }
+/**
+ * 聊天参数接口
+ * 定义聊天组件的运行时参数
+ */
 interface ChatParams {
+    /** 会话来源 */
     source?: number;
+    /** 业务扩展数据，JSON字符串格式 */
     businessData?: string;
+    /** 业务数据唯一ID */
     businessId?: string;
+    /** 业务类型 */
     businessType?: number;
+    /** 扩展参数对象 */
     params?: ObjectType<any>;
 }
+/**
+ * 聊天布局头部配置接口
+ * 控制聊天头部区域的显示和功能
+ * 默认 title = true, closeBtn = false, newConversationBtn = true, conversationListBtn = true
+ */
 interface ChatLayoutHeader {
+    /** 头部标题渲染控制 */
     title?: RenderControl<void, void>;
+    /** 是否显示关闭按钮 */
     closeBtn?: boolean;
+    /** 新建会话按钮渲染控制 */
     newConversationBtn?: RenderControl<void, void>;
+    /** 是否显示智能体性格选择 */
     agentCharacter?: boolean;
+    /** 是否显示会话列表按钮 */
     conversationListBtn?: boolean;
 }
+/**
+ * 聊天布局会话列表配置接口
+ * 控制会话列表区域的显示和功能
+ * 默认 header = true
+ */
 interface ChatLayoutConversationList {
+    /** 会话列表头部渲染控制 */
     header?: RenderControl<void, void>;
 }
+/**
+ * 聊天布局输入框配置接口
+ * 控制输入框区域的功能和样式
+ * 默认 placeholder, extraBtn = false, referencesBtn = false
+ */
 interface ChatLayoutSender {
+    /** 输入框占位符文本 */
     placeholder?: string;
+    /** 额外按钮渲染控制 */
     extraBtn?: RenderControl<void, void>;
+    /** 引用按钮渲染控制 */
     referencesBtn?: RenderControl<void, void>;
+    /** 底部额外内容渲染控制 */
     footerBelow?: RenderControl<void, void>;
+    /** 发送按钮属性配置函数 */
     sendBtnProps?: () => ButtonProps;
+    /** 是否显示推荐问题 */
     prompts?: boolean;
 }
+/**
+ * 聊天布局消息列表配置接口
+ * 控制消息列表区域的显示和功能
+ */
 interface ChatLayoutMessageList {
+    /** 头像显示控制：可以是全局布尔值或按成员类型分别控制 */
     avatar?: boolean | Partial<Record<ConversationMemberEnum, boolean>>;
+    /** 首条消息渲染控制 */
     firstMessage?: RenderControl<void, void>;
 }
+/**
+ * 聊天布局配置接口
+ * 控制聊天组件整体布局的显示和功能
+ */
 interface ChatLayout {
+    /** 左侧面板渲染控制 */
     leftPanel?: RenderControl<void, void>;
+    /** 会话列表面板渲染控制 */
     conversationList?: RenderControl<void, ChatLayoutConversationList>;
+    /** 是否允许预览功能 */
     preview?: boolean;
+    /** 消息列表渲染控制 */
     messageList?: RenderControl<void, ChatLayoutMessageList>;
+    /** 输入框头部渲染控制 */
     senderHeader?: RenderControl<void, void>;
+    /** 输入框渲染控制 */
     sender?: RenderControl<void, ChatLayoutSender>;
+    /** 输入框底部渲染控制 */
     senderFooter?: RenderControl<void, void>;
+    /** 全局头部渲染控制 */
     globalHeader?: RenderControl<void, ChatLayoutHeader>;
+    /** 聊天区域头部渲染控制 */
     chatHeader?: RenderControl<void, ChatLayoutHeader>;
+    /** 免责声明渲染控制 */
     disclaimerNotice?: RenderControl<void, void>;
 }
+/**
+ * 聊天服务接口
+ * 定义聊天组件所需的服务配置
+ */
 interface ChatServices {
+    /** WebSocket连接基础URL列表，支持多地址容错 */
     websocketBaseUrls?: string[];
+    /** API基础URL */
     baseUrl?: string;
+    /** 聊天服务和文件服务的合并请求对象 */
     request?: ReturnType<typeof createChatService> & ReturnType<typeof createFileService>;
 }
 
@@ -659,33 +719,71 @@ interface SenderProps {
 }
 declare const _default$2: react.ForwardRefExoticComponent<SenderProps & react.RefAttributes<ChatSenderHandle>>;
 
+/**
+ * 聊天组件配置接口
+ * 定义聊天组件的初始化配置选项
+ */
 interface ChatConfig {
+    /** 接收者类型：1-用户 2-专家 3-Agent */
     receiverType?: number;
+    /** 接收者ID：专家或智能体ID */
     receiverId?: string;
+    /** 会话ID：已存在的会话ID */
     conversationId?: string;
+    /** 会话策略：1-最近会话 2-新会话 */
     conversationStrategy?: ConversationStrategy;
 }
+/**
+ * 聊天组件操作句柄接口
+ * 提供外部操作聊天组件的方法
+ */
 interface ChatHandle {
+    /** 发送消息 */
     sendMessage: (message?: string, files?: InputFile[]) => void;
+    /** 切换智能体会话 */
     switchAgentConversation: (agentId: AgentInfo['id'], strategy?: ConversationStrategy) => Promise<void>;
+    /** 切换会话 */
     switchConversation: (id?: Conversation['id']) => Promise<void>;
+    /** 创建新会话 */
     createConversation: () => Promise<void>;
+    /** 设置引用消息 */
     setReferences: (references?: ReferencesType) => void;
+    /** 设置输入框消息内容 */
     setMessage: (message?: string) => void;
+    /** 设置上传文件列表 */
     setFiles: (files?: InputFile[]) => void;
+    /** 设置聊天参数 */
     setParams: (params?: ChatParams) => void;
+    /** 设置服务配置 */
     setServices: (services?: ChatServices) => void;
+    /** 输入框聚焦 */
     senderFocus: ChatSenderHandle['focus'];
 }
+/**
+ * 聊天组件属性接口
+ * 定义聊天组件的输入属性
+ */
 interface ChatProps {
+    /** 主题配置 */
     theme?: ThemeConfig;
+    /** 聊天配置 */
     config?: ChatConfig;
+    /** 聊天参数 */
     params?: ChatParams;
+    /** 生命周期钩子 */
     hooks?: ChatHooks;
+    /** 布局配置 */
     layout?: ChatLayout;
+    /** 用户信息 */
     userInfo?: UserInfo;
+    /** 服务配置 */
     services?: ChatServices;
 }
+/**
+ * 聊天组件
+ * 使用 React.forwardRef 实现的聊天界面组件
+ * 集成了消息收发、会话管理、文件预览等功能
+ */
 declare const _default$1: react.ForwardRefExoticComponent<ChatProps & react.RefAttributes<ChatHandle>>;
 
 /**
@@ -703,4 +801,4 @@ interface MessageRenderProps {
  */
 declare const _default: ({ message, placement }: MessageRenderProps) => react_jsx_runtime.JSX.Element;
 
-export { type AgentInfo, _default$3 as Attachments, type AttachmentsProps, type ChatConfig, _default$1 as ChatCopilot, type ChatHandle, type ChatHooks, type ChatLayout, type ChatParams, type ChatProps, _default$2 as ChatSender, type ConversationStrategy, type InputFile, _default as MessageRender, type MessageRenderProps, type ReferencesType, type SenderProps };
+export { type AgentInfo, _default$3 as Attachments, type AttachmentsProps, type ChatConfig, _default$1 as ChatCopilot, type ChatHandle, type ChatHooks, type ChatLayout, type ChatParams, type ChatProps, _default$2 as ChatSender, type ChatServices, type ConversationStrategy, type InputFile, _default as MessageRender, type MessageRenderProps, type ReferencesType, type SenderProps, type UserInfo };