Add Audio Review Support to Performance Review Generation

ajitesh123 commented 4 months ago

Added support for handling audio reviews in addition to written reviews for both the generate_review and generate_self_review functions.
Updated the ReviewRequest and SelfReviewRequest models to include an optional audio_review field.
Modified the generate_prompt and generate_self_review_prompt functions to incorporate the audio review information when generating the prompts for the language models.
Ensured that the language model responses consider both the written and audio reviews when generating the performance reviews.

Files

app_fastapi.py

Title: Update API Endpoints to Handle Audio Reviews

Changes Summary:

Added audio_review parameter to the api_generate_review and api_generate_self_review endpoints.
Passed the audio_review parameter to the corresponding functions in the review.py and self_review.py modules.

Label: enhancement

requirements.txt

Title: Add Dependencies for Audio Review Support

Changes Summary:

Added the streamlit-audiorec and groq packages to the requirements.txt file to enable audio review functionality.

Label: enhancement

review.py

Title: Integrate Audio Review into Review Generation

Changes Summary:

Updated the generate_prompt function to include the audio_review information in the prompt.
Passed the audio_review parameter to the generate_review function.
Modified the parse_llm_response function to handle the audio review information in the generated response.

Label: enhancement

self_review.py

Title: Integrate Audio Review into Self-Review Generation

Changes Summary:

Updated the SelfReviewRequest model to include an optional audio_review field.
Modified the generate_self_review_prompt function to include the audio_review information in the prompt.
Passed the audio_review parameter to the generate_self_review function.

Label: enhancement

===== Original PR title and description ============

Original Title: ```markdown

Original Description: This pull request adds the ability for users to provide audio input for their performance reviews and self-reviews. Previously, users had to type their input, but now they can record their audio. The audio is converted from speech to text using the Whisper model on the Groq library, and the resulting text is used as input to the review generation process.

Main Changes:

Added the streamlit-audiorec library to the app.py and app_fastapi.py files, allowing users to record audio input.
Implemented the convert_speech_to_text function in the speech_to_text.py file, which uses the Groq library to transcribe the audio to text.
Updated the ReviewRequest and SelfReviewRequest models to include an optional audio_review field, and updated the generate_review and generate_self_review functions to use this field when generating the review.
Added tests to ensure the audio functionality works as expected, including mocking the Groq library and testing the convert_speech_to_text, generate_review, and generate_self_review functions with audio input.

Summary by CodeRabbit

New Features
- Introduced support for audio feedback in performance and self-review processes, allowing users to submit audio reviews alongside written ones.
- Updated review generation functionality to incorporate audio input for more nuanced evaluations.
Dependencies
- Added new libraries to enhance audio recording capabilities and data processing features.

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes introduce the capability for users to provide audio input for performance and self-reviews in the application. This is achieved by adding an audio_review parameter to the relevant request models and updating the associated functions to process audio input. Additionally, new dependencies for audio recording and speech-to-text conversion are included.

Changes

Files	Change Summary
`app_fastapi.py`	Added `audio_review` parameter to `api_generate_review` and `api_generate_self_review`.
`requirements.txt`	Added `streamlit-audiorec` and `groq` dependencies.
`review.py`	Updated `ReviewRequest` to include `audio_review`; modified `generate_prompt` and `generate_review` functions.
`self_review.py`	Updated `SelfReviewRequest` to include `audio_review`; modified `generate_self_review_prompt` and `generate_self_review` functions.

Possibly related issues

ajitesh123/Perf-Review-AI#52: This issue requests audio input for performance reviews, which is addressed by the changes.
ajitesh123/Perf-Review-AI#53: Similar to #52, this issue also seeks audio input functionality, which is implemented in this PR.
ajitesh123/Perf-Review-AI#95: This issue mentions enabling audio input for reviews, aligning with the changes made.
ajitesh123/Perf-Review-AI#96: This issue requests the same audio input feature for reviews, which is fulfilled by the modifications.
ajitesh123/Perf-Review-AI#57: This issue discusses adding audio input for reviews, which is directly addressed by the changes.
ajitesh123/Perf-Review-AI#54: This issue also seeks to implement audio input for reviews, matching the objectives of this PR.

Poem

🐰 In a world where voices sing,
Audio reviews now take wing!
With whispers soft and stories told,
Performance shines, both brave and bold.
Record your thoughts, let them flow,
A new way to share, watch us grow! 🎤✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

dev-archie-ai-code-explain-pr[bot] commented 4 months ago

PR Review Summary 🔍

This PR introduces audio input functionality for performance reviews and self-reviews. It adds new dependencies, updates request models, and modifies review generation functions to incorporate audio input. The changes seem well-integrated, but there are some potential security and logical concerns that need addressing.

🔒 Security analysis

- User-provided API keys are directly used without validation or sanitization - No input validation for audio_review field, potential for injection attacks - Groq library added without version pinning, could lead to unexpected behavior

🧪 Test coverage analysis

- No visible tests added for new audio functionality - Existing tests not updated to cover new audio_review parameter - Missing edge case tests for audio input (empty, corrupted, or oversized files)

⚡ Logical error analysis

- No error handling for audio transcription failures - Potential performance issues with large audio files not addressed - Inconsistent handling of optional audio_review parameter across functions

ellipsis-dev[bot] commented 2 months ago

Your free trial has expired. To keep using Ellipsis, sign up at https://app.ellipsis.dev for $20/seat/month or reach us at help@ellipsis.dev

ajitesh123 / auto-review-ai