useXAgent
useXAgent
Used for model scheduling with Agent hooks.
Importimport { useXAgent } from "@ant-design/x"; |
Sourcecomponents/use-x-agent |
Importimport { useXAgent } from "@ant-design/x"; |
Sourcecomponents/use-x-agent |
Connect with the backend model to provide an abstract data flow.
type useXAgent<Message> = (config: XAgentConfigPreset | XAgentConfigCustom<Message>) => [Agent];
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 | - | - |
Custom request protocol.
Property | Description | Type | Default | Version |
---|---|---|---|---|
request | Config custom request, support streaming update | RequestFn |
For more properties, see XStreamOptions.
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;
Property | Description | Type | Version |
---|---|---|---|
request | Call the configured request of useXAgent ,more | RequestFn | |
isRequesting | Check if it is requesting | () => boolean |
Status- |
Update Times0 |
Status- |
Update Times0 |
Status- |
Update Times0 |
baseURL: https://api.example.com/chat/v1
model: gpt-3.5-turbo
dangerouslyApiKey: Bearer sk-your-dangerouslyApiKey
Status- |
Update Times0 |