Skip to content

docs: update for pipecat PR #4074#633

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

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

Conversation

@markbackman
Copy link
Contributor

Automated documentation update for pipecat PR #4074.

Changes

New service page

  • server/services/llm/openai-responses.mdx — Created documentation for the new OpenAIResponsesLLMService which uses OpenAI's Responses API (different from the Chat Completions API). Includes:
    • Overview and comparison with standard OpenAI service
    • Installation and prerequisites
    • Configuration parameters and settings
    • Usage examples (basic setup, custom settings, runtime updates, out-of-band inference)
    • Notes on Responses API vs Chat Completions API
    • Event handlers

Updated navigation

  • docs.json — Added server/services/llm/openai-responses to the LLM group (alphabetically after openai)

Updated service listing

  • server/services/supported-services.mdx — Added "OpenAI Responses" entry to the LLM services table

Gaps identified

None. All relevant source files from PR #4074 have been documented:

  • src/pipecat/services/openai/responses/llm.py → New doc page created
  • ⏭️ Other changed files (adapters, utils, tests, examples) don't require documentation updates

Add documentation for the new OpenAIResponsesLLMService introduced in
pipecat PR #4074. This service uses OpenAI's Responses API (different
from the Chat Completions API used by the standard OpenAILLMService).

Changes:
- Add new doc page: server/services/llm/openai-responses.mdx
- Add to navigation in docs.json (LLM group)
- Add to supported-services.mdx (LLM section)

The new service supports streaming text, function calling, usage metrics,
and out-of-band inference with the universal LLMContext.
@markbackman markbackman added the auto-docs Automated documentation update from pipecat source changes label Mar 19, 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