Fix Pipecat quickstart: correct package extra and service Settings API#232
Fix Pipecat quickstart: correct package extra and service Settings API#232ArchieMcM234 wants to merge 1 commit intomainfrom
Conversation
…gs API - Fix requirements.txt: local-smart-turn-v3 → local-smart-turn (extra doesn't exist) - Update main.py: use .Settings() pattern for STT, LLM, and TTS service init
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates the Pipecat quickstart documentation to align with the current pipecat-ai package extras and the newer service initialization APIs, so users can follow the guide without install warnings or outdated parameters.
Changes:
- Fixes the
pipecat-aiextra in the quickstartrequirements.txtexample (local-smart-turn-v3→local-smart-turn). - Updates the quickstart
main.pyexample to use each service’s.Settings(...)API instead of deprecated/older constructor arguments.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/integrations-and-sdks/pipecat/index.mdx | Updates the quickstart dependency extra to a valid one. |
| docs/integrations-and-sdks/pipecat/assets/main.py | Migrates example service initialization to the Settings(...) configuration style. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```text title="requirements.txt" | ||
| pipecat-ai[local-smart-turn-v3,silero,speechmatics,webrtc,openai,runner] | ||
| pipecat-ai[local-smart-turn,silero,speechmatics,webrtc,openai,runner] |
There was a problem hiding this comment.
The requirements extra is now local-smart-turn, but the quickstart code uses LocalSmartTurnAnalyzerV3 (from local_smart_turn_v3). This name mismatch can confuse readers about which dependency provides the V3 analyzer. Consider adding a brief note here (or in the setup section) that the local-smart-turn extra includes the V3 analyzer, or adjust the wording to reduce the versioned naming ambiguity.
| stt = SpeechmaticsSTTService( | ||
| api_key=os.getenv("SPEECHMATICS_API_KEY"), | ||
| params=SpeechmaticsSTTService.InputParams( | ||
| settings=SpeechmaticsSTTService.Settings( | ||
| turn_detection_mode=SpeechmaticsSTTService.TurnDetectionMode.EXTERNAL, | ||
| ), | ||
| ) |
There was a problem hiding this comment.
This quickstart switches to the newer settings=...Settings(...) API for STT/LLM/TTS, but the other Pipecat docs/examples in this repo still use the older params=...InputParams(...) / voice_id=... style (e.g., docs/integrations-and-sdks/pipecat/stt.mdx and docs/integrations-and-sdks/pipecat/tts.mdx, plus assets/stt-full-example.py). Consider updating those pages/examples or adding a note about the new API to avoid readers mixing incompatible configuration styles.
Two fixes to the Pipecat quickstart docs, caught during dogfooding:
index.mdx
assets/main.py
Testing
Followed the quickstart end-to-end with these changes: