Update AICFilter documentation for aic-sdk v2 #511
Conversation
Co-authored-by: Andres O. Vela <andresovela@users.noreply.github.com>
Co-authored-by: Andres O. Vela <andresovela@users.noreply.github.com>
Co-authored-by: Andres O. Vela <andresovela@users.noreply.github.com>
markbackman
left a comment
markbackman
left a comment
There was a problem hiding this comment.
I'll defer on accuracy to the team. Approving and will merge once we ship the 0.0.101 release.
Co-authored-by: Andres O. Vela <andresovela@users.noreply.github.com>
| 1. Update Pipecat to the latest version (aic-sdk v2.x is included automatically) | ||
| 2. Remove deprecated constructor parameters (`model_type`, `enhancement_level`, `voice_gain`, `noise_gate_enable`) | ||
| 3. Add `model_id` parameter with an appropriate model (e.g., `"quail-vf-l-16khz"`) | ||
| 4. Replace `SileroVADAnalyzer` with `aic_filter.create_vad_analyzer()` for improved accuracy |
There was a problem hiding this comment.
Is this necessary for our migration guide?
There was a problem hiding this comment.
I rephrased the item without using any other analyzer class name: 068de21
Co-authored-by: Andres O. Vela <andresovela@users.noreply.github.com>
| 1. Update Pipecat to the latest version (aic-sdk v2.x is included automatically). | ||
| 2. Remove deprecated constructor parameters (`model_type`, `enhancement_level`, `voice_gain`, `noise_gate_enable`). | ||
| 3. Add `model_id` parameter with an appropriate model (e.g., `"quail-vf-l-16khz"`). | ||
| 4. Use `aic_filter.create_vad_analyzer()` for improved accuracy. |
There was a problem hiding this comment.
I'm still not sure if this is relevant for a migration guide. Maybe someone else can give their opinion too.
There was a problem hiding this comment.
I feel like a recommendation would be better instead of sounding like it's breaking something. Something like:
"We recommend to use aic_filter.create_vad_analyzer() for improved accuracy"
There was a problem hiding this comment.
This migration guide is not about the aic-sdk-py directly indeed. In the current doc version we have a reference about defining vad_analyzer parameter and I try to instruct the developers using our method directly. But still I am open to remove it completely.
how about this -> ddd4bf5
If no, I'm also okay to remove.
4 participants
blocked by: pipecat-ai/pipecat#3408
Summary
• Updates AICFilter documentation to reflect aic-sdk v2 API changes
• Replaces deprecated parameters (model_type, enhancement_level, voice_gain, noise_gate_enable) with new v2 parameters (model_id, model_path,
model_download_dir)
• Adds documentation for integrated VAD analyzer (create_vad_analyzer, get_vad_context) with configurable sensitivity parameters
• Includes an available models reference table and multiple usage examples (basic, local model, custom cache, other transports)
Test plan
• [ ] Verify all links are valid (ai-coustics.com, artifacts.ai-coustics.io, migration guide)
• [ ] Confirm code examples are syntactically correct
• [ ] Review model IDs match those available at artifacts.ai-coustics.io