useXChat
useXChat
Work with agent hook for data management.
Importimport { useXChat } from "@ant-design/x"; |
Sourcecomponents/use-x-chat |
Ant Design XImportimport { useXChat } from "@ant-design/x"; |
Sourcecomponents/use-x-chat |
Use Agent to manage conversation data and produce data for page rendering.
type useXChat<AgentMessage,ParsedMessage = AgentMessage,Input = RequestParams<AgentMessage>,Output = SSEOutput,> = (config: XChatConfig<AgentMessage, ParsedMessage>) => XChatConfigReturnType;
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| 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 | - | - |
| requestPlaceholder | Show the placeholder information when requesting, not provided will not be displayed | AgentMessage | () => AgentMessage | - | - |
| transformMessage | The messages can be converted when updating data, and will also be updated to messages | (info: {originMessage?: AgentMessage,chunk: Output,chunks: Output[],status: MessageStatus}) => AgentMessage | - | - |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| messages | Current managed messages content | AgentMessages[] | - | - |
| parsedMessages | Parsed messages by parser api | ParsedMessages[] | - | - |
| onRequest | Create a message and trigger a request, If there is no data with key as message, the entire data will be processed as a message | (requestParams: AgentMessage | RequestParams) => void | - | - |
| setMessages | Modify messages directly without triggering requests | (messages: { message, status }[]) => void | - | - |
Extends XRequestParams.
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| message | Current message content | AgentMessage | - | - |
Basic usage.
Update content with stream output.
Return multiple recommended contents by customizing the ability.
Access to cloud service platform,can send messages, process data, abort stream.
