@blueking/ai-blueking 0.3.0 → 0.3.2

package/README.md

@@ -1,5 +1,77 @@
 # AI 小鲸使用指南
 
+
+## 新特性
+
+- 支持 popup 弹框唤起
+- 支持引用提问功能
+- 支持快捷提问（当前支持翻译、解释功能）
+
+## 0.3.0 重大变更（Breaking Changes）
+
+### 1. 组件显示/隐藏方式变更
+
+- 不再使用 `v-if` 控制组件显示
+- 需要定义一个变量并使用 `v-model:is-show` 绑定到组件
+
+### 2. handleSend 回调参数变更
+
+回调函数现在接收一个对象参数，而不是简单的字符串。参数格式如下：
+
+```typescript
+interface ISendData {
+  content: string;  // 用户输入的内容
+  cite?: string;    // 引用的内容（可选）
+  prompt?: string;  // 使用的 prompt 模板（可选）
+}
+```
+
+## 使用示例
+
+以下展示了如何处理新的 handleSend 回调：
+
+```typescript
+const handleSend = (args: ISendData) => {
+  // 记录当前消息记录
+  const chatHistory = [...messages.value];
+
+  // 添加用户消息
+  messages.value.push({
+    role: 'user',
+    content: args.content,
+    cite: args.cite,
+  });
+
+  // 根据参数构造输入内容
+  const input = args.prompt 
+    ? args.prompt                           // 如果有 prompt，直接使用
+    : args.cite 
+      ? `${args.content}: ${args.cite}`     // 如果有 cite，拼接 content 和 cite
+      : args.content;                       // 否则只使用 content
+
+  // 调用 AI 流式对话
+  // 注：id 是唯一标识当前流，调用 chatHelper.stop 时需要传入
+  chatHelper.stream(
+    {
+      inputs: {
+        input,
+        chat_history: chatHistory,
+      },
+    },
+    1,
+  );
+};
+```
+
+## 注意事项
+
+- 使用 `v-model:is-show` 时需要提前定义对应的响应式变量
+- 处理 handleSend 回调时需要注意新的参数格式
+- 在调用 `chatHelper.stop` 方法时需要传入正确的流 ID
+
+
+
+
 ## 安装
 
 ```bash
@@ -50,6 +122,7 @@ npm i @blueking/ai-blueking
 ```vue
 <template>
   <AIBlueking
+    v-model:is-show="isShow"
     :loading="loading"
     :messages="messages"
     @clear="handleClear"
@@ -71,6 +144,7 @@ npm i @blueking/ai-blueking
 
   const loading = ref(false);
   const messages = ref([]);
+  const isShow = ref(false);
 
   // 聊天开始
   const handleStart = (id: number | string) => {