Fix endpointing type #429
Fix endpointing type #429
Conversation
WalkthroughThe Changes
Possibly related issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- deepgram/clients/listen/v1/websocket/options.py (1 hunks)
Additional comments not posted (1)
deepgram/clients/listen/v1/websocket/options.py (1)
44-49: LGTM! Ensure backward compatibility.The changes to the
endpointingfield enhance backward compatibility and the comments provide clear context for future plans.However, ensure that all usages of the
endpointingfield in the codebase are compatible with the new type.Verification successful
Verified: Compatibility of
endpointingfield usageAll instances of the
endpointingfield usage in the codebase are compatible with the new typeOptional[Union[str, bool, int]]. The value300used in the test and example files is an integer, which aligns with the updated type definition.
tests/edge_cases/auto_flush/microphone_mute/main.pytests/edge_cases/auto_flush/async_microphone_mute/main.pyexamples/speech-to-text/websocket/microphone/main.pyexamples/speech-to-text/websocket/async_microphone/main.pydeepgram/clients/listen/v1/websocket/options.pyScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all usages of the `endpointing` field are compatible with the new type. # Test: Search for the `endpointing` field usage. Expect: Only occurances of the new type. rg --type python $'endpointing'Length of output: 61
Script:
#!/bin/bash # Description: Verify all usages of the `endpointing` field are compatible with the new type. # Test: Search for the `endpointing` field usage. rg 'endpointing'Length of output: 1943
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- deepgram/clients/listen/v1/websocket/options.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- deepgram/clients/listen/v1/websocket/options.py
Proposed changes
Addresses: #428
Types of changes
What types of changes does your code introduce to the community Python SDK?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
NA
Summary by CodeRabbit
Refactor
endpointingfield in theLiveOptionsclass for backward compatibility. It now supportsOptional[Union[str, bool, int]].Documentation
endpointingfield.