Getting Started

インストール

CapgoのAIアシストセットアップを使用してプラグインをインストールできます。次のコマンドを使用して、CapgoスキルをAIツールに追加します。

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 { 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

モデルをダウンロードするためのオプション

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

モデルダウンロードの結果

export interface DownloadModelResult {
  /** Path where the model was saved */
  path: string;
  /** Path where the companion file was saved (if applicable) */
  companionPath?: string;
}

TextFromAiEvent

AIから受信したテキストのイベントデータ

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

AI完了のイベントデータ

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.tsパブリックAPIがアップストリームで変更されたときに再度同期してください

続けて「Getting Started」から進みます

あなたが「{0}」を使用している場合 「{0}」 {0}を使用してダッシュボードとAPIの操作を計画する場合、{0}をAPIに接続してください {0}の@capgo/capacitor-llmを使用して {0}の@capgo/capacitor-llmのネイティブ機能を使用して API Overview for the implementation detail in API Overview, {0}の導入 {0}の導入の実装詳細 API Keys for the implementation detail in API Keys, and デバイス デバイスの実装詳細について