Skip to content

docs: update for pipecat PR #4141#678

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

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

Conversation

@markbackman
Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat PR #4141.

Changes

Updated server/services/llm/openai-responses.mdx:

  • Documented new WebSocket-based OpenAIResponsesLLMService as the default implementation
  • Added documentation for OpenAIResponsesHttpLLMService (HTTP variant)
  • Added "WebSocket vs HTTP" section explaining when to use each variant
  • Updated Configuration section to include ws_url parameter for WebSocket variant
  • Updated Usage examples to show both WebSocket and HTTP variants
  • Added notes about persistent WebSocket connections, incremental context optimization via previous_response_id, and the connection-local cache
  • Clarified that both variants have identical constructor arguments and settings

Gaps identified

None - the OpenAI Responses service already had a dedicated documentation page at server/services/llm/openai-responses.mdx.

Breaking change noted

The documentation now clearly states that OpenAIResponsesLLMService uses WebSocket transport by default. Users who need HTTP streaming behavior should switch to OpenAIResponsesHttpLLMService.

Updates documentation for pipecat PR #4141:

- Document new WebSocket-based OpenAIResponsesLLMService as the default
- Add documentation for OpenAIResponsesHttpLLMService (HTTP variant)
- Add "WebSocket vs HTTP" section explaining when to use each
- Update Configuration section with ws_url parameter
- Update Usage examples to show both variants
- Add notes about persistent WebSocket connections and incremental context optimization
- Clarify that both variants have identical constructor args and settings

Breaking change: OpenAIResponsesLLMService now uses WebSocket transport.
Users who need HTTP streaming should use OpenAIResponsesHttpLLMService.
@markbackman markbackman added the auto-docs Automated documentation update from pipecat source changes label Mar 30, 2026
@mintlify
Copy link
Copy Markdown

mintlify bot commented Mar 30, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview Mar 30, 2026, 7:30 PM

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