XRequest 请求

向 LLM 发起请求
使用

何时使用#

向符合 OpenAI 标准的 LLM 发起请求。

代码演示#

Request Log
Status -
Update Times 0

该示例说明如何使用 XRequest 对符合 OpenAI 标准的 LLM 发起 fetch 请求 , 请拷贝代码且在 DEV 环境用实际的值替换 BASE_URL, PATH, MODEL, API_KEY 来使用

      加载中
    
Request Log
Status -
Update Times 0

自定义 RequestParams,可以向智能体等发送消息。

      加载中
    
Mock Custom Protocol Log
        
      

XRequest 配置自定义的 transformStream , 示例中使用 application/x-ndjson 数据演示

      加载中
    

baseURL: https://api.example.com/chat

model: gpt-3.5-turbo

dangerouslyApiKey: Bearer sk-your-dangerouslyApiKey

Request Log
Status -
Update Times 0

控制变更XRequestOptions,动态修改配置项,如 baseURL、model 和 API key。

      加载中
    
Request Log request null
Status -
Update Times 0

接入云服务平台,可发送请求、终止消息。

      加载中
    

API#

XRequestOptions#

属性说明类型默认值
baseURLAPI 请求的基础 URLstring-
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指示是否使用流式响应booleanfalse

XRequestCallbacks#

属性描述类型默认值
onSuccess成功时的回调(messages: Output[]) => void-
onError错误处理的回调(error: Error) => void-
onUpdate消息更新的回调(message: Output) => void-
onStream流的控制回调(controller: AbortController) => void-
transformStream可选的转换函数,用于处理流数据XStreamOptions<Output>['transformStream']-