Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create utility method that uses ai model to suggest imrpoved description #31

Merged

Conversation

citruscai
Copy link
Contributor

Fixes #10
Summary of Features:

  1. API Route for Description Suggestions

    • Endpoint: Created a new API route /suggestion that handles POST requests.
    • Request Handling: Extracts description and type (either "education" or "experience") from the request JSON.
    • Util Method Integration: Calls the get_suggestion method with the extracted parameters.
    • Response: Returns the generated suggestion as a JSON response.
  2. Util Method for Generating Suggestions

    • Method: get_suggestion(description, type)
    • Description: Generates improved descriptions for resume sections using Google Gemini.
    • Prompt Customization: Adjusts the prompt based on the type of description (education or experience).
    • API Choice: Decided to use Google Gemini instead of OpenAI's ChatGPT due to its free availability.

Decision to Use Google Gemini:

  • Reason: Chose Google Gemini over OpenAI's ChatGPT due to its free availability, which helps in reducing costs while still providing high-quality suggestions.
  • Implementation: Integrated the Google Gemini API using the google-generativeai Python SDK, ensuring secure handling of API keys with dotenv.

This implementation sets the foundation for future enhancements, such as integrating the suggestion feature into JavaScript side and allowing users to accept and apply suggestions directly.

Copy link
Member

@vantage-ola vantage-ola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should consider writing tests, looks good to me 👍

@citruscai
Copy link
Contributor Author

@yashika51

@citruscai
Copy link
Contributor Author

added test cases per @vantage-ola suggestion. thank you oluwasanya!!

@yashika51 yashika51 merged commit 262c29a into MLH-Fellowship:main Oct 10, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ChatGPT functionality to help users reword the description section of their resume
3 participants