toledkrw/api-unitech

Uni-tech's AI API

UniTech

AI API

🔰 Getting Started

This project was created to hold an API on Flask (Python).

💾 Tools Used

🤖 Technologies Used

📋 Pre-requisites

• 🐋Docker
• 💻VsCode

💡 Attention

This project employs Docker Dev Containers, ensuring that all operations occur within containers. Therefore, it is imperative to have Docker installed on your system.

It is highly recommended to utilize Visual Studio Code (VsCode), as the MS Dev Container plugin facilitates seamless integration with the development environment. Please ensure that you have Docker installed and consider installing the VsCode Dev Containers plugin for an enhanced experience.

Since Docker and Dev Containers are in use, there is no need to directly install Python on your local machine. The Dev Container for this project is preconfigured to install Python, Poetry, and all necessary dependencies internally.

Sit back and let the informagic work its magic.

🎨 Features

The application has the following functionality:

👓 Google's Gemini @ /gmni

[POST] @ /multiple_choice_question

This enpoint retrieves a multiple choice question in the following structure:

{
  question_statement:'question statement that AI will generate', 
  alternatives:[
    {a:'alternative'},
    {b:'alternative'}, 
    {c:'alternative'}, 
    {d:'alternative'}, 
    {e:'alternative'}
  ], 
  correct_answer:'correct_alternative_letter'
}

It takes as payload the following:

{
  "subject":"Science discipline like: Maths, Geography, etc.",
  "academic_level":"Academic level like: First Grader, etc.",
  "theme":"A theme within the chosen subject, like: Algebra, Captalism, etc.",
  "locale":"Locale in which the prompt will be retrieved, like: pt-br, en-us, etc."
}

🤖 OpenAi's GPT @ /opai

lorem

📑 Licenses

Distributed under the MIT License. See LICENSE for more information.

🧻 TODOs

• 1 - Gemini
• [⠀] 2 - OpenAI