useXAgent

Used for model scheduling with Agent hooks.

Import

import{ 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

Agent Request Log

Status-

Update Times0

Preset Request

We will use XRequest as the default request, and only need to configure baseURL and model

Custom Request

Return multiple recommended contents by customizing the ability.

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	🔥 `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

interface RequestFnInfo<Message> extends Partial<XAgentConfigPreset>, AnyObject {
  messages?: Message[];
  message?: 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`	RequestFn
isRequesting	Check if it is requesting	() => boolean