Getting Started

Installieren

Sie können unsere KI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrer KI-Werkzeugleistung mit der folgenden Befehlszeile hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten aufgeführten Plattform-spezifischen Anweisungen:

bun add @capgo/capacitor-llm
bunx cap sync

Importieren

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

API Übersicht

createChat

Ein neues Chat-Session erstellt

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

await CapgoLLM.createChat();

sendMessage

Ein Nachricht an den AI in einer bestimmten Chat-Sitzung sendet

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

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

getReadiness

Ermittelt den Bereitschaftszustand des LLM

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

await CapgoLLM.getReadiness();

setModel

Setzt die Modellkonfiguration

• iOS: Verwende “Apple Intelligence” als Pfad für das Systemmodell oder gib den Pfad zum MediaPipe-Modell an
• Android: Pfad zu einem MediaPipe-Modell-Datei (in den assets- oder files-Verzeichnissen)

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

await CapgoLLM.setModel({} as ModelOptions);

downloadModel

Lädt ein Modell von einer URL herunter und speichert es an der entsprechenden Stelle

• iOS: Herunterlädt es in das Verzeichnis der Anwendungsdateien
• Android: Downloads in die App-Datei-Ordner

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

await CapgoLLM.downloadModel({} as DownloadModelOptions);

Typenverweis

ModelOptions

Optionen für die Modellkonfiguration.

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

Optionen für das Herunterladen eines Modells.

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

Ergebnis des Modellherunterladens.

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

TextFromAiEvent

Daten für Ereignisse zum Text, der von AI empfangen wurde.

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

Daten für Ereignisse zum Abschluss von AI.

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

DownloadProgressEvent

Daten für Ereignisse zum Download-Progress.

export interface DownloadProgressEvent {
  /** Percentage of download completed (0-100) */
  progress: number;
  /** Total bytes to download */
  totalBytes?: number;
  /** Bytes downloaded so far */
  downloadedBytes?: number;
}

ReadinessChangeEvent

Daten für Ereignisse zu Änderungen des Bereitschaftszustands.

export interface ReadinessChangeEvent {
  /** The readiness status */
  readiness: string;
}

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Weitermachen von Getting Started

Wenn Sie " Getting Started um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-llm für die native Fähigkeit in Mit @capgo/capacitor-llm, API Übersicht für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.