useXChat数据管理

配合 Agent hook 进行对话数据管理。

使用

import{ useXChat }from"@ant-design/x";

文档

何时使用

通过 Agent 进行会话数据管理，并产出供页面渲染使用的数据。

基础用法。

使用流式输出更新内容。

打断正在流式输出的内容。

Hello, what can I do for you?

通过定制能力，返回多个推荐内容。

type useXChat<AgentMessage, ParsedMessage = AgentMessage> = (
  config: XChatConfig<AgentMessage, ParsedMessage>,
) => XChatConfigReturnType;

属性	说明	类型	默认值
agent	通过 `useXAgent` 生成的 `agent`，当使用 `onRequest` 方法时, `agent` 参数是必需的。	XAgent	-
defaultMessages	默认展示信息	{ status, message }[]	-
parser	将 AgentMessage 转换成消费使用的 ParsedMessage，不设置时则直接消费 AgentMessage。支持将一条 AgentMessage 转换成多条 ParsedMessage	(message: AgentMessage) => BubbleMessage \| BubbleMessage[]	-
requestFallback	请求失败的兜底信息，不提供则不会展示	AgentMessage \| () => AgentMessage	-
requestPlaceholder	请求中的占位信息，不提供则不会展示	AgentMessage \| () => AgentMessage	-

属性	说明	类型
messages	当前管理的内容	AgentMessages[]
parsedMessages	经过 `parser` 转译过的内容	ParsedMessages[]
onRequest	添加一条 Message，并且触发请求	(message) => void
setMessages	直接修改 messages，不会触发请求	(messages: { message, status }[]) => void