Getting Started

Installieren

bun add @capgo/capacitor-llm
bunx cap sync

Importieren

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

API Übersicht

createChat

Eine neue Chat-Sitzung erstellen

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

await CapgoLLM.createChat();

sendMessage

Sendet eine Nachricht an das AI-Modell in einer bestimmten Chat-Sitzung

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

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

getReadiness

Ermittelt den Bereitschaftsstatus des LLM

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

await CapgoLLM.getReadiness();

setModel

Konfiguriert das Modell

• iOS: Verwenden Sie „Apple Intelligence“ als Pfad für das Systemmodell oder geben Sie 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

Ein Modell von einer URL herunterlädt und speichert es an der entsprechenden Stelle

• iOS: Herunterlädt in den Verzeichnis der Anwendungsdateien
• Android: Herunterlädt in das Verzeichnis der Anwendungsdateien

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

await CapgoLLM.downloadModel({} as DownloadModelOptions);

Typenverweis

ModelOptions

Modellkonfigurationsoptionen

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 der Modellherunterladung.

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

TextFromAiEvent

Daten zum Text, der von der KI 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 zum Abschluss der KI-Arbeit.

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

DownloadProgressEvent

Daten zum Downloadfortschritt.

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 Änderungen des Bereitschaftszustands.

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

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Hintergrund ändert, führen Sie die Synchronisation erneut durch.

Weiter von Getting Started

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