@blueking/chat-helper 0.0.1-beta.8 → 0.0.1-beta.9

package/README.md

@@ -41,16 +41,16 @@ const { agent } = chatHelper;
 // 响应式数据
 agent.info; // Ref<IAgentInfo | null> - agent 信息
 agent.isInfoLoading; // Ref<boolean> - agent 信息加载状态
-agent.userInput; // Ref<string> - 用户输入内容
 
 // 方法
 agent.getAgentInfo(); // () => Promise<void> - 获取 agent 信息
-agent.chat(sessionCode, url?, config?); // (sessionCode: string, url?: string, config?: IRequestConfig) => Promise<void> - 开始聊天（流式响应）
+agent.chat(userInput, sessionCode, url?, config?); // (userInput: string, sessionCode: string, url?: string, config?: IRequestConfig) => Promise<void> - 开始聊天（流式响应）
 agent.stopChat(); // () => Promise<void> - 停止聊天
 ```
 
 **参数说明**：
 
+- `userInput`: 用户输入的消息内容，必需参数
 - `sessionCode`: 会话代码，必需参数，标识当前聊天会话
 - `url`: 可选参数，自定义聊天接口地址，默认为 `'chat_completion/'`
 - `config`: 可选参数，额外的请求配置（如自定义 headers、data 等）
@@ -62,11 +62,11 @@ agent.stopChat(); // () => Promise<void> - 停止聊天
   <div>
     <div v-if="agent.isInfoLoading">加载中...</div>
     <div v-else-if="agent.info">
-      <h2>{{ agent.info.name }}</h2>
-      <p>{{ agent.info.description }}</p>
+      <h2>{{ agent.info.agentName }}</h2>
+      <p>{{ agent.info.conversationSettings?.openingRemark }}</p>
     </div>
     <input
-      v-model="agent.userInput"
+      v-model="userInput"
       placeholder="请输入消息..."
     />
     <button @click="startChat">开始对话</button>
@@ -75,20 +75,23 @@ agent.stopChat(); // () => Promise<void> - 停止聊天
 </template>
 
 <script setup lang="ts">
-  import { onMounted } from 'vue';
+  import { onMounted, ref } from 'vue';
   import { useChatHelper } from '@blueking/chat-helper';
 
   const { agent, session } = useChatHelper({
     /* ... */
   });
 
+  const userInput = ref('');
+
   onMounted(() => {
     agent.getAgentInfo();
   });
 
   const startChat = () => {
-    if (session.current?.sessionCode) {
-      agent.chat(session.current.sessionCode);
+    if (session.current?.sessionCode && userInput.value.trim()) {
+      agent.chat(userInput.value, session.current.sessionCode);
+      userInput.value = ''; // 清空输入框
     }
   };
 </script>
@@ -98,10 +101,10 @@ agent.stopChat(); // () => Promise<void> - 停止聊天
 
 ```typescript
 // 使用自定义 URL
-agent.chat(sessionCode, 'custom_chat_endpoint/');
+agent.chat('你好', sessionCode, 'custom_chat_endpoint/');
 
 // 使用自定义请求配置
-agent.chat(sessionCode, undefined, {
+agent.chat('你好', sessionCode, undefined, {
   headers: {
     'X-Custom-Header': 'value',
   },
@@ -112,7 +115,7 @@ agent.chat(sessionCode, undefined, {
 });
 
 // 同时使用自定义 URL 和配置
-agent.chat(sessionCode, 'custom_chat_endpoint/', {
+agent.chat('你好', sessionCode, 'custom_chat_endpoint/', {
   headers: {
     'X-Custom-Header': 'value',
   },
@@ -156,7 +159,7 @@ session.deleteSession(sessionCode); // (sessionCode: string) => Promise<void> -
         @click="session.chooseSession(item.sessionCode)"
         :class="{ active: session.current?.sessionCode === item.sessionCode }"
       >
-        {{ item.title }}
+        {{ item.sessionName }}
       </li>
     </ul>
     <button @click="createNewSession">新建会话</button>
@@ -177,7 +180,8 @@ session.deleteSession(sessionCode); // (sessionCode: string) => Promise<void> -
 
   const createNewSession = () => {
     session.createSession({
-      title: '新会话',
+      sessionName: '新会话',
+      sessionCode: `session_${Date.now()}`,
       // ... 其他会话属性
     });
   };
@@ -758,7 +762,7 @@ class SafeProtocol extends AGUIProtocol {
 
 ### 场景 1：带输入框的聊天界面
 
-使用 `agent.userInput` 实现双向绑定：
+使用独立的 `ref` 管理用户输入：
 
 ```vue
 <template>
@@ -773,7 +777,7 @@ class SafeProtocol extends AGUIProtocol {
     </div>
     <div class="input-box">
       <textarea
-        v-model="agent.userInput"
+        v-model="userInput"
         @keydown.enter.prevent="handleSend"
         placeholder="输入消息，按 Enter 发送..."
         :disabled="isStreaming"
@@ -796,15 +800,18 @@ class SafeProtocol extends AGUIProtocol {
     /* ... */
   });
   const isStreaming = ref(false);
+  const userInput = ref('');
 
   const canSend = computed(
-    () => !isStreaming.value && agent.userInput.value.trim().length > 0 && session.current?.sessionCode,
+    () => !isStreaming.value && userInput.value.trim().length > 0 && session.current?.sessionCode,
   );
 
   const handleSend = () => {
     if (canSend.value) {
       isStreaming.value = true;
-      agent.chat(session.current!.sessionCode).finally(() => {
+      const input = userInput.value;
+      userInput.value = ''; // 立即清空输入框
+      agent.chat(input, session.current!.sessionCode).finally(() => {
         isStreaming.value = false;
       });
     }
@@ -989,7 +996,7 @@ class SafeProtocol extends AGUIProtocol {
     </div>
 
     <textarea
-      v-model="agent.userInput"
+      v-model="userInput"
       placeholder="输入消息..."
     />
     <button @click="sendWithConfig">发送</button>
@@ -1004,12 +1011,13 @@ class SafeProtocol extends AGUIProtocol {
     /* ... */
   });
 
+  const userInput = ref('');
   const temperature = ref(0.7);
   const maxTokens = ref(1000);
   const mode = ref('default');
 
   const sendWithConfig = () => {
-    if (!session.current?.sessionCode) return;
+    if (!session.current?.sessionCode || !userInput.value.trim()) return;
 
     // 根据模式设置不同的端点
     const endpoint =
@@ -1020,7 +1028,7 @@ class SafeProtocol extends AGUIProtocol {
         : undefined;
 
     // 自定义请求参数
-    agent.chat(session.current.sessionCode, endpoint, {
+    agent.chat(userInput.value, session.current.sessionCode, endpoint, {
       data: {
         temperature: temperature.value,
         max_tokens: maxTokens.value,
@@ -1030,6 +1038,8 @@ class SafeProtocol extends AGUIProtocol {
         'X-Chat-Mode': mode.value,
       },
     });
+
+    userInput.value = ''; // 清空输入框
   };
 </script>
 ```
@@ -1051,7 +1061,7 @@ class SafeProtocol extends AGUIProtocol {
           @click="session.chooseSession(item.sessionCode)"
           :class="{ active: session.current?.sessionCode === item.sessionCode }"
         >
-          {{ item.title }}
+          {{ item.sessionName }}
           <button @click.stop="session.deleteSession(item.sessionCode)">删除</button>
         </li>
       </ul>
@@ -1108,7 +1118,7 @@ class SafeProtocol extends AGUIProtocol {
       <!-- 输入区域 -->
       <div class="input-area">
         <input
-          v-model="agent.userInput"
+          v-model="userInput"
           @keyup.enter="sendMessage"
           placeholder="输入消息..."
           :disabled="isStreaming"
@@ -1135,6 +1145,7 @@ class SafeProtocol extends AGUIProtocol {
   import { useChatHelper, AGUIProtocol } from '@blueking/chat-helper';
 
   const isStreaming = ref(false);
+  const userInput = ref('');
 
   const { agent, session, message } = useChatHelper({
     requestData: {
@@ -1186,14 +1197,15 @@ class SafeProtocol extends AGUIProtocol {
 
   const createNewSession = () => {
     session.createSession({
-      title: `会话 ${new Date().toLocaleString()}`,
+      sessionName: `会话 ${new Date().toLocaleString()}`,
       sessionCode: `session_${Date.now()}`,
     });
   };
 
   const sendMessage = () => {
-    if (session.current?.sessionCode && agent.userInput.value.trim()) {
-      agent.chat(session.current.sessionCode);
+    if (session.current?.sessionCode && userInput.value.trim()) {
+      agent.chat(userInput.value, session.current.sessionCode);
+      userInput.value = ''; // 清空输入框
     }
   };
 </script>
@@ -1306,6 +1318,12 @@ class SafeProtocol extends AGUIProtocol {
 
     <!-- 输入区域 -->
     <div class="input-area">
+      <input
+        v-model="userInput"
+        @keyup.enter="sendMessage"
+        placeholder="输入消息..."
+        :disabled="isStreaming"
+      />
       <button
         @click="sendMessage"
         :disabled="isStreaming"
@@ -1334,6 +1352,7 @@ class SafeProtocol extends AGUIProtocol {
 
   const isStreaming = ref(false);
   const status = ref<{ type: string; message: string } | null>(null);
+  const userInput = ref('');
 
   // 自定义 Protocol，添加各种钩子
   class CustomChatProtocol extends AGUIProtocol {
@@ -1370,7 +1389,7 @@ class SafeProtocol extends AGUIProtocol {
     }
   }
 
-  const { agent } = useChatHelper({
+  const { agent, session, message } = useChatHelper({
     requestData: {
       urlPrefix: 'https://your-api-domain.com/api/',
     },
@@ -1410,7 +1429,10 @@ class SafeProtocol extends AGUIProtocol {
   });
 
   const sendMessage = () => {
-    agent.chat();
+    if (session.current?.sessionCode && userInput.value.trim()) {
+      agent.chat(userInput.value, session.current.sessionCode);
+      userInput.value = ''; // 清空输入框
+    }
   };
 
   const stopStreaming = () => {
@@ -1464,16 +1486,38 @@ class SafeProtocol extends AGUIProtocol {
 
 ```typescript
 import type {
+  // 主要配置和模块类型
   IUseChatHelperOptions,
   IAgentModule,
   ISessionModule,
   IMessageModule,
   IHttpModule,
+
+  // 核心数据类型
   IMessage,
   ISession,
+  IAgentInfo,
+
+  // 消息相关枚举
   MessageRole,
   MessageStatus,
   MessageContentType,
+  MessageContentStatus,
+
+  // 协议相关
+  ISSEProtocol,
+  AGUIProtocol,
+
+  // 事件类型（用于自定义 Protocol）
+  IEvent,
+  IRunStartedEvent,
+  IRunFinishedEvent,
+  IRunErrorEvent,
+  ITextMessageChunkEvent,
+  IThinkingStartEvent,
+  IThinkingEndEvent,
+  IToolCallStartEvent,
+  // ... 更多事件类型
 } from '@blueking/chat-helper';
 ```