added the Search response for streaming requests

[jjmaldonis]

Proposed changes

Adds the Search response for streaming requests. This is supported.

I pulled the relevant code directly from clients/listen/v1/rest/response.py.

Types of changes

What types of changes does your code introduce to the community Python SDK?

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update or tests (if none of the other choices apply)

Checklist

• I have read the CONTRIBUTING doc
• I have lint'ed all of my code using repo standards
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

Bug report: https://discord.com/channels/1108042150941294664/1285161452763611158/1285161452763611158

Summary by CodeRabbit

• New Features
  • Added support for search-related functionality in the response data, allowing for the retrieval of search queries and associated hit information.

[coderabbitai]

Walkthrough

The provided changes introduce support for search-related functionality in the response data, allowing for the retrieval of search queries and associated hit information. The key changes include the addition of new data classes, Hit and Search, and the modification of the existing Channel class to include an optional search field.

Changes

File	Change Summary
deepgram/clients/listen/v1/websocket/response.py	1. Added Hit data class to represent hit information for the response. 2. Added Search data class to represent search information for the response. 3. Modified Channel class to include an optional search field, which is a list of Search objects. 4. Updated the __getitem__ method in the Channel class to handle the new search field.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant WebsocketResponse
    participant Channel
    participant Hit
    participant Search

    Client->>WebsocketResponse: Receive response
    WebsocketResponse->>Channel: Create Channel object
    Channel->>Search: Create Search object(s)
    Search->>Hit: Create Hit object(s)
    Channel->>Client: Return Channel object with search information

Loading

The sequence diagram above illustrates the high-level flow of the new search-related functionality. The client receives a WebsocketResponse, which is then used to create a Channel object. The Channel object then creates one or more Search objects, each of which contains one or more Hit objects. Finally, the Channel object is returned to the client, providing access to the search information.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between abc610e and fed0893.

Files selected for processing (1)

• deepgram/clients/listen/v1/websocket/response.py (1 hunks)

Additional comments not posted (3)

deepgram/clients/listen/v1/websocket/response.py (3)

96-105: LGTM!

The Hit data class is well-defined with appropriate fields, types, and default values. It inherits from BaseResponse and is decorated with @dataclass, which is a good practice.

---

108-121: LGTM!

The Search data class is well-defined with appropriate fields, types, and default values. It inherits from BaseResponse and is decorated with @dataclass, which is a good practice.

The __getitem__ method is overridden to handle the conversion of hits from dictionary to Hit objects, which is a nice touch.

---

130-138: LGTM!

The Channel data class has been updated with a new optional search field, which is appropriately typed as Optional[List[Search]] and has a default value of None. The field is decorated with field(default=None, metadata=dataclass_config(exclude=lambda f: f is None)), which is a good practice to exclude the field from serialization if it is None.

The __getitem__ method has been updated to handle the conversion of the search field from dictionary to a list of Search objects, which is consistent with the handling of the alternatives field.

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai generate interesting stats about this repository and render them as a table.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[davidvonthenen]

Awesome! Thanks @jjmaldonis