XRequest
XRequest
Importimport { XRequest } from "@ant-design/x"; |
Sourcecomponents/x-request |
Ant Design X| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| baseURL | Base URL for the API request | string | - | - |
| model | Model name, e.g., 'gpt-3.5-turbo' | string | - | - |
| dangerouslyApiKey | 🔥 dangerouslyApiKey presents security risks. Detailed documentation on this can be found in Explanation | string | - | - |
| fetch | Optional custom fetch function for making requests | fetch | - | - |
type XRequestFunction<Input = Record<PropertyKey, any>, Output = Record<string, string>> = (params: XRequestParams & Input,callbacks: XRequestCallbacks<Output>,transformStream?: XStreamOptions<Output>['transformStream'],) => Promise<void>;
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| model | The model to be used for generating responses. | string | - | - |
| messages | An array of message objects, each containing a role and content. | Record<PropertyKey, any>[] | - | - |
| stream | Indicates whether to use streaming for the response. | boolean | false | - |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| onSuccess | Callback for successful | (chunks: Output[]) => void | - | - |
| onError | Callback for error handling | (error: Error) => void | - | - |
| onUpdate | Callback for message updates | (chunk: Output) => void | - | - |
| onStream | Callback for stream controller | (abortController: AbortController) => void | - | - |
| transformStream | Optional transform function for processing stream data | XStreamOptions<Output>['transformStream'] | - | - |
This example illustrates how to use XRequest to initiate a fetch request to LLMs that comply with OpenAI standards. Please copy the code and replace BASE_URL, PATH, MODEL, and API_KEY with actual values in the DEV environment to use it.
Customize the menu RequestParams, can send request to intelligent agents, etc.
Configure a custom transformStream for XRequest. The following example demonstrates how to handle application/x-ndjson data format.
Control change XRequestOptions，dynamically modify configuration items such as baseURL, model, and API key.
Access to cloud service platform,can send messages, process data, abort stream.
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 |
Status- |
Update Times0 |