Ant Design X

useXAgent

Used for model scheduling with Agent hooks.

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

Sourcecomponents/use-x-agent

Docs

Edit this page Changelog

Ant Design X

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

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

Preset Request

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

Custom RequestParams

Customize the menu RequestParams, can send request to intelligent agents, etc.

Custom Request

Return multiple recommended contents by customizing the ability.

Model Access

Access to cloud service platform,can send messages, transform stream, abort stream.

Control XRequestOptions

Control change XRequestOptions，dynamically modify configuration items such as baseURL, model, and API key.

Preset Request

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

Custom RequestParams

Customize the menu RequestParams, can send request to intelligent agents, etc.

Custom Request

Return multiple recommended contents by customizing the ability.

Model Access

Access to cloud service platform,can send messages, transform stream, abort stream.

Control XRequestOptions

Control change XRequestOptions，dynamically modify configuration items such as baseURL, model, and API key.

Agent Request Log

Status-

Update Times0

Agent Request Log

Status-

Update Times0

Agent Request Logrequest

Status-

Update Times0

baseURL: https://api.example.com/chat/v1

model: gpt-3.5-turbo

dangerouslyApiKey: Bearer sk-your-dangerouslyApiKey

Agent Request Log

Status-

Update Times0