@kweaver-ai/chatkit 0.1.17 → 0.1.18

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 /**
  * 角色类型枚举
- * 发送该消息的角色
+ * 发送该消息的角�?
  */
 export declare enum RoleType {
     /** 用户 */
@@ -11,7 +11,7 @@ export declare enum RoleType {
 }
 /**
  * 消息类型枚举
- * 消息的类型
+ * 消息的类�?
  */
 export declare enum ChatMessageType {
     /** Markdown 文本类型 */
@@ -22,7 +22,7 @@ export declare enum ChatMessageType {
     WIDGET = "Widget"
 }
 /**
- * 消息块类型枚举
+ * 消息块类型枚�?
  * 消息块的类型，不同类型的消息块使用不同的组件进行渲染
  */
 export declare enum BlockType {
@@ -36,6 +36,8 @@ export declare enum BlockType {
     TOOL = "Tool",
     /** JSON2Plot 图表类型 */
     JSON2PLOT = "Json2Plot",
+    /** WebProcessor 页面预览类型 */
+    WEB_PROCESSOR = "WebProcessor",
     /** Text2SQL 类型 */
     Text2Sql = "Text2Sql"
 }
@@ -45,17 +47,17 @@ export declare enum BlockType {
  */
 export interface Role {
     /** 角色的名称：
-     * - 如果 type 是 Assistant，则名称为 "AI 助手"
-     * - 如果 type 是 User，则名称为用户的昵称/显示名
+     * - 如果 type �?Assistant，则名称�?"AI 助手"
+     * - 如果 type �?User，则名称为用户的昵称/显示�?
      */
     name: string;
-    /** 发送该消息的角色 */
+    /** 发送该消息的角�?*/
     type: RoleType;
-    /** 角色的头像，可以是 URL、Base64 或 SVG */
+    /** 角色的头像，可以�?URL、Base64 �?SVG */
     avatar: string;
 }
 /**
- * 消息块基类
+ * 消息块基�?
  * 一条消息可以由许多不同类型的消息块组成
  */
 export interface ContentBlock<T extends BlockType, K> {
@@ -63,7 +65,7 @@ export interface ContentBlock<T extends BlockType, K> {
     type: T;
     /** 消息块的内容 */
     content: K;
-    /** 耗时（毫秒），可选字段 */
+    /** 耗时（毫秒），可选字�?*/
     consumeTime?: number;
 }
 /**
@@ -96,8 +98,8 @@ export interface ToolBlockRegistration {
     /** 工具图标，React 元素 */
     Icon?: React.ReactNode;
     /** 工具点击事件
-     * @param block 工具块数据，类型为 Record<string, any>
-     * @returns 可选返回关闭函数；切换工具块时 SDK 会先调用该函数，用于关闭本次打开的外层内容
+     * @param block 工具块数据，类型�?Record<string, any>
+     * @returns 可选返回关闭函数；切换工具块时 SDK 会先调用该函数，用于关闭本次打开的外层内�?
      */
     onClick?: (block: Record<string, any>) => void | (() => void);
 }
@@ -106,58 +108,74 @@ export interface ToolBlockRegistration {
  */
 export interface Json2PlotBlock extends ContentBlock<BlockType.JSON2PLOT, ChartDataSchema> {
 }
+/**
+ * WebProcessor 页面预览数据 Schema
+ */
+export interface WebProcessorDataSchema {
+    /** 页面标题 */
+    title?: string;
+    /** 页面 URL */
+    url: string;
+    /** 页面尺寸，[width, height] */
+    size?: [number, number];
+}
+/**
+ * WebProcessor 页面预览类型的消息块
+ */
+export interface WebProcessorBlock extends ContentBlock<BlockType.WEB_PROCESSOR, WebProcessorDataSchema> {
+}
 /**
  * 单条消息的扩展上下文（不参与流式内容渲染，用于相关问题、耗时、Token 等）
  */
 export interface MessageContext {
-    /** 相关推荐问题列表，来自 message.ext.related_queries */
+    /** 相关推荐问题列表，来�?message.ext.related_queries */
     relatedQuestions?: string[];
-    /** 本次回答耗时（秒），用于展示「耗时: xx.xxs」 */
+    /** 本次回答耗时（秒），用于展示「耗时: xx.xxs�?*/
     elapsedSeconds?: number;
-    /** Token 总数，用于展示「Token: x,xxx」 */
+    /** Token 总数，用于展示「Token: x,xxx�?*/
     totalTokens?: number;
 }
 /**
  * 消息接口
- * 展示在消息区消息列表中的一条消息
+ * 展示在消息区消息列表中的一条消�?
  */
 export interface ChatMessage {
     /** 一条消息的 ID */
     messageId: string;
-    /** 发送该消息的角色 */
+    /** 发送该消息的角�?*/
     role: Role;
-    /** 该条消息的类型（已废弃，保留用于向后兼容） */
+    /** 该条消息的类型（已废弃，保留用于向后兼容�?*/
     type?: ChatMessageType;
     /** 该条消息的内容。一条消息可以由许多不同类型的消息块组成 */
-    content: Array<TextBlock | MarkdownBlock | WebSearchBlock | ToolBlock | Json2PlotBlock>;
-    /** 与该消息关联的应用上下文（可选），仅用户消息可能包含此字段 */
+    content: Array<TextBlock | MarkdownBlock | WebSearchBlock | ToolBlock | Json2PlotBlock | WebProcessorBlock>;
+    /** 与该消息关联的应用上下文（可选），仅用户消息可能包含此字�?*/
     applicationContext?: ApplicationContext;
     /** 消息扩展上下文：相关问题、耗时、Token 等，仅助手消息在流结束后可能包含 */
     messageContext?: MessageContext;
 }
 /**
- * 应用上下文接口
+ * 应用上下文接�?
  * 与用户输入的文本相关的应用上下文
  */
 export interface ApplicationContext {
     /** 显示在输入框上方的应用上下文标题 */
     title: string;
-    /** 该应用上下文实际包含的数据 */
+    /** 该应用上下文实际包含的数�?*/
     data: any;
 }
 /**
  * EventStream 消息接口
- * 表示从 SSE 接收到的一条流式消息
+ * 表示�?SSE 接收到的一条流式消�?
  */
 export interface EventStreamMessage {
     /** 事件类型 */
     event: string;
-    /** 消息数据,通常是 JSON 字符串 */
+    /** 消息数据,通常�?JSON 字符�?*/
     data: string;
 }
 /**
  * 开场白信息接口
- * 包含开场白文案和预置问题
+ * 包含开场白文案和预置问�?
  */
 export interface OnboardingInfo {
     /** 开场白文案 */
@@ -167,23 +185,23 @@ export interface OnboardingInfo {
 }
 /**
  * Web 搜索结果接口
- * 单条 Web 搜索的结果
+ * 单条 Web 搜索的结�?
  */
 export interface WebSearchResult {
-    /** 搜索结果的内容摘要 */
+    /** 搜索结果的内容摘�?*/
     content: string;
-    /** 搜索结果的来源网站图标 URL */
+    /** 搜索结果的来源网站图�?URL */
     icon: string;
     /** 搜索结果的来源地址 */
     link: string;
-    /** 搜索结果的来源网站名称 */
+    /** 搜索结果的来源网站名�?*/
     media: string;
-    /** 搜索结果的来源文章标题 */
+    /** 搜索结果的来源文章标�?*/
     title: string;
 }
 /**
  * Web 搜索查询接口
- * 调用 Web 搜索的详情
+ * 调用 Web 搜索的详�?
  */
 export interface WebSearchQuery {
     /** 搜索查询 */
@@ -196,20 +214,20 @@ export interface WebSearchQuery {
  * 代码执行的输入和输出信息
  */
 export interface ExecuteCodeResult {
-    /** 执行的代码，以 Markdown 的代码格式显示 */
+    /** 执行的代码，�?Markdown 的代码格式显�?*/
     input: string;
-    /** 代码执行后转为自然语言的输出结果，以 Markdown 格式显示 */
+    /** 代码执行后转为自然语言的输出结果，�?Markdown 格式显示 */
     output: string;
 }
 /**
  * Text2SQL 结果接口
  * Text2SQL 工具的输入和输出信息
- * 根据 OpenAPI 规范，answer 包含 result 和 full_result
- * - result: Text2SqlResultData（包含 data_desc，但可能只有数据样本）
- * - full_result: Text2SqlFullResultData（包含完整数据，但没有 data_desc）
+ * 根据 OpenAPI 规范，answer 包含 result �?full_result
+ * - result: Text2SqlResultData（包�?data_desc，但可能只有数据样本�?
+ * - full_result: Text2SqlFullResultData（包含完整数据，但没�?data_desc�?
  */
 export interface Text2SqlResult {
-    /** 输入的查询文本 */
+    /** 输入的查询文�?*/
     title: string;
     data: Array<Record<string, any>>;
     sql: string;
@@ -217,16 +235,16 @@ export interface Text2SqlResult {
 /**
  * Text2Metric 结果接口
  * Text2Metric 工具的输入和输出信息
- * 根据 OpenAPI 规范，answer 包含 result 和 full_result
- * - result: Text2MetricResultData（包含 data_desc，但可能只有数据样本）
- * - full_result: Text2MetricFullResultData（包含完整数据，但没有 data_desc）
+ * 根据 OpenAPI 规范，answer 包含 result �?full_result
+ * - result: Text2MetricResultData（包�?data_desc，但可能只有数据样本�?
+ * - full_result: Text2MetricFullResultData（包含完整数据，但没�?data_desc�?
  */
 export interface Text2MetricResult {
     /** 结果标题 */
     title: string;
     /** 查询结果数据 */
     data: Array<Record<string, any>>;
-    /** 查询参数（args） */
+    /** 查询参数（args�?*/
     args: any;
 }
 /**
@@ -248,7 +266,7 @@ export interface DataCatalogCite {
 /**
  * AfSailor 结果接口
  * AfSailor 工具的输入和输出信息
- * 根据 ChatKit.pdf 4.24 AfSailorResult 和 OpenAPI 规范定义
+ * 根据 ChatKit.pdf 4.24 AfSailorResult �?OpenAPI 规范定义
  */
 export interface AfSailorResult {
     /** 查询结果数据 */
@@ -273,13 +291,13 @@ export interface DataCatalogMatch {
     id: string;
     /** 匹配原因 */
     reason?: string;
-    /** 匹配的列信息，键为字段技术名称，值为字段值 */
+    /** 匹配的列信息，键为字段技术名称，值为字段�?*/
     matched_columns?: Array<Record<string, string>>;
 }
 /**
  * DatasourceFilter 结果接口
  * DatasourceFilter 工具的输入和输出信息
- * 根据 OpenAPI 规范和设计文档定义
+ * 根据 OpenAPI 规范和设计文档定�?
  */
 export interface DatasourceFilterResult {
     /** 数据目录匹配结果列表 */
@@ -289,7 +307,7 @@ export interface DatasourceFilterResult {
 }
 /**
  * DatasourceRerank 结果接口
- * DatasourceRerank 工具的输入和输出信息，与 DatasourceFilter 处理方式一致
+ * DatasourceRerank 工具的输入和输出信息，与 DatasourceFilter 处理方式一�?
  */
 export interface DatasourceRerankResult {
     /** 数据目录重排结果列表 */
@@ -316,18 +334,18 @@ export interface DefaultToolResult {
 export interface ToolCallData {
     /** 工具名称 */
     name: string;
-    /** 工具图标 URL 或 React 元素 */
+    /** 工具图标 URL �?React 元素 */
     icon?: string | React.ReactNode;
     /** 工具标题 */
     title: string;
-    /** 工具调用的输入参数 */
+    /** 工具调用的输入参�?*/
     input?: any;
-    /** 工具调用的输出结果 */
+    /** 工具调用的输出结�?*/
     output?: any;
 }
 /**
  * 历史会话记录接口
- * 一条历史会话记录
+ * 一条历史会话记�?
  */
 export interface ConversationHistory {
     /** 会话 ID */
@@ -338,99 +356,99 @@ export interface ConversationHistory {
     created_at: number;
     /** 会话最后更新时间（Unix 时间戳） */
     updated_at: number;
-    /** 最新会话消息下标 */
+    /** 最新会话消息下�?*/
     message_index?: number;
     /** 最新已读的会话消息下标 */
     read_message_index?: number;
 }
 /**
  * ChatKit 接口
- * 定义了 ChatKit 的一些抽象方法
+ * 定义�?ChatKit 的一些抽象方�?
  */
 export interface ChatKitInterface {
     /**
-     * 获取开场白和预置问题
-     * 该方法需要由子类继承并重写，以适配扣子、Dify 等 LLMOps 平台的接口
-     * 返回开场白信息结构体
+     * 获取开场白和预置问�?
+     * 该方法需要由子类继承并重写，以适配扣子、Dify �?LLMOps 平台的接�?
+     * 返回开场白信息结构�?
      * 注意：该方法是一个无状态无副作用的函数，不允许修改 state
-     * @returns 返回开场白信息，包含开场白文案和预置问题
+     * @returns 返回开场白信息，包含开场白文案和预置问�?
      */
     getOnboardingInfo(): Promise<OnboardingInfo>;
     /**
      * 新建会话
-     * 该方法需要由子类继承并重写，以适配扣子、Dify 等 LLMOps 平台的接口
+     * 该方法需要由子类继承并重写，以适配扣子、Dify �?LLMOps 平台的接�?
      * 成功返回会话 ID
      * 注意：该方法是一个无状态无副作用的函数，不允许修改 state
-     * @param title 会话标题，通常是用户发送的第一条消息内容
+     * @param title 会话标题，通常是用户发送的第一条消息内�?
      * @returns 返回新创建的会话 ID
      */
     generateConversation(title?: string): Promise<string>;
     /**
-     * 向后端发送消息
-     * 该方法需要由开发者实现，以适配扣子、Dify等 LLMOps 平台的接口
+     * 向后端发送消�?
+     * 该方法需要由开发者实现，以适配扣子、Dify�?LLMOps 平台的接�?
      * 发送成功后，返回发送的消息结构
      * @param text 发送给后端的用户输入的文本
-     * @param ctx 随用户输入文本一起发送的应用上下文
+     * @param ctx 随用户输入文本一起发送的应用上下�?
      * @param conversationID 发送的对话消息所属的会话 ID
-     * @param regenerateMessageId 需要重新生成的助手消息 ID（可选，用于重新生成功能）
+     * @param regenerateMessageId 需要重新生成的助手消息 ID（可选，用于重新生成功能�?
      * 注意：该方法是一个无状态无副作用的函数，不允许修改 state
      * @param text 发送给后端的用户输入的文本
-     * @param ctx 随用户输入文本一起发送的应用上下文
+     * @param ctx 随用户输入文本一起发送的应用上下�?
      * @param conversationID 发送的对话消息所属的会话 ID
      * @returns 返回发送的消息结构
      */
     sendMessage(text: string, ctx: ApplicationContext, conversationID?: string, regenerateMessageId?: string): Promise<ChatMessage>;
     /**
-     * 将 API 接口返回的 EventStream 增量解析成完整的 AssistantMessage 对象
+     * �?API 接口返回�?EventStream 增量解析成完整的 AssistantMessage 对象
      * 当接收到 SSE 消息时触发，该方法需要由子类实现
-     * 子类在该方法中应该调用 appendMarkdownBlock()、appendWebSearchBlock()、appendToolBlock() 等来更新消息内容
-     * 注意：该方法应该只处理数据解析逻辑，通过调用 append*Block 方法来更新界面
-     * @param eventMessage 接收到的一条 Event Message
-     * @param prev 上一次增量更新后的 AssistantMessage 对象
-     * @param messageId 当前正在更新的消息 ID，用于调用 append*Block 方法
+     * 子类在该方法中应该调�?appendMarkdownBlock()、appendWebSearchBlock()、appendToolBlock() 等来更新消息内容
+     * 注意：该方法应该只处理数据解析逻辑，通过调用 append*Block 方法来更新界�?
+     * @param eventMessage 接收到的一�?Event Message
+     * @param prev 上一次增量更新后�?AssistantMessage 对象
+     * @param messageId 当前正在更新的消�?ID，用于调�?append*Block 方法
      * @returns 返回更新后的 AssistantMessage 对象
      */
     reduceAssistantMessage<T = any, K = any>(eventMessage: T, prev: K, messageId: string): K;
     /**
-     * 检查是否需要刷新 token
-     * 当发生异常时检查是否需要刷新 token。返回 true 表示需要刷新 token，返回 false 表示无需刷新 token。
-     * 该方法需要由子类继承并重写，以适配扣子、Dify 等 LLMOps 平台的接口。
-     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state。
+     * 检查是否需要刷�?token
+     * 当发生异常时检查是否需要刷�?token。返�?true 表示需要刷�?token，返�?false 表示无需刷新 token�?
+     * 该方法需要由子类继承并重写，以适配扣子、Dify �?LLMOps 平台的接口�?
+     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state�?
      * @param status HTTP 状态码
-     * @param error 错误响应体
-     * @returns 返回是否需要刷新 token
+     * @param error 错误响应�?
+     * @returns 返回是否需要刷�?token
      */
     shouldRefreshToken(status: number, error: any): boolean;
     /**
      * 终止会话
-     * 该方法需要由子类继承并重写，以适配扣子、Dify 等 LLMOps 平台的接口。
-     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state。
+     * 该方法需要由子类继承并重写，以适配扣子、Dify �?LLMOps 平台的接口�?
+     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state�?
      * @param conversationId 要终止的会话 ID
      * @returns 返回 Promise，成功时 resolve，失败时 reject
      */
     terminateConversation(conversationId: string): Promise<void>;
     /**
      * 获取历史会话列表
-     * 该方法需要由子类继承并重写，以适配扣子、Dify 等 LLMOps 平台的接口。
-     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state。
+     * 该方法需要由子类继承并重写，以适配扣子、Dify �?LLMOps 平台的接口�?
+     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state�?
      * @param page 分页页码，默认为 1
      * @param size 每页返回条数，默认为 10
      * @returns 返回历史会话列表
      */
     getConversations(page?: number, size?: number): Promise<ConversationHistory[]>;
     /**
-     * 获取指定会话 ID 的对话消息列表
-     * 该方法需要由子类继承并重写，以适配扣子、Dify 等 LLMOps 平台的接口。
-     * 如果对话消息是 AI 助手消息，则需要调用 reduceAssistantMessage() 解析消息。
-     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state。
+     * 获取指定会话 ID 的对话消息列�?
+     * 该方法需要由子类继承并重写，以适配扣子、Dify �?LLMOps 平台的接口�?
+     * 如果对话消息�?AI 助手消息，则需要调�?reduceAssistantMessage() 解析消息�?
+     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state�?
      * @param conversationId 会话 ID
      * @returns 返回对话消息列表
      */
     getConversationMessages(conversationId: string): Promise<ChatMessage[]>;
     /**
-     * 删除指定 ID 的会话
-     * 该方法需要由子类继承并重写，以适配扣子、Dify 等 LLMOps 平台的接口。
-     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state。
+     * 删除指定 ID 的会�?
+     * 该方法需要由子类继承并重写，以适配扣子、Dify �?LLMOps 平台的接口�?
+     * 注意：该方法是一个无状态无副作用的函数，不允许修改 state�?
      * @param conversationID 会话 ID
      * @returns 返回 Promise，成功时 resolve，失败时 reject
      */
@@ -438,18 +456,18 @@ export interface ChatKitInterface {
 }
 /**
  * 图表类型枚举
- * 支持的图表类型
+ * 支持的图表类�?
  */
 export type ChartType = 'Line' | 'Column' | 'Pie' | 'Circle';
 /**
- * 数据行
+ * 数据�?
  */
 export type DataRow = Record<string, any>;
 /**
  * 维度接口
  */
 export interface Dimension {
-    /** 字段名 */
+    /** 字段�?*/
     name: string;
     /** 显示名称 */
     displayName: string;
@@ -460,7 +478,7 @@ export interface Dimension {
  * 度量接口
  */
 export interface Measure {
-    /** 字段名 */
+    /** 字段�?*/
     name: string;
     /** 显示名称 */
     displayName: string;
@@ -481,7 +499,7 @@ export interface ChartDataSchema {
     dimensions: Dimension[];
     /** 度量列表 */
     measures: Measure[];
-    /** 数据行列表 */
+    /** 数据行列�?*/
     rows: DataRow[];
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kweaver-ai/chatkit",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "publishConfig": {
     "access": "public"
   },