docs: update use description for agent parameter

ant-design · Nov 29, 2024 · edcef1d · edcef1d
1 parent 40f4310
commit edcef1d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/components/useXChat/index.en-US.md b/components/useXChat/index.en-US.md
@@ -36,7 +36,7 @@ type useXChat<AgentMessage, ParsedMessage = AgentMessage> = (
 
 | Property | Description | Type | Default | Version |
 | --- | --- | --- | --- | --- |
-| agent | Agent generated by useXAgent | XAgent | - |  |
+| agent | `agent` parameter is required when using the `onRequest` method in an agent generated by `useXAgent`. | XAgent | - |  |
 | defaultMessages | default messages | { status, message }[] | - |  |
 | parser | Convert AgentMessage to ParsedMessage for consumption. If not set, AgentMessage will be consumed directly. Supports converting one AgentMessage to multiple ParsedMessages | (message: AgentMessage) => BubbleMessage \| BubbleMessage[] | - |  |
 | requestFallback | Fallback when request fails, not provided will not be displayed | AgentMessage \| () => AgentMessage | - |  |

diff --git a/components/useXChat/index.zh-CN.md b/components/useXChat/index.zh-CN.md
@@ -35,7 +35,7 @@ type useXChat<AgentMessage, ParsedMessage = AgentMessage> = (
 
 | 属性 | 说明 | 类型 | 默认值 | 版本 |
 | --- | --- | --- | --- | --- |
-| agent | 由 useXAgent 生成的代理器 | XAgent | - |  |
+| agent | 通过 `useXAgent` 生成的 `agent`，当使用 `onRequest` 方法时, `agent` 参数是必需的。 | XAgent | - |  |
 | defaultMessages | 默认展示信息 | { status, message }[] | - |  |
 | parser | 将 AgentMessage 转换成消费使用的 ParsedMessage，不设置时则直接消费 AgentMessage。支持将一条 AgentMessage 转换成多条 ParsedMessage | (message: AgentMessage) => BubbleMessage \| BubbleMessage[] | - |  |
 | requestFallback | 请求失败的兜底信息，不提供则不会展示 | AgentMessage \| () => AgentMessage | - |  |