FlutterEdgeAiMobile class

Inheritance

• Object
• PlatformInterface
• FlutterEdgeAiPlugin
• FlutterEdgeAiMobile

Constructors

FlutterEdgeAiMobile()

Properties

enableHnsw ↔ bool

Legacy no-op kept for source compatibility.

getter/setter pair, override

hashCode → int

The hash code for this object.

no setter, inherited

initializedEmbeddingModel → EmbeddingModel?

no setter, override

initializedModel → InferenceModel?

no setter, override

modelManager → MobileModelManager

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addDocument({required String id, required String content, String? metadata}) → Future<void>

Add document to vector store (will compute embedding automatically).

override

addDocumentWithEmbedding({required String id, required String content, required List<double> embedding, String? metadata}) → Future<void>

Add document to vector store with pre-computed embedding.

override

clearVectorStore() → Future<void>

Clear all documents from vector store.

override

createEmbeddingModel({String? modelPath, String? tokenizerPath, PreferredBackend? preferredBackend}) → Future<EmbeddingModel>

Creates and returns a new EmbeddingModel instance.

override

createModel({required ModelType modelType, ModelFileType fileType = ModelFileType.task, int maxTokens = 1024, PreferredBackend? preferredBackend, PreferredBackend? preferredVisionBackend, PreferredBackend? preferredAudioBackend, List<int>? loraRanks, int? maxNumImages, bool supportImage = false, bool supportAudio = false, bool? enableSpeculativeDecoding, ActivationDataType? activationDataType, int? maxConcurrentSessions}) → Future<InferenceModel>

Creates and returns a new InferenceModel instance.

override

createSttModel({String? modelPath, String? tokenizerPath, PreferredBackend? preferredBackend, String? language}) → Future<SpeechRecognizer>

Creates and returns a new SpeechRecognizer instance.

override

createTtsModel({PreferredBackend? preferredBackend, String? language}) → Future<SpeechSynthesizer>

Creates and returns a new SpeechSynthesizer for the active TTS model.

override

flushVectorStore() → Future<void>

Persist everything written to the vector store so far, without closing it.

override

getVectorStoreStats() → Future<VectorStoreStats>

Get vector store statistics.

override

initializeVectorStore(String databasePath) → Future<void>

=== RAG functionality === Initialize vector store database.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeDocument({required String id}) → Future<void>

Remove a single document from the vector store by ID. No-op if absent.

override

searchSimilar({required String query, int topK = 5, double threshold = 0.0, Filter? filter}) → Future<List<RetrievalResult>>

Search for similar documents.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited