Skip to content

docs: update for pipecat PR #4588#871

Open
markbackman wants to merge 1 commit into
mainfrom
docs/pr-4588
Open

docs: update for pipecat PR #4588#871
markbackman wants to merge 1 commit into
mainfrom
docs/pr-4588

Conversation

@markbackman
Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat PR #4588.

Changes

Updated Reference Pages

  • aic-filter.mdx:
    • Added deprecation warning for create_vad_analyzer() method (will be removed in 1.6.0)
    • Updated all code examples to use AIC_SDK_LICENSE environment variable instead of AIC_LICENSE_KEY
    • Replaced usage examples to show AICQuailVADAnalyzer as the recommended approach
    • Updated migration guide with new environment variable and VAD deprecation information
    • Added note about environment variable change in the Notes section

New Service Pages

  • aic-quail-vad-analyzer.mdx: Created comprehensive documentation for the new standalone Quail VAD 2.0 analyzer, including:
    • Overview and comparison to deprecated AICVADAnalyzer
    • Constructor parameters with detailed descriptions
    • Usage examples (basic, with custom parameters, VAD-only without enhancement, local model)
    • Comparison table highlighting differences from deprecated analyzer
    • Audio flow diagram
    • Installation and configuration instructions

Configuration Updates

  • docs.json: Added new page to Audio Processing section in alphabetical order, with redirect mapping

Summary

PR #4588 introduces the new AICQuailVADAnalyzer as the recommended approach for voice activity detection with ai-coustics, deprecating the previous AICVADAnalyzer and AICFilter.create_vad_analyzer(). The environment variable has also been updated from AIC_LICENSE_KEY to AIC_SDK_LICENSE to match the SDK's canonical naming.

Gaps identified

None - all changed source files were mapped and documented appropriately.

- Add deprecation warning to AICFilter.create_vad_analyzer()
- Update all examples to use AIC_SDK_LICENSE instead of AIC_LICENSE_KEY
- Add new AICQuailVADAnalyzer documentation page
- Update migration guide with environment variable change
- Replace deprecated VAD method usage with AICQuailVADAnalyzer in examples
@markbackman markbackman added auto-docs Automated documentation update from pipecat source changes pipecat labels Jun 4, 2026
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 4, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview Jun 4, 2026, 11:13 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes pipecat

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant