@zero-library/chat-agent 2.0.10 → 2.1.1

package/dist/index.d.ts

@@ -1,64 +1,286 @@
-import { RenderControl } from '@zero-library/common';
+import { RenderControl, UserInfo } from '@zero-library/common';
 import * as react from 'react';
 import { Conversation } from '@ant-design/x';
 import { ThemeConfig } from 'antd';
 
-type FileMode = 'local' | 'remote';
+type ConversationMemberEnum = 'agent' | 'user' | 'other';
+
 interface InputFile {
+    /**
+     * Content，文件内容
+     */
+    content: string;
+    /**
+     * 文件模式 remote_url local_file
+     */
+    mode: string;
+    /**
+     * Type，文件类型
+     */
     type: string;
-    mode: FileMode;
+    /**
+     * 文件扩展名
+     */
+    extension: string;
+    /**
+     * 文件名
+     */
     name: string;
+}
+interface MessageQuoteMsg {
+    /**
+     * Id，消息ID
+     */
+    id?: string;
+    /**
+     * Msgcontent，消息内容
+     */
+    msgContent?: string;
+    /**
+     * Msgfiles，附件文件列表
+     */
+    msgFiles?: InputFile;
+}
+interface MessageSender {
+    /**
+     * Curruser，是否为当前用户
+     */
+    currUser?: boolean;
+    /**
+     * Id，发送者ID
+     */
     id: string;
-    url: string;
+    /**
+     * Type，1-用户 2-专家 3-Agent  4-税协
+     */
+    type: number;
 }
-/** Agent状态 */
-type MessageType = 'TEXT_MESSAGE_START' | 'TEXT_MESSAGE_CONTENT' | 'TEXT_MESSAGE_END' | 'RUN_STARTED' | 'RUN_FINISHED' | 'RUN_ERROR' | 'STEP_STARTED' | 'STEP_FINISHED';
-interface AgentBaseMessageEvent {
+interface ConversationMessage {
+    /**
+     * Conversationid，会话ID
+     */
     conversationId: string;
-    type: MessageType | string;
+    conversationTitle?: string;
+    type?: 'TEXT_MESSAGE_START' | 'STEP_STARTED' | 'TEXT_MESSAGE_CONTENT' | 'TEXT_MESSAGE_END';
+    /**
+     * Id，消息ID
+     */
+    id: string;
+    /**
+     * Msgcontent，消息内容
+     */
+    msgContent: string;
+    /**
+     * Msgfeedback，消息反馈
+     */
+    msgFeedback?: number;
+    /**
+     * Msgfiles，附件文件列表
+     */
+    msgFiles?: InputFile[];
+    /**
+     * 引消息
+     */
+    quoteMsg?: MessageQuoteMsg;
+    /**
+     * 发送者信息
+     */
+    sender?: MessageSender;
+    /**
+     * Sendtime，发送时间
+     */
+    sendTime: number;
+    /**
+     * Stopflag，是否打断
+     */
+    stopFlag?: boolean;
 }
-interface AgentBaseMessageEvent {
-    code: number;
+interface ConversationMessageSend {
+    /**
+     * Conversationid，会话 ID
+     */
     conversationId: string;
-    type: MessageType | string;
+    /**
+     * Msgcontent，消息内容
+     */
+    msgContent: string;
+    /**
+     * Msgfiles，附件文件列表
+     */
+    msgFiles?: InputFile[];
+    /**
+     * Params，业务参数,透传到智能体
+     */
+    params?: string;
+    /**
+     * Quotemsgid，引用的消息 ID，大于 0 的整数
+     */
+    quoteMsgId?: number;
+    /**
+     * Receiverid，接收者 ID。当 receiverType ≠ 3（非 agent）时，后端需填充此字段
+     */
+    receiverId: string;
+    /**
+     * Receivertype，接收者身份，必填：1-用户；2-专家；3-agent 4-税协
+     */
+    receiverType: number;
+    /**
+     * Returntype，返回方式：1-http；2-ws（WebSocket）
+     */
+    returnType: number;
+    /**
+     * Senderid，发送者 ID
+     */
+    senderId: string;
+    /**
+     * Sendertype，发送者身份，必填：1-用户；2-专家；3-agent 4-税协
+     */
+    senderType: number;
+    /**
+     * Source，会话来源: 1-罗拉-APP; 2-罗拉-pc端; 3-合作伙伴端 4-税协 5-罗拉-cube 6-api
+     */
+    source: number;
+    /**
+     * Stream，是否启用流式返回响应结果
+     */
+    stream: boolean;
 }
-interface SendChatMessage {
-    agentId?: string;
-    conversationId?: string;
-    message: string;
-    files?: InputFile[];
-    params?: ObjectType<any>;
-    bizId?: string;
-    onMessageEvent?: (event: AgentBaseMessageEvent) => void;
+/**
+ * FileUploadConfig，文件上传配置
+ */
+interface FileUploadConfig {
+    /**
+     * Allowedfiletypes，允许的文件类型
+     */
+    allowedFileTypes: string[];
+    /**
+     * Enabled，是否启用文件上传
+     */
+    enabled: boolean;
+    /**
+     * Maxfilecount，最大文件数量
+     */
+    maxFileCount: number;
+    /**
+     * Maxfilesize，最大文件大小
+     */
+    maxFileSize?: number;
+}
+/**
+ * QuestionBO，推荐问题或热门问题项
+ */
+interface RecommendQuestion {
+    /**
+     * Id，问题 ID
+     */
+    id: number;
+    /**
+     * Question，问题内容
+     */
+    question: string;
+}
+/**
+ * LabelBO，热门问题标签
+ */
+interface HotQuestionList {
+    /**
+     * 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: string;
+    /**
+     * Isavailable，是否可用
+     */
+    isAvailable?: boolean;
+    /**
+     * Logo，logo
+     */
+    logo: string;
+    feature?: string;
 }
 
+type ConversationStrategy = 1 | 2;
+interface ReferencesContent extends MessageQuoteMsg {
+    name?: string;
+    markdown?: string;
+    [key: string]: any;
+}
 interface ReferencesType {
     type: number;
-    content: {
-        name?: string;
-        markdown?: string;
-        [key: string]: any;
-    };
+    content: ReferencesContent;
     params?: ObjectType<any>;
 }
 interface ChatHooks {
+    onBeforeInit?: () => void;
+    onAfterInit?: () => void;
     onSenderFocus?: () => void;
     onHeaderClose?: () => void;
-    onBeforeSend?: (message: SendChatMessage['message'], files: InputFile[]) => boolean | Promise<boolean> | void;
+    onBeforeSend?: (message: ConversationMessageSend['msgContent'], files: InputFile[]) => boolean | Promise<boolean> | void;
     onAfterSend?: () => void;
     onBeforeSwitchAgent?: (agentId: string) => boolean | Promise<boolean> | void;
     onAfterSwitchAgent?: (agentId: string) => void;
-    onBeforeSwitchConversation?: (conversationId: string, isNew: boolean) => boolean | Promise<boolean> | void;
-    onAfterSwitchConversation?: (conversationId: string, isNew: boolean) => 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 {
-    bizId?: string;
+    source?: number;
+    businessData?: string;
+    businessId?: string;
+    businessType?: number;
     params?: ObjectType<any>;
 }
 interface ChatLayoutHeader {
     title?: RenderControl<void, void>;
     closeBtn?: boolean;
     newConversationBtn?: RenderControl<void, void>;
+    agentCharacter?: boolean;
     conversationListBtn?: boolean;
 }
 interface ChatLayoutConversationList {
@@ -69,11 +291,15 @@ interface ChatLayoutSender {
     extraBtn?: RenderControl<void, void>;
     referencesBtn?: RenderControl<void, void>;
 }
+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?: boolean;
+    messageList?: RenderControl<void, ChatLayoutMessageList>;
     senderHeader?: RenderControl<void, void>;
     sender?: RenderControl<void, ChatLayoutSender>;
     senderPrompts?: boolean;
@@ -83,31 +309,28 @@ interface ChatLayout {
     disclaimerNotice?: RenderControl<void, void>;
 }
 
+interface ChatConfig {
+    receiverType?: number;
+    receiverId?: string;
+    conversationId?: string;
+    conversationStrategy?: ConversationStrategy;
+}
 interface Props {
     theme?: ThemeConfig;
-    defaultAgent?: {
-        appKey?: string;
-        agentKey?: string;
-        conversationId?: string;
-    };
+    config?: ChatConfig;
     params?: ChatParams;
     hooks?: ChatHooks;
     layout?: ChatLayout;
+    userInfo?: UserInfo;
 }
 interface ChatHandle {
-    sendMessage: (message?: string, files?: InputFile[]) => Promise<void>;
-    switchAgent: ({ appKey, agentKey, isVerify }: {
-        appKey: string;
-        agentKey: string;
-        isVerify: boolean;
-    }, conversationId?: Conversation['key']) => Promise<void>;
-    switchConversation: (conversation?: Conversation) => Promise<void>;
+    sendMessage: (message?: string, files?: InputFile[]) => void;
+    switchAgentConversation: (agentId: AgentInfo['id'], strategy?: ConversationStrategy) => void;
+    switchConversation: (id?: Conversation['id']) => void;
     setReferences: (references?: ReferencesType) => void;
     setMessage: (message?: string) => void;
     setFiles: (files?: InputFile[]) => void;
-    setParams: (params: Props['params']) => void;
-    setLayout: (layout: Props['layout']) => void;
 }
 declare const _default: react.ForwardRefExoticComponent<Props & react.RefAttributes<ChatHandle>>;
 
-export { _default as AgentChat, type ChatHandle, type ChatLayout };
+export { type ChatConfig, _default as ChatCopilot, type ChatHandle, type ChatLayout };