useXAgent

Used for model scheduling with Agent hooks.

Importimport { useXAgent } from "@ant-design/x";

Sourcecomponents/use-x-agent

Docs

Edit this page Changelog

useXAgent

Used for model scheduling with Agent hooks.

Importimport { useXAgent } from "@ant-design/x";

Sourcecomponents/use-x-agent

Docs

Edit this page Changelog

When To Use

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

Examples

API

tsx

type useXAgent<Message> = (config: XAgentConfigPreset | XAgentConfigCustom<Message>) => [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	🔥 `dangerouslyApiKey` presents security risks. Detailed documentation on this can be found in Explanation	string	-	-

XAgentConfigCustom

Custom request protocol.

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

RequestFn

For more properties, see XStreamOptions.

tsx

interface RequestFnInfo<Message> extends AnyObject {
  messages?: Message[];
  message?: Message;
}

type RequestFn<Message, Input, Output> = (
  info: RequestFnInfo<Message, Input>,
  callbacks: {
    onUpdate: (chunk: Output) => void;
    onSuccess: (chunks: Output[]) => void;
    onError: (error: Error) => void;
    onStream?: (abortController: AbortController) => void;
  },
  transformStream?: XStreamOptions<Message>['transformStream'],
) => void;

Agent

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

Ant Design X

useXAgent

Ant Design X

useXAgent

When To Use

Examples

API

XAgentConfigPreset

XAgentConfigCustom

RequestFn

Agent

When To Use

Examples

API

XAgentConfigPreset

XAgentConfigCustom

RequestFn

Agent