Property	Description	Type	Default
`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
`request`	Config custom request, support streaming update	`RequestFn`

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;

Agent#

Property	Description	Type	Default
`request`	Call the configured request of `XAgent`, more info	`RequestFn`
`isRequesting`	Check if it is requesting	`signal<boolean>`