Iniziata alla Guida

Installa

bun add @capgo/capacitor-llm
bunx cap sync

Importa

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

API Panoramica

createChat

Crea una nuova sessione di chat

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

await CapgoLLM.createChat();

sendMessage

Inviare un messaggio all'AI in una sessione di chat specifica

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

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

getReadiness

Ottiene lo stato di preparazione del modello

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

await CapgoLLM.getReadiness();

setModel

Imposta la configurazione del modello

• iOS: utilizza “Intelligenza Apple” come percorso per il modello di sistema, o fornisce il percorso al modello MediaPipe
• Android: percorso a un file del modello MediaPipe (in directory degli asset o dei file)

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

await CapgoLLM.setModel({} as ModelOptions);

downloadModel

Scarica un modello da una URL e salvalo nella posizione appropriata

• iOS: scarica nella directory dei documenti dell'app
• Android: scarica nella directory dei file dell'app

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

await CapgoLLM.downloadModel({} as DownloadModelOptions);

Riferimento di tipo

ModelOptions

Opzioni di configurazione del modello.

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

Opzioni per il download di un modello.

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

Risultato del download del modello.

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

TextFromAiEvent

Dati dell'evento per il testo ricevuto dall'IA.

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

Dati dell'evento per la conclusione dell'IA.

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

DownloadProgressEvent

Dati dell'evento per il progresso del download.

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

ReadinessChangeEvent

Dati dell'evento per i cambiamenti di stato di disponibilità.

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

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.tsRiepilogare la sincronizzazione quando le informazioni pubbliche API cambiano in modo upstream.

Continua da Inizia con l'installazione

Se stai utilizzando Inizia con l'installazione per pianificare il dashboard e le operazioni API, connettilo con Utilizza @capgo/capacitor-llm per la capacità nativa in Utilizza @capgo/capacitor-llm, Panoramica di API per i dettagli di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.