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

Improve _extract_initial_system_or_developer docstring clarity

Browse Source
This commit is contained in:
Paul Kompfner
2026-03-20 14:11:40 -04:00
parent 45178972d7
commit e29a63e1ae
1 changed files with 20 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/pipecat/adapters/base_llm_adapter.py
View File

@@ -141,25 +141,33 @@ class BaseLLMAdapter(ABC, Generic[TLLMInvocationParams]):
*,
system_instruction: Optional[str],
) -> Tuple[Optional[str], Optional[str]]:
"""Extract an initial system/developer message from messages, if appropriate.
"""Extract an initial system/developer message for use as a system instruction.
Only useful for services that expect the system instruction as a
separate parameter, not inline in conversation history (today, all
non-OpenAI services).
Checks ``messages[0]``. Behavior:
- ``"system"`` role: always extract (pop from messages).
- ``"developer"`` role **without** ``system_instruction``: extract (pop).
- ``"developer"`` role **with** ``system_instruction``: don't extract;
convert to ``"user"`` in-place.
- ``"system"`` role: assumed to be intended as the system instruction.
Extract (pop from messages).
- ``"developer"`` role **without** ``system_instruction``: also assumed
to be intended as the system instruction. Extract (pop).
- ``"developer"`` role **with** ``system_instruction``: assumed to be
intended as a conversation-history message (since a system instruction
is already provided). Don't extract; convert to ``"user"`` in-place.
- Any other role: no-op.
If extracting would leave the messages list empty (``len(messages) == 1``),
the message is converted to ``"user"`` role instead of being extracted.
This prevents sending an empty conversation history to providers that
require at least one non-system message (e.g. Anthropic, Bedrock).
If extracting would leave the messages list empty
(``len(messages) == 1``), the message is converted to ``"user"`` role
instead of being extracted. This prevents sending an empty conversation
history to providers that require at least one non-system message
(e.g. Anthropic, Bedrock).
Args:
messages: Provider-formatted message list (mutated in-place).
system_instruction: The system instruction from service settings or
``run_inference``, used to decide whether to extract a
messages: Message list in standard format (mutated in-place).
system_instruction: The system instruction from service settings
or ``run_inference``, used to decide whether to extract a
``"developer"`` message.
Returns: