Skip to content

docs: update for pipecat PR #4709#897

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

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

Conversation

@markbackman

Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat PR #4709.

Changes

Updated pipecat/learn/function-calling.mdx

  • Added new "Bundling Handlers on Schemas" subsection explaining the new FunctionSchema.handler parameter feature
  • Updated "Register Function Handlers" section intro to clarify auto-registration for direct functions and handler-carrying schemas
  • Updated registration parameter descriptions to reflect new default behavior (cancel_on_interruption and timeout_secs now default to None with fallback to @tool_options decorator)
  • Added note recommending auto-registration via context over explicit register_function calls

Updated api-reference/server/utilities/service-switchers/llm-switcher.mdx

  • Changed cancel_on_interruption parameter type from bool to bool | None and default from "True" to "None" for both register_function and register_direct_function methods
  • Updated parameter descriptions to explain new fallback behavior (explicit arg → @tool_options → default)

PR #4709 Summary

The source PR adds support for bundling handlers directly on FunctionSchema objects:

  • FunctionSchema now accepts an optional handler parameter
  • Handlers on schemas are auto-registered like direct functions
  • @tool_options decorator now works for schema handlers
  • register_function now reads @tool_options when args aren't explicit
  • LLMSwitcher parameter defaults changed to respect @tool_options

Gaps identified

None — all relevant API changes are documented.

…ration)

Updated documentation to reflect new FunctionSchema handler feature and
parameter default changes:

- Added new "Bundling Handlers on Schemas" section in function-calling guide
  explaining how FunctionSchema can now carry a handler for auto-registration
- Updated Section 2 intro to clarify that handlers in LLMContext are
  auto-registered (both direct functions and handler-carrying schemas)
- Updated cancel_on_interruption parameter docs to reflect new default (None)
  and fallback behavior (@tool_options decorator → default)
- Updated llm-switcher.mdx register_function/register_direct_function
  parameter defaults from True to None with updated descriptions

Changes correspond to pipecat PR #4709 which adds:
- FunctionSchema.handler parameter for bundled auto-registration
- @tool_options decorator support for schema handlers
- Updated register_function to read @tool_options when args not explicit
- LLMSwitcher parameter defaults changed to respect @tool_options
@markbackman markbackman added auto-docs Automated documentation update from pipecat source changes pipecat labels Jun 12, 2026
@mintlify

mintlify Bot commented Jun 12, 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 12, 2026, 4:50 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