---

🚪 Deck AI API Service

Deck AI API Service is a microservice within the Deck ecosystem that handles all AI-related functionalities. It integrates Gemini AI to process user input, generate flashcards, generate quizzes, help moderate deck of flashcards and enhance productivity. This service provides dedicated endpoints for AI-driven content generation, ensuring seamless interaction between the Deck application and AI models.

---

🌟 Features

Gemini Integration

• ⚡ Flashcard Generation: Utilize Gemini to automatically generate flashcards from study materials (pdf files) and text inputs.
• 📝 Quiz Generation: Generate interactive multiple-choice quizzes using AI, based on your deck of flashcards.
• 🛡️ Content Moderation: Ensure appropriate and high-quality content by using AI to filter and analyze user-generated inputs, preventing harmful or irrelevant material.

---

🚀 Getting Started

Prerequisites

• Node.js installed
• Gemini API key
• Firebase admin SDK

Installation

1. 🛠️ Clone this repository to your local machine.
2. 📦 Install dependencies using npm install.
3. ⚙️ Set up environment variables:
   • GEMINI_API_KEY: Your Google Generative AI API key.
   • ASSISTANT_ID: Your OpenAI assistant ID.
   • FIREBASE_API_KEY: Found in Firebase admin.
   • AUTH_DOMAIN: Found in Firebase admin.
   • PROJECT_ID: Found in Firebase admin.
   • STORAGE_BUCKET: Found in Firebase admin.
   • MESSAGING_SENDER_ID: Found in Firebase admin.
   • APP_ID: Found in Firebase admin.
   • KEY_FILE: Found in Firebase Service Providers.
4. 📃 generate your firebase private key json file and place it in your project's root folder
5. 🚀 Run the server using npm start or nodemon.

---

📡 API Endpoints

🚀 API Health Check

• GET /v2/deck/hi
  • Description: Checks if the API is online.
  • Response:

    { "message": "Hi! the server is active" }

⚡ Flashcard Generation

• POST /v2/deck/generate/flashcards/:id
  • Description: Generates flashcards using Gemini AI based on provided input.
  • Path Parameter:
    • id (string) – The user's unique ID.
  • Request Body:

    {
      "deckTitle": "WEBDEV - Frameworks",
      "subject": "Web development",
      "topic": "frameworks",
      "addDescription": "The various frameworks used for web development and their design patterns", // Optional
      "numberOfFlashcards": 10
    }

  • Response:

    {
      "status": 200,
      "request_owner_id": "<id>",
      "message": "Prompt was sent successfully",
      "data": {
        "deckId": "<deck unique id in database>"
      }
    }

🛡️ Content Moderation

• POST /v2/deck/moderate/:id

  • Description: Uses Gemini AI to analyze user-generated content and determine its appropriateness.

  • Path Parameter:

    • id (string) – The user's unique ID.

  • Request Body:

    {
      "deckId": "<unique_deck_id>"
    }

  • Response:

    {
      "status": 200,
      "request_owner_id": "<id>",
      "message": "Moderation review successful",
      "data": {
        "quiz_data": {
          "overall_verdict": {
            "is_appropriate": false,
            "moderation_decision": "content is inappropriate",
            "flagged_cards": [
              {
                "description": "Activates a configured interface.",
                "term": "Tangina mo",
                "reason": "Profanity and offensive language"
              }
            ]
          }
        }
      }
    }

    or

    {
      "status": 200,
      "request_owner_id": "<id>",
      "message": "Moderation review successful",
      "data": {
        "quiz_data": {
          "overall_verdict": {
            "is_appropriate": true,
            "moderation_decision": "content is appropriate",
            "flagged_cards": []
          }
        }
      }
    }

📝 Quiz Generation

• POST /v2/deck/generate/quiz/:id

  • Description: Generates quiz questions based on provided deck id using Gemini AI.

  • Path Parameter:

    • id (string) – The user's unique ID.

  • Request Body:

    {
      "deckId": "<unique_deck_id>"
    }

  • Response:

    {
      "status": 200,
      "request_owner_id": "<id>",
      "message": "Quiz creation for deck with id:<id> is successful",
      "data": {
        "quizId": "<quiz_id>"
      }
    }

    or

    {
      "status": 200,
      "request_owner_id": "<id>",
      "message": "There is already a quiz made for this deck in the 'quiz' collection",
      "data": {
        "quiz_id": "<quiz_id>"
      }
    }

    or

    {
      "status": 200,
      "request_owner_id": "<id>",
      "message": "Quiz creation for new flashcards in deck ekZBroavEBX76mAXVG9Z is successful",
      "data": {
          "no_of_new_flashcards": <num_of_new_flashcards_detected>
      }
    }
    

---

🤝 Contributing

We welcome contributions from the community! To contribute:

1. 🍴 Fork the repository.
2. 🌿 Create a new branch (git checkout -b feature/YourFeature).
3. 💻 Commit your changes (git commit -m 'Add some feature').
4. 📤 Push to the branch (git push origin feature/YourFeature).
5. 🔄 Open a pull request.

---

📜 License

This project is licensed under the MIT License.

---

📧 Contact

If you have any questions or suggestions, feel free to open an issue.

---

Thank you for using Deck API Gateway! We hope it helps streamline your productivity workflows and enhances your "Deck" application experience. 🎉