Skip to content

docs: update for pipecat PR #4654#877

Open
markbackman wants to merge 1 commit into
mainfrom
docs/pr-4654
Open

docs: update for pipecat PR #4654#877
markbackman wants to merge 1 commit into
mainfrom
docs/pr-4654

Conversation

@markbackman

Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat PR #4654.

Changes

pipecat/learn/function-calling.mdx

  • Updated "Using Direct Functions (Shorthand)" section: Shows the simpler pattern of passing direct functions directly to LLMContext(tools=[...]) instead of wrapping in ToolsSchema first
  • Added auto-registration documentation: Explains that direct functions listed in LLMContext are automatically registered with the LLM service, eliminating the need for separate register_direct_function() calls
  • Added @direct_function decorator documentation: New section explaining the optional decorator for overriding call options (cancel_on_interruption, timeout) on direct functions
  • Updated "Register Function Handlers" section: Clarifies that explicit registration is now optional and explains when it's still useful
  • Updated code examples: All examples now show the simplified API with auto-registration
  • Updated "Create the Pipeline" section: Shows the list form for tools instead of ToolsSchema

pipecat/learn/context-management.mdx

  • Updated "Context with Function Calling" section: Shows direct functions passed as a list to LLMContext instead of wrapped in ToolsSchema
  • Updated code example: Demonstrates the simpler API with a direct function example
  • Added cross-reference: Links to the function-calling guide for more details

Summary

The PR simplifies the function calling API by eliminating boilerplate. Instead of:

llm.register_direct_function(get_weather)
tools = ToolsSchema(standard_tools=[get_weather])
context = LLMContext(tools=tools)

Users can now write:

context = LLMContext(tools=[get_weather])

The functions are automatically registered when the context is used. The @direct_function decorator provides an optional way to override call options without explicit registration.

Gaps identified

None. The PR only changed internal APIs (LLMService, LLMContext, ToolsSchema) and introduced the @direct_function decorator. All user-facing documentation that references these APIs has been updated.

- Update function-calling guide to show simpler LLMContext(tools=[...]) pattern
- Document that direct functions are auto-registered with LLM service
- Add documentation for @direct_function decorator
- Update context-management guide to show list form
- Update code examples throughout to reflect new simplified API

Related to pipecat PR #4654
@markbackman markbackman added auto-docs Automated documentation update from pipecat source changes pipecat labels Jun 8, 2026
@mintlify

mintlify Bot commented Jun 8, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
Pipecat 🟢 Ready View Preview Jun 8, 2026, 7:59 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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 pipecat

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant