Skip to content

docs: note keyphrase uniqueness rule #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ruari-Phipps merged 1 commit into from
Sep 3, 2026
+9 −0
Merged

docs: note keyphrase uniqueness rule #310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/docs/reference/resources/speech_recognition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,19 @@ corrections:
replacement_type: partial
~~~

## Validation

- `interaction_style` must be one of `precise`, `balanced`, `swift`, `sonic`, or `turbo`.
- Each keyphrase must be non-empty, with a `level` of `default`, `boosted`, or `maximum`.
- Keyphrases must be unique once trimmed and lowercased — Agent Studio treats `Infusion Sets` and `infusion sets` as the same phrase, and rejects a project that keeps both.
- Each transcript correction needs a unique `name` and at least one regex rule, and every rule needs a `regular_expression`.
- `replacement_type` must be one of `full`, `partial`, or `substring`.

## Best practices

- use `keyphrase_boosting` for terms the recognizer is likely to miss
- keep boosted keyphrases focused and specific
- keep each keyphrase unique after trimming and lowercasing
- use transcript corrections for common, repeated recognition errors
- avoid overly broad regex rules that may alter normal input unexpectedly
- choose the ASR interaction style deliberately based on latency and accuracy needs
Expand Down
Loading