useXAgent
模型调度

用于模型调度的 Agent 钩子。

使用import { useXAgent } from "@ant-design/x";

源码components/use-x-agent

文档

编辑此页更新日志

useXAgent
模型调度

用于模型调度的 Agent 钩子。

使用import { useXAgent } from "@ant-design/x";

源码components/use-x-agent

文档

编辑此页更新日志

何时使用

与后端模型进行交互，提供抽象数据流。

代码演示

Agent Request Log

Status-

Update Times0

预设请求

我们将 XRequest 作为预设请求，仅需配置 baseURL、model 即可。

Agent Request Log

Status-

Update Times0

自定义入参

自定义 RequestParams，可以向智能体等发送消息。

自定义请求

通过定制能力，返回多个推荐内容。

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

变更配置

控制变更XRequestOptions，动态修改配置项，如 baseURL、model 和 API key。

API

tsx

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

XAgentConfigPreset

使用预设协议进行请求，尚未实现协议。

属性	说明	类型	默认值	版本
baseURL	请求服务端地址	string	-
key	请求秘钥	string	-
model	协议模型	string	-
dangerouslyApiKey	注意: 🔥 `dangerouslyApiKey` 存在安全风险，对此有详细的说明。	string	-	-

XAgentConfigCustom

自定义请求协议。

属性	说明	类型	默认值	版本
request	配置自定义请求，支持流式更新	RequestFn

RequestFn

更多请查看 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

属性	说明	类型	版本
request	调用 `useXAgent` 配置的请求，详情	RequestFn
isRequesting	是否正在请求	() => boolean

API

tsx

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

XAgentConfigPreset

使用预设协议进行请求，尚未实现协议。

属性	说明	类型	默认值	版本
baseURL	请求服务端地址	string	-
key	请求秘钥	string	-
model	协议模型	string	-
dangerouslyApiKey	注意: 🔥 `dangerouslyApiKey` 存在安全风险，对此有详细的说明。	string	-	-

XAgentConfigCustom

自定义请求协议。

属性	说明	类型	默认值	版本
request	配置自定义请求，支持流式更新	RequestFn

RequestFn

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

属性	说明	类型	版本
request	调用 `useXAgent` 配置的请求，详情	RequestFn
isRequesting	是否正在请求	() => boolean

Ant Design X

useXAgent
模型调度

Ant Design X

useXAgent
模型调度

何时使用

代码演示

API

XAgentConfigPreset

XAgentConfigCustom

RequestFn

Agent

何时使用

代码演示

API

XAgentConfigPreset

XAgentConfigCustom

RequestFn

Agent

useXAgent模型调度

useXAgent模型调度

何时使用

代码演示

API

XAgentConfigPreset

XAgentConfigCustom

RequestFn

Agent

何时使用

代码演示

API

XAgentConfigPreset

XAgentConfigCustom

RequestFn

Agent

useXAgent
模型调度

useXAgent
模型调度