Open
Conversation
- Add AudioConfig class documentation for audio configuration parameters - Add audio_config parameter to Configuration section - Update params parameter with detailed deprecation warning - Add settings parameter documentation - Update system_instruction parameter with deprecation notice - Update all usage examples to use settings and audio_config - Add deprecation warning to Params section Related to pipecat PR #3942
markbackman
added
the
auto-docs
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 #3942.
Changes
Updated
server/services/s2s/aws.mdxAudioConfig class:
AudioConfigsection documenting audio configuration parameters (sample rates, sample sizes, channel counts)audio_configparameter to Configuration sectionDeprecation notices:
paramsparameter with detailed deprecation warning directing users to usesettingsfor inference settings andaudio_configfor audio configurationsystem_instructionparameter directing users to usesettingsinsteadUpdated examples:
AWSNovaSonicLLMSettingsAWSNovaSonicLLMSettingsandAudioConfigAWSNovaSonicLLMSettingsNew parameters documented:
settingsparameter (AWSNovaSonicLLMSettings)audio_configparameter (AudioConfig)Gaps identified
None
Summary
PR #3942 introduced a new
AudioConfigclass to separate audio configuration (sample rates, channel counts, bit depths) from inference settings (temperature, max_tokens, etc.). Theparamsparameter is now deprecated in favor of using:settings=AWSNovaSonicLLMSettings(...)for inference parametersaudio_config=AudioConfig(...)for audio configurationAll documentation has been updated to reflect the new preferred approach while maintaining documentation for the deprecated parameters.