GeezerVison is showing github.com — Fix Pipecat quickstart: correct package extra and service Settings API by ArchieMcM234 · Pull Request #232 · speechmatics/docs
Conversation
Two fixes to the Pipecat quickstart docs, caught during dogfooding:
index.mdx
- Changed pipecat-ai[local-smart-turn-v3,...] → pipecat-ai[local-smart-turn,...]
- The local-smart-turn-v3 extra doesn't exist in the package, causing an install warning
assets/main.py
- Updated service initialisation to use the current .Settings() API:
- SpeechmaticsSTTService: params=InputParams(...) → settings=Settings(...)
- OpenAILLMService: model="gpt-4o-mini" → settings=Settings(model="gpt-4o-mini")
- SpeechmaticsTTSService: voice_id="sarah" → settings=Settings(voice="sarah")
Testing
Followed the quickstart end-to-end with these changes:
- Install: clean, no warnings
- Bot started successfully and reached Uvicorn running on http://localhost:7860
- No DeprecationWarnings
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
…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
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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-ai extra in the quickstart requirements.txt example (local-smart-turn-v3 → local-smart-turn).
- Updates the quickstart
main.py example 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.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
|
|
|
|
```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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Copilot uses AI. Check for mistakes.
Comment on lines
37
to
42
|
|
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Copilot uses AI. Check for mistakes.
This branch was successfully deployed
1 active
deployment
Reviewers
lgavincrl
Awaiting requested review from lgavincrl
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.
|