Add Search to Listen.V1.WebSocket.Channel model #324
Conversation
WalkthroughThe changes introduce new functionalities to the Deepgram .NET SDK by adding support for search queries in the Listen V1 WebSocket channels. This enhancement includes the addition of new data structures for handling search data, aligning the SDK's capabilities with the Deepgram API's existing features. The updates facilitate more efficient audio recognition and analysis by incorporating search results directly into the channel's data model. 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 Configuration File (
|
|
Awesome @ElliotEserin Thanks for opening up this PR! |
![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 (3)
- Deepgram/Models/Listen/v1/WebSocket/Channel.cs (1 hunks)
- Deepgram/Models/Listen/v1/WebSocket/Hit.cs (1 hunks)
- Deepgram/Models/Listen/v1/WebSocket/Search.cs (1 hunks)
Additional comments not posted (9)
Deepgram/Models/Listen/v1/WebSocket/Channel.cs (1)
16-21: LGTM! The new propertySearchis well-defined.The new property
Searchis correctly annotated and follows the existing patterns in the file.Deepgram/Models/Listen/v1/WebSocket/Search.cs (3)
12-14: LGTM! The propertyQueryis well-defined.The property
Queryis correctly annotated and follows the existing patterns in the file.
19-21: LGTM! The propertyHitsis well-defined.The property
Hitsis correctly annotated and follows the existing patterns in the file.
7-30: LGTM! The overall structure ofSearchrecord is well-defined.The
Searchrecord is correctly structured and follows existing patterns in the project.Deepgram/Models/Listen/v1/WebSocket/Hit.cs (5)
12-14: LGTM! The propertyConfidenceis well-defined.The property
Confidenceis correctly annotated and follows the existing patterns in the file.
20-22: LGTM! The propertyEndis well-defined.The property
Endis correctly annotated and follows the existing patterns in the file.
27-29: LGTM! The propertySnippetis well-defined.The property
Snippetis correctly annotated and follows the existing patterns in the file.
34-36: LGTM! The propertyStartis well-defined.The property
Startis correctly annotated and follows the existing patterns in the file.
7-45: LGTM! The overall structure ofHitrecord is well-defined.The
Hitrecord is correctly structured and follows existing patterns in the project.
|
No problem, I hope it's useful! |
Proposed changes
Issue - Add the Search property to the Listen WebSocket channel. This mirrors the current REST equivalent for the channel record. This property is deserialized from the JSON response returned by the Deepgram Response Schema
Types of changes
What types of changes does your code introduce to the community .NET 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
I thought I would give this a go myself and this is actually my first PR ever... So feel free to tell me how I could improve, or feel free to throw it out if it isn't good enough! I couldn't find anything in the contribution guidelines on this repos standards for linting, however the code is 100% copy-pasted from other areas of the project so hopefully it is suitable!
Summary by CodeRabbit
Searchproperty in the audioChannelrecord for enhanced data handling.Hitrecord to encapsulate audio recognition details such as confidence level and timing.Searchrecord to facilitate search queries, containing properties for query and results.These additions improve the API's ability to manage and analyze audio recognition data effectively.