Fix Reported Manage Issues

[davidvonthenen]

Proposed changes

Addresses Issue: #458, #459

Changes:

• Fix example as noted/reported in the issue
• Updated option name with correct parameter name and fix input type to be str or List[str]

Local testing make unit-test is good.

Types of changes

What types of changes does your code introduce to the community Python SDK?
Put an x in the boxes that apply

• 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

Put an x in 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.

• 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

NA

Summary by CodeRabbit

• New Features

  • Updated the PrerecordedOptions class to use a singular custom_topic attribute for improved clarity.
  • Introduced new optional attributes in the Response class, including message, enhancing response flexibility.

• Bug Fixes

  • Modified several attributes in the Details class to be optional, allowing for more robust handling of data.

• Style

  • Improved variable naming in example usage scripts for better readability and consistency.

[coderabbitai]

Walkthrough

The pull request introduces several modifications across multiple files. Key changes include renaming an attribute in the PrerecordedOptions class from custom_topics to custom_topic, reflecting a shift to a singular naming convention. Additionally, the Details and Response classes in the manage module have updated attribute types from mandatory to optional, enhancing flexibility. Variable names in the main function of the usage example have been renamed for clarity. These changes collectively impact how instances of these classes are constructed and utilized while improving code readability.

Changes

Files	Change Summary
deepgram/clients/listen/v1/rest/options.py	Renamed custom_topics to custom_topic in PrerecordedOptions class.
deepgram/clients/manage/v1/response.py	Modified duration, total_audio, channels, and streams in Details class to optional types. Changed details in Response class to optional and added a new optional message attribute.
examples/manage/usage/main.py	Renamed variables for clarity: reqResp to getResp, listResp to listFields, and listResp in usage summary to getSummary. Updated print statements accordingly.

Tip

New features

Walkthrough comment now includes:

• Possibly related PRs: A list of potentially related PRs to help you recall past context.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

• Please share any feedback in the discussion post on our Discord.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

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>.
  • 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 show all the console.log statements in this repository.
  • @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.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0cb8467 and 1f5b483.

Files selected for processing (3)

• deepgram/clients/listen/v1/rest/options.py (1 hunks)
• deepgram/clients/manage/v1/response.py (2 hunks)
• examples/manage/usage/main.py (1 hunks)

Files skipped from review due to trivial changes (1)

• examples/manage/usage/main.py

Additional comments not posted (2)

deepgram/clients/listen/v1/rest/options.py (1)

44-44: Attribute Renaming Approved

The renaming of custom_topics to custom_topic is approved as it aligns with the PR's objectives to clarify usage. Ensure that all references to this attribute in the SDK and the documentation are updated accordingly.

Verification successful

---

Attribute Renaming Verified

The renaming of custom_topics to custom_topic has been successfully applied throughout the codebase. No occurrences of the old attribute name were found, confirming the update's consistency. Ensure that documentation reflects this change as well.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all references to `custom_topic` are updated.

# Test: Search for the old attribute name. Expect: No occurrences.
rg --type python -A 5 $'custom_topics'

Length of output: 68

---

Script:

#!/bin/bash
# Description: Verify all references to `custom_topic` are updated.

# Test: Search for the old attribute name. Expect: No occurrences.
rg --type py -A 5 $'custom_topics'

Length of output: 33

deepgram/clients/manage/v1/response.py (1)

474-481: Approval of Changes in Response Class

Making details optional and introducing message as a new optional attribute are good practices that enhance the flexibility and robustness of the API responses. The configuration to exclude None values from serialization is also commendable.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1f5b483 and d0618f4.

Files selected for processing (3)

• deepgram/clients/listen/v1/rest/options.py (1 hunks)
• deepgram/clients/manage/v1/response.py (2 hunks)
• examples/manage/usage/main.py (1 hunks)

Files skipped from review due to trivial changes (1)

• examples/manage/usage/main.py

Files skipped from review as they are similar to previous changes (2)

• deepgram/clients/listen/v1/rest/options.py
• deepgram/clients/manage/v1/response.py