跳过主要内容
@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应用程序,然后扫描QRcode

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 规划仪表板和API操作,连接它 @capgo/capacitor-llm 查看@capgo/capacitor-llm的实现细节 开始使用 查看开始使用的实现细节 API概述 查看API概述的实现细节 介绍 查看介绍的实现细节 API密钥 查看API密钥的实现细节

FAQ

LLM插件FAQ

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

运行"bun add @capgo/capacitor-llm" (或 "npm install @capgo/capacitor-llm"),然后运行"bunx cap sync"以使iOS和Android项目捕获native code。从"@capgo/capacitor-llm"中导入它到您的应用code中。

是否@capgo/capacitor-llm与React、Vue和Angular兼容?

是。LLM是Capacitor包,因此它与任何运行在Capacitor内的Web框架兼容,包括Ionic、React、Vue、Angular、Svelte和纯JavaScript。

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

Capgo插件遵循Capacitor的主要版本:使用与Capacitor主要版本匹配的插件主要版本(例如插件v8与Capacitor 8)。兼容性表格在GitHub README中列出。

是否@capgo/capacitor-llm免费且开源?

是。code源代码在GitHub上公开,https://github.com/Cap-go/capacitor-llm/,并且可以从npm免费安装。欢迎bug报告和pull请求。

是否可以在App Store无需审核更新code使用LLM?

安装或升级插件会更改本机code,因此需要新的商店构建。之后,JavaScript、HTML和CSS更改,调用插件的更改,可以立即与Capgo实时更新一起发布。

Live Update

一旦插件在您的商店构建中,Capgo 即刻将您的 JavaScript、HTML 和 CSS 更改推送给用户。

开始使用 Capgo