react-native-apple-llm/lib/typescript/index.d.ts

React Native plugin for Apple Intelligence and Foundation Models

import { FoundationModelsAvailability, LLMConfigOptions, LLMGenerateOptions, LLMGenerateTextOptions, LLMGenerateWithToolsOptions, ToolDefinition } from "./types";
/**
 * Check if Foundation Models (Apple Intelligence) are enabled and available.
 * Returns a string status: 'available', 'appleIntelligenceNotEnabled', 'modelNotReady', 'unavailable'.
 */
export declare const isFoundationModelsEnabled: () => Promise<FoundationModelsAvailability>;
/**
 * Class-based session management for Apple LLM
 */
export declare class AppleLLMSession {
    private toolHandlers;
    private eventEmitter;
    private isConfigured;
    private activeToolListener?;
    constructor();
    /**
     * Configure the session with options and tools
     */
    configure(options: LLMConfigOptions, tools?: ToolDefinition[]): Promise<boolean>;
    /**
     * Generate text using text parameter
     */
    generateText(options: LLMGenerateTextOptions): Promise<any>;
    /**
     * Generate structured output using a JSON shape as the schema
     */
    generateStructuredOutput(options: LLMGenerateOptions): Promise<any>;
    /**
     * Generate text with tool calling capabilities
     */
    generateWithTools(options: LLMGenerateWithToolsOptions): Promise<any>;
    /**
     * Register a tool that can be called by the LLM
     */
    private registerTool;
    /**
     * Reset the session
     */
    reset(): Promise<boolean>;
    /**
     * Dispose of the session and clean up resources
     */
    dispose(): void;
    private ensureConfigured;
}
/**
 * @deprecated Use AppleLLMSession class instead
 */
export declare const configureSession: (options: LLMConfigOptions, tools?: ToolDefinition[]) => Promise<boolean>;
/**
 * @deprecated Use AppleLLMSession class instead
 */
export declare const generateText: (options: LLMGenerateTextOptions) => Promise<any>;
/**
 * @deprecated Use AppleLLMSession class instead
 */
export declare const generateStructuredOutput: (options: LLMGenerateOptions) => Promise<any>;
/**
 * @deprecated Use AppleLLMSession class instead
 */
export declare const generateWithTools: (options: LLMGenerateWithToolsOptions) => Promise<any>;
/**
 * @deprecated Use AppleLLMSession class instead
 */
export declare const resetSession: () => Promise<boolean>;
export * from "./types";
//# sourceMappingURL=index.d.ts.map