useXAgent - Ant Design X

When To Use

Connect with the backend model to provide an abstract data flow.

Examples

API

type useXAgent<AgentMessage> = (
  config: XAgentConfigPreset | XAgentConfigCustom<AgentMessage>,
) => [Agent];

XAgentConfigPreset

Use preset protocol for request, protocol is not implemented yet.

Property	Description	Type	Default	Version
baseURL	Request for server address	string	-
key	Request key	string	-
model	Preset protocol model	string	-
dangerouslyApiKey	Enabling this option can be dangerous, exposing secret API credentials	string	-	-

XAgentConfigCustom

Custom request protocol.

Property	Description	Type	Default	Version
request	Config custom request, support streaming update	RequestFn

RequestFn

interface RequestFnInfo<Message> extends Partial<XAgentConfigPreset>, AnyObject {
  messages?: Message[];
}

type RequestFn<Message> = (
  info: RequestFnInfo<Message>,
  callbacks: {
    onUpdate: (message: Message) => void;
    onSuccess: (message: Message) => void;
    onError: (error: Error) => void;
  },
) => void;

Agent

Property	Description	Type	Version
request	Call the configured request of `useXAgent`	AgentRequestFn
isRequesting	Check if it is requesting	() => boolean

interface AgentRequestFnInfo<Message> extends Partial<XAgentConfigPreset>, AnyObject {
  messages?: Message[];
}

type AgentRequestFn<AgentMessage> = (
  info: AgentRequestFnInfo<Message>,
  callbacks: {
    onUpdate: (message: AgentMessage) => void;
    onSuccess: (message: AgentMessage) => void;
    onError: (error: Error) => void;
  },
) => void;