跳转至正文
@capgo/capacitor-llm 设备 API 开源

LLM Capacitor 插件

支持 Apple Intelligence 和 MLX,在设备端本地运行大语言模型

安装

bun add @capgo/capacitor-llm bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-llm
  • pnpm add @capgo/capacitor-llm
  • yarn add @capgo/capacitor-llm

指南

如何在 Capacitor 中使用 LLM

在设备上测试

下载 Capgo App,然后扫描二维码 code。

LLM 插件预览二维码 code

使用 @capgo/capacitor-llm

用于与设备端语言模型交互的 LLM 插件接口。

安装

bun add @capgo/capacitor-llm
bunx cap sync

插件暴露的内容

  • createChat - 创建新的聊天会话。
  • sendMessage - 在特定聊天会话中向 AI 发送消息。
  • getReadiness - 获取 LLM 的就绪状态。
  • setModel - 设置模型配置 - iOS:使用 "Apple Intelligence" 作为系统模型路径,或提供 MediaPipe 模型路径 - Android:MediaPipe 模型文件的路径(位于 assets 或 files 目录)。

用法示例

createChat

创建新的聊天会话。

import { CapgoLLM } from '@capgo/capacitor-llm';

const result = await CapgoLLM.createChat();
console.log(result);

sendMessage

向特定聊天会话中的 AI 发送消息。

import { CapgoLLM } from '@capgo/capacitor-llm';

await CapgoLLM.sendMessage({
  chatId: 'chat-id-123',
  message: 'Hello from Capacitor',
});

getReadiness

获取 LLM 的就绪状态。

import { CapgoLLM } from '@capgo/capacitor-llm';

const result = await CapgoLLM.getReadiness();
console.log(result);

setModel

- 设置模型配置 - iOS:使用 "Apple Intelligence" 作为系统模型路径,或提供 MediaPipe 模型路径 - Android:MediaPipe 模型文件的路径(位于 assets 或 files 目录)。

import { CapgoLLM } from '@capgo/capacitor-llm';

await CapgoLLM.setModel({
  path: 'path/to/file',
  modelType: 'task',
});

完整参考

继续阅读 使用 @capgo/capacitor-llm

如果你正在使用 使用 @capgo/capacitor-llm 要规划 dashboard 和 API 操作,请将其连接到 @capgo/capacitor-llm 有关 @capgo/capacitor-llm 的实现细节, 快速入门 有关“入门指南”中的实现细节, API 概览 关于 API Overview 中的实现细节, 简介 关于简介中的实现细节,以及 API 密钥 关于 API Keys 中的实现细节。

常见问题

LLM 插件常见问题

如何在 Capacitor 应用中安装 LLM 插件?

运行 "bun add @capgo/capacitor-llm" (或 "npm install @capgo/capacitor-llm"),然后运行 "bunx cap sync",使 iOS 和 Android 项目同步 native code。最后在你的应用 code 中从 "@capgo/capacitor-llm" 导入即可。

@capgo/capacitor-llm 是否支持 React、Vue 和 Angular?

支持。LLM 是一个 Capacitor 包,因此任何运行在 Capacitor 里的 Web 框架都能用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-llm 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-llm 是免费开源的吗?

是的。code 的源码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-llm/,该包也可以从 npm 免费安装。欢迎提交 Bug 反馈和 Pull Request。

使用 LLM 的 code 可以在不经过 App Store 审核的情况下更新吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待应用审核,即可发布 LLM 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo