XRequest请求
XRequest
请求
使用import { XRequest } from "@ant-design/x"; |
Status- |
Update Times0 |
该示例说明如何使用 XRequest 对符合 OpenAI 标准的 LLM 发起 fetch 请求 ，请拷贝代码且在 DEV 环境用实际的值替换 BASE_URL, PATH, MODEL, API_KEY 来使用
Status- |
Update Times0 |
自定义 RequestParams，可以向智能体等发送消息。
为 XRequest 配置自定义的 transformStream , 示例中使用 application/x-ndjson 数据演示
baseURL: https://api.example.com/chat/v1
model: gpt-3.5-turbo
dangerouslyApiKey: Bearer sk-your-dangerouslyApiKey
Status- |
Update Times0 |
控制变更XRequestOptions，动态修改配置项，如 baseURL、model 和 API key。
Status- |
Update Times0 |
接入云服务平台，可发送请求、终止消息。
| 属性 | 描述 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| baseURL | API 请求的基础 URL | string | - | - |
| model | 模型名称，例如 'gpt-3.5-turbo' | string | - | - |
| dangerouslyApiKey | 注意: 🔥 dangerouslyApiKey 存在安全风险，对此有详细的说明。 | string | - | - |
| fetch | 可选的自定义 fetch 函数，用于发起请求 | fetch | - | - |
type XRequestFunction<Input = Record<PropertyKey, any>, Output = Record<string, string>> = (params: XRequestParams & Input,callbacks: XRequestCallbacks<Output>,transformStream?: XStreamOptions<Output>['transformStream'],) => Promise<void>;
| 属性 | 描述 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| model | 生成响应时使用的模型。 | string | - | - |
| messages | 消息对象数组，每个对象包含角色和内容。 | Record<PropertyKey, any>[] | - | - |
| stream | 指示是否使用流式响应。 | boolean | false | - |
| 属性 | 描述 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| onSuccess | 成功时的回调 | (chunks: Output[]) => void | - | - |
| onError | 错误处理的回调 | (error: Error) => void | - | - |
| onUpdate | 消息更新的回调 | (chunk: Output) => void | - | - |
| onStream | 流的控制回调 | (abortController: AbortController) => void | - | - |
| transformStream | 可选的转换函数，用于处理流数据 | XStreamOptions<Output>['transformStream'] | - | - |