Ant Design X

XRequest

Import

import{ XRequest }from"@ant-design/x";

Sourcecomponents/x-request

Docs

Edit this page Changelog

Ant Design X

XRequest

Import

import{ XRequest }from"@ant-design/x";

Sourcecomponents/x-request

Docs

Edit this page Changelog

When To Use

Initiate a fetch request to LLMs that comply with OpenAI standards.

Examples

API

XRequestOptions

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	-	-

XRequestFunction

type XRequestFunction<Input = Record<PropertyKey, any>, Output = Record<string, string>> = (
  params: XRequestParams & Input,
  callbacks: XRequestCallbacks<Output>,
  transformStream?: XStreamOptions<Output>['transformStream'],
) => Promise<void>;

XRequestParams

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	-

XRequestCallbacks

Property	Description	Type	Default	Version
onSuccess	Callback for successful.	`(messages: Output[]) => void`	-	-
onError	Callback for error handling.	`(error: Error) => void`	-	-
onUpdate	Callback for message updates.	`(message: Output) => void`	-	-
transformStream	Optional transform function for processing stream data	`XStreamOptions<Output>['transformStream']`	-	-

When To Use

Initiate a fetch request to LLMs that comply with OpenAI standards.

Examples

API

XRequestOptions

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	-	-

XRequestFunction

type XRequestFunction<Input = Record<PropertyKey, any>, Output = Record<string, string>> = (
  params: XRequestParams & Input,
  callbacks: XRequestCallbacks<Output>,
  transformStream?: XStreamOptions<Output>['transformStream'],
) => Promise<void>;

XRequestParams

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	-

XRequestCallbacks

Property	Description	Type	Default	Version
onSuccess	Callback for successful.	`(messages: Output[]) => void`	-	-
onError	Callback for error handling.	`(error: Error) => void`	-	-
onUpdate	Callback for message updates.	`(message: Output) => void`	-	-
transformStream	Optional transform function for processing stream data	`XStreamOptions<Output>['transformStream']`	-	-

Basic

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.

Custom Transformer

Configure a custom transformStream for XRequest. The following example demonstrates how to handle application/x-ndjson data format.

Basic

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.

Custom Transformer

Configure a custom transformStream for XRequest. The following example demonstrates how to handle application/x-ndjson data format.

Request Log

Status-

Update Times0

Mock Custom Protocol - Log