g-ai-robot3 1.0.6 → 1.1.1

package/README.md

@@ -108,8 +108,9 @@ export default defineConfig({
 | `modelType` | `"local" \| "online"` | `"online"` | 模型类型 |
 | `showModelTypeToggle` | `boolean` | `false` | 是否显示本地/联网切换 |
 | `isDebug` | `boolean` | `false` | 是否打印调试信息 |
-| `mode` | `"audio" \| "text" \| "video"` | `"video"` | 交互模式 |
-| `driverMode` | `"workflow" \| "agent"` | `"workflow"` | AI 响应驱动模式，`workflow` 保持关键词工作流，`agent` 直接透传 AI JSON |
+| `mode` | `"audio" \| "text" \| "video"` | `"video"` | 交互模式 |
+| `driverMode` | `"workflow" \| "agent"` | `"workflow"` | AI 响应驱动模式，`workflow` 保持关键词工作流，`agent` 直接透传 AI JSON |
+| `data` | `Record<string, any>` | `{}` | `agent` 模式下随消息透传给后端的动态上下文 |
 
 ### 对话框与数字人
 
@@ -192,39 +193,49 @@ const eventFun = [
 
 `driverMode` 默认为 `workflow`，老项目不需要改动。切换到 `agent` 后：
 
-- 忽略 `eventFun`
-- 不做关键词匹配
-- 每次 AI 返回 `data` 时直接触发 `onAgentResponse`
-- 由业务层自行决定如何处理返回 JSON
-
-```vue
-<script setup lang="ts">
-const handleAgentResponse = (params: any) => {
-  console.log("agent response", params);
-};
+- 忽略 `eventFun`
+- 不做关键词匹配
+- 每次 AI 返回 `data` 时直接触发 `agent-response`
+- 由业务层自行决定如何处理返回 JSON
+- 发送请求时 `searchText` 会升级为 `JSON.stringify({ msg, data })` 后的字符串；`msg` 为用户输入或补问组装文本，`data` 为外部传入的最新 `data` prop
+
+```vue
+<script setup lang="ts">
+import { ref } from "vue";
+
+const agentContext = ref({
+  anything: "from parent",
+});
+
+const handleAgentResponse = (params: any) => {
+  console.log("agent response", params);
+};
 </script>
 
 <template>
-  <GAiRobot3
-    mode="video"
-    driverMode="agent"
-    @onAgentResponse="handleAgentResponse"
-  />
-</template>
+  <GAiRobot3
+    mode="video"
+    driverMode="agent"
+    :data="agentContext"
+    @agent-response="handleAgentResponse"
+  />
+</template>
 ```
 
 业务侧可以直接拿到类似下面的结构：
 
 ```ts
-function handleAgentResponse(params: any) {
-  // {
-  //   reply,
-  //   targetState,
-  //   commands
-  // }
-  applyAgentResponse(params);
-}
-```
+function handleAgentResponse(params: any) {
+  // {
+  //   reply,
+  //   targetState,
+  //   commands
+  // }
+  applyAgentResponse(params);
+}
+```
+
+`workflow` 模式继续保持旧请求结构，不启用 `{ msg, data }` 和补问组装，老项目不需要调整后端接口。
 
 ## 注意事项
 

package/dist/composables/index.d.ts

@@ -3,4 +3,6 @@ export { useAudioPlayback } from './useAudioPlayback';
 export { useVoiceRecognition } from './useVoiceRecognition';
 export { useStreamAnswer } from './useStreamAnswer';
 export { useQADialog } from './useQADialog';
+export { buildSearchTextPayload, resolveNeedClarify, useClarifyContext } from './useClarifyContext';
 export type { ConversationItem } from './useQADialog';
+export type { AgentContextData, AgentSearchTextPayload, BuildSearchTextPayloadParams, ClarifyResponseMessage, ClarifyContext, ClarifyResponsePayload, ClarifySendResult, SearchTextPayload, } from './useClarifyContext';

package/dist/composables/useClarifyContext.d.ts

@@ -0,0 +1,42 @@
+import { type ComputedRef, type Ref } from 'vue';
+import type { DriverMode } from '../type';
+/** *********************补问上下文类型*********************/
+export type AgentContextData = Record<string, any>;
+export interface ClarifySendResult {
+    sendText: string;
+    isComposed: boolean;
+}
+export interface AgentSearchTextPayload {
+    msg: string;
+    data: AgentContextData;
+}
+export type SearchTextPayload = string;
+export interface ClarifyResponsePayload {
+    userInput: string;
+    answerText: string;
+    needClarify?: boolean;
+}
+export interface BuildSearchTextPayloadParams {
+    driverMode: DriverMode;
+    userInput: string;
+    data?: AgentContextData;
+    clarifyContext?: Pick<ClarifyContext, 'buildSendText'>;
+}
+export interface ClarifyResponseMessage {
+    data?: {
+        needClarify?: boolean;
+    } | null;
+}
+export interface ClarifyContext {
+    isClarifying: Ref<boolean>;
+    originalRequest: Ref<string>;
+    lastSystemQuestion: Ref<string>;
+    canCompose: ComputedRef<boolean>;
+    buildSendText: (userInput: string) => ClarifySendResult;
+    updateFromResponse: (payload: ClarifyResponsePayload) => void;
+    clearClarifyContext: () => void;
+}
+/** *********************请求协议组装*********************/
+export declare const buildSearchTextPayload: ({ driverMode, userInput, data, clarifyContext, }: BuildSearchTextPayloadParams) => SearchTextPayload;
+export declare const resolveNeedClarify: (message: ClarifyResponseMessage) => boolean | undefined;
+export declare function useClarifyContext(): ClarifyContext;

package/dist/composables/useQADialog.d.ts

@@ -1,5 +1,6 @@
 import { type Ref, type ComputedRef } from 'vue';
 import type { ConversationType, ConversationInput, DriverMode, StreamChunk, WorkflowEventHandler } from '../type';
+import { type AgentContextData, type ClarifyContext } from './useClarifyContext';
 export interface ConversationItem {
     type: ConversationType;
     singleText?: string;
@@ -24,6 +25,7 @@ export interface UseQADialogOptions {
     initialQuestion?: string;
     streamChunks?: StreamChunk[];
     conversations?: ConversationInput[];
+    data?: AgentContextData;
 }
 export interface UseQADialogDeps {
     cozeInfoParams: ComputedRef<Record<string, any>>;
@@ -34,10 +36,11 @@ export interface UseQADialogDeps {
     currentChatId: Ref<string>;
     currentConversationId: Ref<string>;
     eventFun: WorkflowEventHandler[];
-    onAgentResponse: (params: any) => void;
+    onAgentData: (params: any) => void;
     cancelChat: (conversationId: string, chatId: string) => Promise<boolean>;
     input: Ref<string>;
     inputRecognitionType: Ref<string>;
+    clarifyContext?: ClarifyContext;
     stopOrderPlayAudio: () => void;
     stopRecognition: () => void;
     scrollContainer: Ref<any>;

package/dist/composables/useStreamAnswer.d.ts

@@ -1,6 +1,7 @@
 import { type Ref, type ComputedRef } from 'vue';
 import type { AvatarId } from '../constants/avatar';
 import type { DriverMode, MsgItem, WorkflowEventHandler } from '../type';
+import { type AgentContextData, type ClarifyContext } from './useClarifyContext';
 export interface UseStreamAnswerOptions {
     qaServer: string;
     stream: 'True' | 'False';
@@ -8,6 +9,7 @@ export interface UseStreamAnswerOptions {
     mode: 'audio' | 'text' | 'video';
     driverMode: DriverMode;
     isDebug: boolean;
+    data?: AgentContextData;
 }
 export interface UseStreamAnswerDeps {
     avatarId: Ref<AvatarId>;
@@ -16,9 +18,10 @@ export interface UseStreamAnswerDeps {
     msgList: Ref<MsgItem[]>;
     digitalHumanRef: Ref<any>;
     eventFun: WorkflowEventHandler[];
-    onAgentResponse: (params: any) => void;
+    onAgentData: (params: any) => void;
     stopOrderPlayAudio: () => void;
     addAudioToQueue: (url: string, interrupt: boolean) => void;
+    clarifyContext?: ClarifyContext;
 }
 export declare function useStreamAnswer(getOptions: () => UseStreamAnswerOptions, deps: UseStreamAnswerDeps): {
     isGettingAnswer: Ref<boolean, boolean>;