Skip to content

Fix Pipecat quickstart: correct package extra and service Settings API #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArchieMcM234 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix Pipecat quickstart: correct package extra and service Settings API #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/integrations-and-sdks/pipecat/assets/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,19 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
async with aiohttp.ClientSession() as session:
stt = SpeechmaticsSTTService(
api_key=os.getenv("SPEECHMATICS_API_KEY"),
params=SpeechmaticsSTTService.InputParams(
settings=SpeechmaticsSTTService.Settings(
turn_detection_mode=SpeechmaticsSTTService.TurnDetectionMode.EXTERNAL,
),
)
Comment on lines 37 to 42
Copy link

Copilot AI Mar 27, 2026

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.

Copilot uses AI. Check for mistakes.

llm = OpenAILLMService(
api_key=os.getenv("OPENAI_API_KEY"),
model="gpt-4o-mini",
settings=OpenAILLMService.Settings(model="gpt-4o-mini"),
)

tts = SpeechmaticsTTSService(
api_key=os.getenv("SPEECHMATICS_API_KEY"),
voice_id="sarah",
settings=SpeechmaticsTTSService.Settings(voice="sarah"),
aiohttp_session=session,
)

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations-and-sdks/pipecat/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ mkdir voice-agent && cd voice-agent
Create a `requirements.txt` file:

```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]
Copy link

Copilot AI Mar 27, 2026

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.

Copilot uses AI. Check for mistakes.
pipecat-ai-small-webrtc-prebuilt
python-dotenv
loguru
Expand Down
Loading