Update README to Remove Deprecated Names #449
Conversation
WalkthroughThe recent updates to the Deepgram API integration significantly alter how developers interact with both prerecorded and live audio. The Changes
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 Configuration 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
Outside diff range, codebase verification and nitpick comments (2)
README.md (2)
102-102: Update all references to theliveendpoint to use thewebsocketendpoint.The following locations still contain references to the deprecated
liveendpoint:
tests/expected_failures/exercise_timeout/sync/main.pytests/edge_cases/reconnect_same_object/sync/main.pytests/edge_cases/auto_flush/microphone_mute/main.pytests/edge_cases/auto_flush/async_microphone_mute/main.pytests/edge_cases/reconnect_same_object/async/main.pytests/expected_failures/exercise_timeout/async/main.pytests/edge_cases/keepalive/async/main.pytests/edge_cases/keepalive/sync/main.pyexamples/advanced/websocket/mute-microphone/main.pyEnsure these references are updated to use the
websocketendpoint to maintain consistency and avoid using deprecated methods.Analysis chain
LGTM! But verify the usage of the
websocketendpoint in the codebase.The change from
livetowebsocketendpoint is approved.However, ensure that all references to the
liveendpoint are updated towebsocketin the codebase.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to the `live` endpoint are updated to `websocket`. # Test: Search for the `live` endpoint. Expect: No occurrences of the `live` endpoint. rg --type python -A 5 $'live'Length of output: 59
Script:
#!/bin/bash # Description: Verify all references to the `live` endpoint are updated to `websocket`. # Test: Search for the `live` endpoint. Expect: No occurrences of the `live` endpoint. rg -A 5 'live'Length of output: 84270
91-91: Issues Found:The term
prerecordedstill appears in multiple files, indicating that not all references have been updated to use therestendpoint. Please update the following files:
README.mdexamples/analyze/legacy_dict_intent/main.pyexamples/advanced/README.mdexamples/advanced/rest/direct_invocation/main.pyexamples/analyze/topic/main.pyexamples/analyze/summary/main.pyexamples/analyze/intent/main.pyexamples/README.mdexamples/analyze/stream_intent/main.pyexamples/analyze/sentiment/main.pydeepgram/__init__.pydeepgram/client.pydeepgram/clients/speak_router.pydeepgram/clients/listen_router.pydeepgram/clients/listen/v1/rest/response.pydeepgram/clients/__init__.pyPlease ensure all references to
prerecordedare updated torest.Analysis chain
LGTM! But verify the usage of the
restendpoint in the codebase.The change from
prerecordedtorestendpoint is approved.However, ensure that all references to the
prerecordedendpoint are updated torestin the codebase.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to the `prerecorded` endpoint are updated to `rest`. # Test: Search for the `prerecorded` endpoint. Expect: No occurrences of the `prerecorded` endpoint. rg --type python -A 5 $'prerecorded'Length of output: 66
Script:
#!/bin/bash # Description: Verify all references to the `prerecorded` endpoint are updated to `rest`. # Test: Search for the `prerecorded` endpoint. Expect: No occurrences of the `prerecorded` endpoint. rg -A 5 'prerecorded'Length of output: 14912
Proposed changes
Updates the README to reference the most recent class/function name.
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