Update AICFilter documentation for aic-sdk v2 #511
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
andresovela
suggested changes
Jan 20, 2026
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>
andresovela
suggested changes
Jan 20, 2026
| To use AIC, you need a license key. Get started at [ai-coustics.com](https://ai-coustics.com/pipecat). | ||
|
|
||
| <Note> | ||
| This documentation covers **aic-sdk v2.x**. If you're using aic-sdk v1.x, please upgrade to v2 first. See the [Python 1.3 to 2.0 Migration Guide](https://docs.ai-coustics.com/guides/migrations/python-1-3-to-2-0#quick-migration-checklist) for details on API changes. |
There was a problem hiding this comment.
Is this relevant for pipecat users?
There was a problem hiding this comment.
I think so. Especially the license key and model changes.
There was a problem hiding this comment.
True. I guess that makes sense. I wonder if we need a special, shorter pipecat migration guide.
Comment on lines
+196
to
+208
| ## Available Models | ||
|
|
||
| Models are hosted at [artifacts.ai-coustics.io](https://artifacts.ai-coustics.io/). Common model options include: | ||
|
|
||
| | Model ID | Sample Rate | Description | | ||
| |----------|-------------|-------------| | ||
| | `quail-vf-l-16khz` | 16kHz | Voice filtering, large model | | ||
| | `quail-l-16khz` | 16kHz | Large model | | ||
| | `quail-l-8khz` | 8kHz | Large model for telephony | | ||
| | `quail-s-16khz` | 16kHz | Small model for low latency | | ||
| | `quail-s-8khz` | 8kHz | Small model for telephony | | ||
|
|
||
| Choose a model based on your sample rate requirements and latency constraints. |
There was a problem hiding this comment.
We should try to have a single source of truth for stuff like this.
Suggested change
| ## Available Models | |
| Models are hosted at [artifacts.ai-coustics.io](https://artifacts.ai-coustics.io/). Common model options include: | |
| | Model ID | Sample Rate | Description | | |
| |----------|-------------|-------------| | |
| | `quail-vf-l-16khz` | 16kHz | Voice filtering, large model | | |
| | `quail-l-16khz` | 16kHz | Large model | | |
| | `quail-l-8khz` | 8kHz | Large model for telephony | | |
| | `quail-s-16khz` | 16kHz | Small model for low latency | | |
| | `quail-s-8khz` | 8kHz | Small model for telephony | | |
| Choose a model based on your sample rate requirements and latency constraints. | |
| ## Models | |
| For detailed information about the available models, take a look at the [Models documentation](https://docs.ai-coustics.com/guides/models). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
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