XRequest 请求
使用 |
文档 |
何时使用#
向符合 OpenAI 标准的 LLM 发起请求。
代码演示 #
Request Log
Status - |
Update Times 0 |
加载中
Request Log
Status - |
Update Times 0 |
加载中
Mock Custom Protocol Log
加载中
baseURL: https://api.example.com/chat
model: gpt-3.5-turbo
dangerouslyApiKey: Bearer sk-your-dangerouslyApiKey
Request Log
Status - |
Update Times 0 |
加载中
Request Log request null
Status - |
Update Times 0 |
加载中
API#
XRequestOptions#
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
baseURL | API 请求的基础 URL | string | - |
model | 模型名称,例如 'gpt-3.5-turbo' | string | - |
dangerouslyApiKey | 注意: dangerouslyApiKey 存在安全风险 | string | - |
fetch | 可选的自定义 fetch 函数, 用于发起请求 | 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#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
model | 生成响应时使用的模型 | string | - |
messages | 消息对象数组,每个对象包含角色和内容 | Record<PropertyKey, any>[] | - |
stream | 指示是否使用流式响应 | boolean | false |
XRequestCallbacks#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
onSuccess | 成功时的回调 | (messages: Output[]) => void | - |
onError | 错误处理的回调 | (error: Error) => void | - |
onUpdate | 消息更新的回调 | (message: Output) => void | - |
onStream | 流的控制回调 | (controller: AbortController) => void | - |
transformStream | 可选的转换函数,用于处理流数据 | XStreamOptions<Output>['transformStream'] | - |