Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice la siguiente solicitud:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-llm
bunx cap sync

Importar

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

API Resumen

createChat

Crea una nueva sesión de chat

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

const result = await CapgoLLM.createChat();
console.log(result);

sendMessage

Envía un mensaje al modelo de inteligencia en una sesión de chat específica

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

await CapgoLLM.sendMessage({
  chatId: 'chat-id-123',
  message: 'Hello from Capacitor',
});

getReadiness

Obtiene el estado de preparación del modelo LLM

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

const result = await CapgoLLM.getReadiness();
console.log(result);

setModel

Establece la configuración del modelo

• iOS: Utilice “Inteligencia de Apple” como ruta para el modelo del sistema, o proporcione la ruta al modelo de MediaPipe
• Android: Ruta a un archivo de modelo de MediaPipe (en directorio de assets o archivos)

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

await CapgoLLM.setModel({
  path: 'path/to/file',
  modelType: 'task',
});

downloadModel

Descarga un modelo desde una URL y lo almacena en la ubicación adecuada

• iOS: Descarga en el directorio de documentos de la aplicación
• Android: Descarga en el directorio de archivos de la aplicación

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

const result = await CapgoLLM.downloadModel({ url: 'https://example.com' });
console.log(result);

Referencia de tipo

ModelOptions

Opciones de configuración del modelo

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

Opciones para descargar un modelo.

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

Resultado de la descarga del modelo.

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

TextFromAiEvent

Datos del evento para texto recibido de 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

Datos del evento para la finalización de IA.

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

DownloadProgressEvent

Datos del evento para el progreso de descarga.

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

ReadinessChangeEvent

Datos de evento para cambios de estado de disponibilidad.

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

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.ts. Vuelve a ejecutar la sincronización cuando el público API cambie en la fuente.

Sigue adelante desde Inicio rápido

Si estás utilizando Getting Started para planificar la pantalla de dashboard y las operaciones API, conecta con Usando @capgo/capacitor-llm para la capacidad nativa en Usando @capgo/capacitor-llm, Resumen de API para el detalle de implementación en API Overview, Introducción para el detalle de implementación en Introducción, API Keys para el detalle de implementación en API Keys, y Dispositivos para los detalles de implementación en dispositivos.