diff --git a/packages/core/src/PageAgentCore.ts b/packages/core/src/PageAgentCore.ts index f97ab36..12611dc 100644 --- a/packages/core/src/PageAgentCore.ts +++ b/packages/core/src/PageAgentCore.ts @@ -73,8 +73,8 @@ export class PageAgentCore extends EventTarget { disposed = false /** - * Callback for when agent needs user input (ask_user tool) - * If not set, ask_user tool will be disabled + * Called when the agent needs to ask the user questions. + * If unset, the `ask_user` tool will be disabled. * @example onAskUser: (q) => window.prompt(q) || '' */ onAskUser?: (question: string) => Promise diff --git a/packages/ui/src/panel/types.ts b/packages/ui/src/panel/types.ts index 66c7a9e..4b7a419 100644 --- a/packages/ui/src/panel/types.ts +++ b/packages/ui/src/panel/types.ts @@ -60,7 +60,8 @@ export interface PanelAgentAdapter extends EventTarget { readonly task: string /** - * Callback for when agent needs user input. + * Called when the agent needs to ask the user questions. + * If unset, the `ask_user` tool will be disabled. * Panel will set this to handle user questions via its UI. */ onAskUser?: (question: string) => Promise diff --git a/packages/website/src/pages/docs/advanced/page-agent-core/page.tsx b/packages/website/src/pages/docs/advanced/page-agent-core/page.tsx index ef5600f..9eb6ccb 100644 --- a/packages/website/src/pages/docs/advanced/page-agent-core/page.tsx +++ b/packages/website/src/pages/docs/advanced/page-agent-core/page.tsx @@ -356,8 +356,8 @@ const result = await agent.execute('Fill in the form with test data')`} name: 'onAskUser', type: '(question: string) => Promise', description: isZh - ? 'Agent 需要用户输入时的回调。未设置则禁用 ask_user 工具。' - : 'Callback when agent needs user input. If not set, ask_user tool is disabled.', + ? '当 agent 需要向用户提问时调用。未设置则禁用 `ask_user` 工具。' + : 'Called when the agent needs to ask the user questions. If unset, the `ask_user` tool will be disabled.', }, ]} />