Getting Started

설치

플러그인을 설치하기 위해 AI-Assisted Setup을 사용할 수 있습니다. AI 도구에 Capgo 스킬을 추가하려면 다음 명령어를 사용하세요:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

그런 다음 다음 명령어를 사용하세요.

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-llm` plugin in my project.

만약 Manual Setup을 선호한다면, 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요.

bun add @capgo/capacitor-llm
bunx cap sync

Import

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

API 개요

createChat

새로운 채팅 세션을 생성합니다.

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

await CapgoLLM.createChat();

sendMessage

특정 채팅 세션에서 AI에게 메시지를 전송합니다.

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

await CapgoLLM.sendMessage({} as { chatId: string; message: string });

getReadiness

LLM의 준비 상태를 가져옵니다.

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

await CapgoLLM.getReadiness();

setModel

모델 설정을 지정합니다.

• iOS: 시스템 모델을 위한 '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

__CAPGO_KEEP_0__

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_0__

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_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_1__

export interface AiFinishedEvent {
  /** The chat session ID that finished */
  chatId: string;
}

DownloadProgressEvent

다운로드 진행률에 대한 이벤트 데이터.

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의 upstream에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속

__CAPGO_KEEP_0__를 사용 중이라면 시작하기 API 대시보드와 API 운영을 계획하고 연결하기 위해 capgo/capacitor-llm을 사용하는 방법 capgo/capacitor-llm의 원시 기능을 사용하는 방법 API 개요 API 개요의 구현 세부 정보 소개 소개의 구현 세부 정보 API 키 API 키의 구현 세부 정보 장치 장치의 구현 세부 정보