misaki_vi library
Vietnamese APIs for the pure, backend-injected Misaki Dart pipeline.
The phonology and cleaner are bundled and run offline. Applications must supply an underthesea-compatible tokenizer; an English fallback is optional and is never discovered or downloaded automatically.
final engine = VietnameseG2pEngine(tokenizer: tokenizerBackend);
final result = engine.convert('xin chào');
print(result.phonemes);
Classes
- AsyncG2pEngine
- A reusable engine whose backend requires asynchronous work.
- BackendInfo
- Stable identity information reported by an injected backend.
- EnglishTokenMetadata
- Metadata produced by the English pipeline.
- G2pEngine
- A synchronous, reusable grapheme-to-phoneme engine.
- G2pResult
- Exact output from one grapheme-to-phoneme conversion.
- JapaneseTokenMetadata
- Metadata produced by the pyopenjtalk-style Japanese pipeline.
- KokoroEnglishG2pFrontend
- Kokoro 0.9.4's token-aware English G2P frontend.
- KokoroG2pChunk
- One text-and-phoneme chunk ready for Kokoro model input preparation.
- KokoroNonEnglishG2pFrontend
- Kokoro 0.9.4's pre-G2P chunking contract for non-English languages.
- MisakiBackend
- Common contract for explicitly supplied language backends.
- MisakiToken
- Immutable token shared by all language engines.
- TokenMetadata
- Language-specific, typed token details.
- UnknownMarkerG2pEngine
- A synchronous G2P engine whose unresolved-token marker is inspectable.
- VietnameseEnglishFallbackBackend
- Optional English fallback used only after Vietnamese transcription fails.
- VietnameseG2pEngine
- Pure Vietnamese pipeline with explicit tokenizer and optional English fallback providers.
- VietnameseOptions
- Immutable Vietnamese engine options.
- VietnameseTokenizerBackend
-
Explicit tokenizer boundary matching underthesea's
tokenizefunction. - VietnameseTokenMetadata
- Metadata produced by the Vietnamese pipeline.
Enums
- VietnameseDialect
- Vietnamese pronunciation dialect.
- VietnameseToneType
-
Upstream
tone_typeselection.
Constants
- defaultUnknownMarker → const String
- Default replacement for text that a selected engine cannot phonemize.
- misakiUpstreamCommit → const String
- The authoritative upstream revision for fixtures and copied data.
- misakiUpstreamRepository → const String
- The upstream project whose observable behavior this package ports.
- misakiUpstreamVersion → const String
- The Python package version at misakiUpstreamCommit.
Functions
-
vietnamesePhonemeInventory(
) → Set< String> -
Returns the frozen pinned Vietnamese
vi_symsinventory.
Exceptions / Errors
- BackendFailureException
- A configured backend failed while processing input.
- A required explicitly configured backend is not available.
- InvalidConfigurationException
- The selected options do not form a supported configuration.
- MalformedDataException
- Generated or copied runtime data failed validation.
- MisakiException
- Base class for failures exposed by Misaki Dart APIs.