docs: update for pipecat PR #4684#887
Open
markbackman wants to merge 1 commit into
Open
Conversation
- Add platform requirement note for MLX (macOS Apple Silicon only) - Document Model/MLXModel StrEnum behavior - Clarify MLX installation requirements
markbackman
added
auto-docs
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated documentation update for pipecat PR #4684.
Changes
Updated:
api-reference/server/services/stt/whisper.mdxModelandMLXModelare nowStrEnumtypes, allowing direct string comparisonContext
PR #4684 changed
ModelandMLXModelfromEnumtoStrEnum, making enum members directly comparable to strings (e.g.,Model.TINY == "tiny"). The API remains backward compatible.The PR also added platform-specific import handling for MLX Whisper to prevent import errors on non-macOS platforms, as MLX is only available on macOS with Apple Silicon.
Gaps identified
None