useXChatConversation Data
useXChat
Conversation Data
Ant Design XManage conversation data through Agent and produce data for page rendering.
type useXChat<ChatMessage extends SimpleType = object,ParsedMessage extends SimpleType = ChatMessage,Input = RequestParams<ChatMessage>,Output = SSEOutput,> = (config: XChatConfig<ChatMessage, ParsedMessage, Input, Output>) => XChatConfigReturnType;
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| provider | Data provider used to convert data and requests of different structures into formats that useXChat can consume. The platform includes built-in DefaultChatProvider and OpenAIChatProvider, and you can also implement your own Provider by inheriting AbstractChatProvider. See: Chat Provider Documentation | AbstractChatProvider<ChatMessage, Input, Output> | - | - |
| defaultMessages | Default display messages | { message: ChatMessage, status: MessageStatus }[] | - | - |
| parser | Converts ChatMessage into ParsedMessage for consumption. When not set, ChatMessage is consumed directly. Supports converting one ChatMessage into multiple ParsedMessages | (message: ChatMessage) => BubbleMessage | BubbleMessage[] | - | - |
| requestFallback | Fallback message for failed requests. When not provided, no message will be displayed | ChatMessage | () => ChatMessage | - | - |
| requestPlaceholder | Placeholder message during requests. When not provided, no message will be displayed | ChatMessage | () => ChatMessage | - | - |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| abort | Cancel request | () => void | - | - |
| isRequesting | Whether a request is in progress | boolean | - | - |
| messages | Current managed message list content | MessageInfo<ChatMessage>[] | - | - |
| parsedMessages | Content translated through parser | MessageInfo<ParsedMessages>[] | - | - |
| onReload | Regenerate, will send request to backend and update the message with new returned data | (id: string | number, requestParams: Partial<Input>, opts: { extra: AnyObject }) => void | - | - |
| onRequest | Add a Message and trigger request | (requestParams: Partial<Input>, opts: { extra: AnyObject }) => void | - | - |
| setMessages | Directly modify messages without triggering requests | (messages: Partial<MessageInfo<ChatMessage>>[]) => void | - | - |
| setMessage | Directly modify a single message without triggering requests | (id: string | number, info: Partial<MessageInfo<ChatMessage>>) => void | - | - |
interface MessageInfo<ChatMessage> {id: number | string;message: ChatMessage;status: MessageStatus;extra?: AnyObject;}
type MessageStatus = 'local' | 'loading' | 'updating' | 'success' | 'error' | 'abort';
Access to cloud service platform,can send messages, process data, abort stream.
Use DeepSeekChatProvider to integrate thinking models, enabling message sending, data processing, and message termination.
You can use defaultMessages to set historical messages.
You can use defaultMessages to set system prompts.
Custom request configuration (not recommended, please use the default built-in request).
When using SDKs (such as openai-node, @openrouter/ai-sdk-provider) to request models or agents, you need to use the built-in Provider to handle data and customize the Request. Please refer to this example. Note: This example only demonstrates the logic for integrating openai using X SDK as a reference, and does not process model data. You need to fill in the correct apiKey for data debugging.
