Skip to content

docs: update for pipecat PR #3939#589

Open
markbackman wants to merge 1 commit intomainfrom
docs/pr-3939
Open

docs: update for pipecat PR #3939#589
markbackman wants to merge 1 commit intomainfrom
docs/pr-3939

Conversation

@markbackman
Copy link
Contributor

Automated documentation update for pipecat PR #3939.

Changes

server/services/s2s/openai.mdx

  • Added OpenAIRealtimeLLMSettings configuration section documenting the new settings class
  • Added settings parameter to OpenAIRealtimeLLMService configuration
  • Marked session_properties and model constructor parameters as deprecated
  • Updated all usage examples to use settings=OpenAIRealtimeLLMSettings(...) pattern
  • Updated import statements to include OpenAIRealtimeLLMSettings
  • Documented bidirectional sync between model/system_instruction and session_properties.model/session_properties.instructions
  • Added runtime settings update examples showing both dict-style and delta-style updates
  • Added note about automatic routing of SessionProperties fields in settings updates

Summary

PR #3939 introduced a new settings pattern for OpenAI Realtime services, migrating from direct session_properties constructor parameter to a unified settings=OpenAIRealtimeLLMSettings(...) approach. This brings OpenAI Realtime in line with other Pipecat services that use the settings pattern and enables better runtime configuration management with bidirectional sync between top-level settings and session properties.

Gaps identified

None

- Add OpenAIRealtimeLLMSettings configuration section
- Deprecate session_properties and model constructor params
- Update usage examples to use settings=OpenAIRealtimeLLMSettings(...) pattern
- Document bidirectional sync between model/system_instruction and session_properties
- Add runtime settings update examples with automatic routing
- Update import statements in code examples
@markbackman markbackman added the auto-docs Automated documentation update from pipecat source changes label Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant