__CAPGO_KEEP_1__
설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 지시서를 복사하세요.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-llm`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/llm/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
설치
설치bun add @capgo/capacitor-llmbunx cap syncimport
importimport { CapgoLLM } from '@capgo/capacitor-llm';API 개요
API 개요createChat
createChat채팅 세션을 새로 생성합니다.
import { CapgoLLM } from '@capgo/capacitor-llm';
await CapgoLLM.createChat();sendMessage
sendMessage특정 채팅 세션에서 AI에게 메시지를 전송합니다.
import { CapgoLLM } from '@capgo/capacitor-llm';
await CapgoLLM.sendMessage({} as { chatId: string; message: string });getReadiness
getReadinessLLM의 준비 상태를 가져옵니다.
import { CapgoLLM } from '@capgo/capacitor-llm';
await CapgoLLM.getReadiness();setModel
setModeliOS: 시스템 모델의 경로로 "Apple Intelligence"를 사용하거나 MediaPipe 모델의 경로를 제공합니다.
- Android: MediaPipe 모델 파일의 경로 (자산 또는 파일 디렉토리)
- 복사
import { CapgoLLM } from '@capgo/capacitor-llm';
await CapgoLLM.setModel({} as ModelOptions);downloadModel
다운로드 모델 섹션 제목URL에서 모델을 다운로드하고 적절한 위치에 저장합니다.
- iOS: 앱의 문서 폴더에 다운로드합니다.
- Android: 앱의 파일 폴더에 다운로드합니다.
import { CapgoLLM } from '@capgo/capacitor-llm';
await CapgoLLM.downloadModel({} as DownloadModelOptions);타입 참조
타입 참조 섹션 제목ModelOptions
모델 옵션 섹션 제목모델 구성 옵션입니다.
export interface ModelOptions { /** Model path or "Apple Intelligence" for iOS system model */ path: string; /** Model file type/extension (e.g., "task", "bin", "litertlm"). If not provided, will be extracted from path. */ modelType?: string; /** Maximum number of tokens the model handles */ maxTokens?: number; /** Number of tokens the model considers at each step */ topk?: number; /** Amount of randomness in generation (0.0-1.0) */ temperature?: number; /** Random seed for generation */ randomSeed?: number;}DownloadModelOptions
다운로드 모델 옵션 섹션 제목다운로드 모델 옵션입니다.
export interface DownloadModelOptions { /** URL of the model file to download */ url: string; /** Optional: URL of companion file (e.g., .litertlm for Android) */ companionUrl?: string; /** Optional: Custom filename (defaults to filename from URL) */ filename?: string;}DownloadModelResult
__CAPGO_KEEP_1____CAPGO_KEEP_2__
export interface DownloadModelResult { /** Path where the model was saved */ path: string; /** Path where the companion file was saved (if applicable) */ companionPath?: string;}TextFromAiEvent
__CAPGO_KEEP_3____CAPGO_KEEP_4__
export interface TextFromAiEvent { /** The text content from AI - this is an incremental chunk, not the full text */ text: string; /** The chat session ID */ chatId: string; /** Whether this is a complete chunk (true) or partial streaming data (false) */ isChunk?: boolean;}AiFinishedEvent
__CAPGO_KEEP_5____CAPGO_KEEP_0__
export interface AiFinishedEvent { /** The chat session ID that finished */ chatId: string;}DownloadProgressEvent
__CAPGO_KEEP_0____CAPGO_KEEP_7__
export interface DownloadProgressEvent { /** Percentage of download completed (0-100) */ progress: number; /** Total bytes to download */ totalBytes?: number; /** Bytes downloaded so far */ downloadedBytes?: number;}ReadinessChangeEvent
« 준비 상태 변경 이벤트 » 섹션준비 상태 변경 이벤트 데이터.
export interface ReadinessChangeEvent { /** The readiness status */ readiness: string;}진실의 근원
« 진실의 근원 » 섹션이 페이지는 플러그인의 src/definitions.tsAPI의 공개 버전이 업스트림에서 변경될 때 다시 싱크를 실행하세요.
Getting Started에서 계속
« Getting Started에서 계속 » 섹션__CAPGO_KEEP_0__이 업스트림에서 변경되었을 때 다시 싱크를 실행하세요. Getting Started를 사용 중이라면 대시보드와 API 운영을 계획하고 연결하세요. Using @capgo/capacitor-llm Using @capgo/capacitor-llm API 개요 API 개요 소개 소개 API 키 API 키 기기 기기