wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refine ServiceSettings docstring: clarify NOT_GIVEN semantics and fix frame reference

Browse Source 
Use wildcard `*UpdateSettingsFrame` to cover all frame types. Clarify that NOT_GIVEN only appears in update deltas, not in the service's current settings state.
This commit is contained in:
Paul Kompfner
2026-02-23 16:55:11 -05:00
parent 7556427862
commit 71fc078c24
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/pipecat/services/settings.py
View File

@@ -98,11 +98,13 @@ class ServiceSettings:
be changed **while the pipeline is running** (e.g. switching the model or be changed **while the pipeline is running** (e.g. switching the model or
changing the voice). They are *not* meant to capture every constructor changing the voice). They are *not* meant to capture every constructor
parameter — only those that support live updates via parameter — only those that support live updates via
``UpdateSettingsFrame``. ``*UpdateSettingsFrame``.
Every AI service type (LLM, TTS, STT) extends this with its own fields. Every AI service type (LLM, TTS, STT) extends this with its own fields.
Fields default to ``NOT_GIVEN`` so that an instance can represent either Fields default to ``NOT_GIVEN`` so that an instance can represent either
the full current state **or** a sparse update delta. the full current state **or** a sparse update delta. Note that in the full
current state, **all fields will be given** (i.e. ``NOT_GIVEN`` is reserved
for update deltas).
Parameters: Parameters:
model: The model identifier used by the service. model: The model identifier used by the service.