更新记录

v1.0.0（2026-04-21）

• 支持 iOS 与 Android 平台
• 提供 openAIStream，用于 OpenAI 兼容聊天流式请求
• 提供 streamRequest，用于通用 SSE 流式请求
• 支持 abortStream 与 abortRequest 取消请求
• 已适配 DashScope 兼容 OpenAI 接口的流式调用方式
• 提供完整 README、TypeScript 类型说明与示例

平台兼容性

uni-app(3.8.0)

其他

vm-openai

vm-openai 是一个 uni-app / uni-app x 的 UTS 插件，用于发起流式 AI 请求。

当前提供两个 API：

• openAIStream 面向 OpenAI 兼容聊天接口，直接返回增量文本
• streamRequest 面向通用 SSE 接口，原样返回 event / id / data

如果你希望直接复用聊天界面，可以搭配 vm-openai-ui 一起使用。

效果演示

平台支持

导入方式

import {
  openAIStream,
  abortStream,
  streamRequest,
  abortRequest
} from '@/uni_modules/vm-openai'

TypeScript 导入方式：

import {
  openAIStream,
  abortStream,
  streamRequest,
  abortRequest
} from '@/uni_modules/vm-openai'
import type {
  VMOpenAIChatMessage,
  VMOpenAISSECompleteEvent,
  VMOpenAISSEError,
  VMOpenAISSEEvent,
  VMOpenAIStreamChatOptions,
  VMOpenAIStreamChunkEvent,
  VMOpenAIStreamCompleteEvent,
  VMOpenAIStreamError,
  VMOpenAISSEOptions
} from '@/uni_modules/vm-openai/utssdk/interface.uts'

API 选择

openAIStream

最小示例：

openAIStream({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
  model: 'qwen-plus',
  messages: [
    { role: 'user', content: '你是谁？' }
  ],
  onOpen(res) {
    console.log('statusCode =', res.statusCode)
  },
  onChunk(res) {
    console.log('deltaText =', res.deltaText)
  },
  onError(err) {
    console.log('error =', err.message, err.statusCode, err.raw)
  },
  onComplete(res) {
    console.log('done =', res.cancelled)
  }
})

TypeScript 示例：

const messages: VMOpenAIChatMessage[] = [
  { role: 'user', content: '你是谁？' }
]

const options: VMOpenAIStreamChatOptions = {
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
  model: 'qwen-plus',
  messages,
  onChunk(res: VMOpenAIStreamChunkEvent) {
    console.log(res.deltaText)
  },
  onError(err: VMOpenAIStreamError) {
    console.log(err.message)
  },
  onComplete(res: VMOpenAIStreamCompleteEvent) {
    console.log(res.cancelled)
  }
}

openAIStream(options)

入参

messages 元素结构：

对应 TypeScript 类型：

type VMOpenAIChatMessage = {
  role: string
  content: string
}

回调出参

onLog(res)

onOpen(res)

onChunk(res)

onError(err)

onComplete(res)

说明：

• 如果传 baseURL，插件会自动补 /chat/completions
• 完整文本建议业务侧在 onChunk 中自行累积

streamRequest

最小示例：

streamRequest({
  url: 'https://example.com/sse',
  method: 'POST',
  headers: {
    Authorization: 'Bearer xxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    stream: true
  }),
  onOpen(res) {
    console.log('statusCode =', res.statusCode)
  },
  onEvent(res) {
    console.log('event =', res.event)
    console.log('id =', res.id)
    console.log('data =', res.data)
  },
  onError(err) {
    console.log('error =', err.message, err.statusCode, err.raw)
  },
  onComplete(res) {
    console.log('done =', res.cancelled)
  }
})

TypeScript 示例：

const options: VMOpenAISSEOptions = {
  url: 'https://example.com/sse',
  method: 'POST',
  headers: {
    Authorization: 'Bearer xxx',
    'Content-Type': 'application/json'
  } as UTSJSONObject,
  body: JSON.stringify({ stream: true }),
  onEvent(res: VMOpenAISSEEvent) {
    console.log(res.event, res.id, res.data)
  },
  onError(err: VMOpenAISSEError) {
    console.log(err.message)
  },
  onComplete(res: VMOpenAISSECompleteEvent) {
    console.log(res.cancelled)
  }
}

streamRequest(options)

入参

回调出参

onLog(res)

onOpen(res)

onEvent(res)

onError(err)

onComplete(res)

说明：

• streamRequest 不会帮你做 OpenAI JSON 解码
• 如果服务端返回的是 OpenAI 兼容 SSE，请在业务层自己解析 res.data

取消请求

取消后，onComplete 会回调：

onComplete(res) {
  if (res.cancelled) {
    console.log('request cancelled')
  }
}

DashScope / qwen-plus 示例

openAIStream({
  apiKey: 'YOUR_DASHSCOPE_API_KEY',
  baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
  model: 'qwen-plus',
  messages: [
    { role: 'user', content: '你好' }
  ],
  onChunk(res) {
    console.log(res.deltaText)
  }
})

建议