docs(asr): clarify vocabulary alias match semantics - #834
Open
CiprianSpiridon wants to merge 3 commits into
Open
docs(asr): clarify vocabulary alias match semantics#834CiprianSpiridon wants to merge 3 commits into
CiprianSpiridon wants to merge 3 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why is this change needed?
FluidAudio's custom-vocabulary candidate API exposes both
matchedAliasandsimilarity. The documentation currently callsmatchedAlias"the exact alias," but the implementation selects the configured form with the best fuzzy string-similarity score. That wording can cause a downstream app to treat the presence of an alias as authoritative evidence and replace ordinary speech with an unrelated technical term.This PR is documentation-only. It clarifies the existing API contract:
matchedAliasis the configured alias that won fuzzy ranking; its presence does not prove an exact spoken match.similarity == 1.0when they need to distinguish a perfect scorer result from a fuzzy result.FluidAudio remains responsible for reporting candidate evidence. Consumer applications remain responsible for replacement policy. For example, Kensi derives its own internal exact-score flag from
similarityand combines it with its own collision and context rules; no Kensi-specific policy or new convenience API is added to FluidAudio.There are no runtime, scoring, threshold, replacement, or public API changes. The final diff changes one Markdown documentation file only.