useXChat会话数据
useXChat
会话数据
单对话的数据管理。
使用import { useXChat } from "@ant-design/x"; |
文档 |
版本自 2.0.0 起支持 |
Ant Design X使用import { useXChat } from "@ant-design/x"; |
文档 |
版本自 2.0.0 起支持 |
通过 Agent 进行会话数据管理，并产出供页面渲染使用的数据。
type useXChat<ChatMessage extends SimpleType = object,ParsedMessage extends SimpleType = ChatMessage,Input = RequestParams<ChatMessage>,Output = SSEOutput,> = (config: XChatConfig<ChatMessage, ParsedMessage, Input, Output>) => XChatConfigReturnType;
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| ChatMessage | 消息数据类型，定义聊天消息的结构 | object | object | - |
| ParsedMessage | 解析后的消息类型，用于组件消费的消息格式 | ChatMessage | ChatMessage | - |
| Input | 请求参数类型，定义发送请求的参数结构 | RequestParams<ChatMessage> | RequestParams<ChatMessage> | - |
| Output | 响应数据类型，定义接收响应的数据格式 | SSEOutput | SSEOutput | - |
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| provider | 数据提供方，用于将不同结构的数据及请求转换为useXChat能消费的格式，平台内置了DefaultChatProvider和OpenAIChatProvider，你也可以通过继承AbstractChatProvider实现自己的Provider。详见：Chat Provider文档 | AbstractChatProvider<ChatMessage, Input, Output> | - | - |
| conversationKey | 会话唯一标识（全局唯一），用于区分不同的会话 | string | Symbol('ConversationKey') | - |
| defaultMessages | 默认展示信息 | DefaultMessagesType[] | (info: { conversationKey?: string }) => DefaultMessagesType[] | (info: { conversationKey?: string }) => Promise<DefaultMessagesType[]> | - | - |
| parser | 将 ChatMessage 转换成消费使用的 ParsedMessage，不设置时则直接消费 ChatMessage。支持将一条 ChatMessage 转换成多条 ParsedMessage | (message: ChatMessage) => BubbleMessage | BubbleMessage[] | - | - |
| requestFallback | 请求失败的兜底信息，不提供则不会展示 | ChatMessage | (requestParams: Partial<Input>,info: { error: Error; errorInfo: any; messages: ChatMessage[], message: ChatMessage }) => ChatMessage|Promise<ChatMessage> | - | - |
| requestPlaceholder | 请求中的占位信息，不提供则不会展示 | ChatMessage | (requestParams: Partial<Input>, info: { messages: Message[] }) => ChatMessage |Promise<Message> | - | - |
type DefaultMessagesType = {id: string | number;message: ChatMessage;status: MessageStatus;};
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| abort | 取消请求 | () => void | - | - |
| isRequesting | 是否在请求中 | boolean | - | - |
| isDefaultMessagesRequesting | 默认消息列表是否在请求中 | boolean | false | 2.2.0 |
| messages | 当前管理消息列表的内容 | MessageInfo<ChatMessage>[] | - | - |
| parsedMessages | 经过 parser 转译过的内容 | MessageInfo<ParsedMessages>[] | - | - |
| onReload | 重新生成，会发送请求到后台，使用新返回数据更新该条消息 | (id: string | number, requestParams: Partial<Input>,opts: { extra: AnyObject }) => void | - | - |
| onRequest | 添加一条 Message，并且触发请求 | (requestParams: Partial<Input>,opts: { extra: AnyObject }) => void | - | - |
| setMessages | 直接修改 messages，不会触发请求 | (messages: Partial<MessageInfo<ChatMessage>>[]) => void | - | - |
| setMessage | 直接修改单条 message，不会触发请求 | (id: string | number, info: Partial<MessageInfo<ChatMessage>>) => void | - | - |
| removeMessage | 删除单条 message，不会触发请求 | (id: string | number) => void | - | - |
interface MessageInfo<ChatMessage> {id: number | string;message: ChatMessage;status: MessageStatus;extra?: AnyObject;}
type MessageStatus = 'local' | 'loading' | 'updating' | 'success' | 'error' | 'abort';
使用 OpenAIChatProvider，接入 OpenAI 数据格式的模型，可发送消息、处理数据、终止消息。
使用 DeepSeekChatProvider，接入思考模型，可发送消息、处理数据、终止消息。
可使用 defaultMessages 设置历史消息。
将 defaultMessages 设置为异步方法，可以在初始化时加载历史消息。
可使用 defaultMessages 设置系统提示词。
自定义 XRequest.fetch。
当使用一些 SDKs（例如：openai-node，@openrouter/ai-sdk-provider）请求模型或者智能体时需要使用内置的Provider处理数据，需要自定义Request，可参考此示例。 注意：此示例仅展示使用X SDK接入 openai 的逻辑参考，并未对模型数据进行处理，需填写正确的apiKey再进行数据调试。
