feat: Vision Question Answer

.github/README.md

@@ -11,6 +11,42 @@ src="https://seeklogo.com/images/G/google-developers-logo-F8BF3155AC-seeklogo.co
 
 ## ✨ Available Services
 
+- Remove Background `/api/rembg/`
+
+```bash
+curl --location 'https://{server-domain}/api/rembg/' --form 'image=/image/path' --form 'stream=false' --form 'exprire=3600' --request 'POST'
+```
+
+- Face Detection `/api/fd/`
+
+```bash
+curl --location 'https://{server-domain}/api/fd/' --form 'image=/image/path' --request 'POST'
+```
+
+- Chats AI `/api/chats/`
+
+```bash
+curl --location 'https://{server-domain}/api/chats/' --data='{"prompt": ""}' --request 'POST'
+```
+
+- Image to Text `/api/img2text/` (Forwarding Server)
+
+```bash
+curl --location 'https://{server-domain}/api/img2text/' --form 'image=/image/path' --request 'POST'
+```
+
+- Vision Question Answering `/api/vqa/` (Forwarding Server)
+
+```bash
+curl --location 'https://{server-domain}/api/vqa/' --form 'image=/image/path' --form 'question=Question for image' --request 'POST'
+```
+
+## 🖥️ Root Server
+
+- [HuggingFace Space](https://gdscfptu-ai-service-hf.hf.space)
+
+- [Google Cloud Run](https://ai-service-gcp-ul5gxefjzq-as.a.run.app)
+
 ## ⏩ Forwarding Server
 
 The forwarding server help adding children server for processing. The parent server acts as a controller for load balancing.
@@ -151,6 +187,23 @@ This route checks the health status of children server. The children is consider
 }
 ```
 
+- `/api/vqa/`
+
+```json
+// Request. Form-data
+{
+    "image": <image-data>,
+    "question": "Question for image"
+}
+
+// Response. JSON
+{
+    "data": {
+        "answer": "Answer of image"
+    }
+}
+```
+
 ## 😊 Contributors
 
 - GDSC-FPTU [[gdsc-fptu](https://github.com/gdsc-fptu)]

.github/UPDATE.md

@@ -0,0 +1,48 @@
+# ⬆️ Update Document
+
+### Add new feature
+
+- Add folder component `apps/`
+
+```
+apis/
+- [feature-name]/
+    - __init__.py
+    - models/
+    - controllers/
+```
+
+- Register APIRoute `apps/apis/__init__.py`
+
+```python
+router.include_router(feature_router)
+```
+
+- Add Swagger document `utils/metadata.py`
+
+```python
+{
+    "name": "task-alias",
+    "description": "Description"
+}
+```
+
+### Add Children Server feature
+
+👉 [Google Colab](https://colab.research.google.com/drive/1pzkxAMOEwPWUqRVHCN_dkgVF2Coj3wmj)
+
+- Add Logic `🤗Logic`
+
+```python
+def new_feature_process():
+    ...
+```
+
+- Add Route `📍Route`
+
+```python
+@app.route("/new-feature")
+def new_feature():
+    ...
+    new_feature_process()
+```

apps/apis/chats/__init__.py

@@ -1,4 +1,3 @@
-import os
 from fastapi import APIRouter, HTTPException, Depends
 from fastapi.responses import JSONResponse
 from .models.chats_model import ChatsModel

apps/apis/vqa/__init__.py

@@ -0,0 +1,28 @@
+from fastapi import APIRouter, Depends
+from fastapi.responses import JSONResponse
+from apps.services.foward.fw_middleware import forward_middleware, forward_request
+from .models.vqa_model import VQAModel
+
+
+router = APIRouter(prefix='/vqa')
+router_base_configs = {
+    "tags": ["vqa"],
+    "response_class": JSONResponse
+}
+
+
+@router.post("/", **router_base_configs)
+def vision_question_answer(
+    image: VQAModel.image = VQAModel.image_default,
+    question: VQAModel.question = VQAModel.question_default,
+    fw_index: VQAModel.fw_index = Depends(forward_middleware)
+):
+    # Forward request
+    fw_data = {
+        "files": {"image": image.file, "question": question},
+    }
+    fw_response = forward_request(fw_index, fw_data, '/api/vqa/')
+    if fw_response is not None:
+        return {"answer": fw_response["data"]["answer"]}
+
+    return {"answer": "VQA model is not available in this server"}

apps/apis/vqa/models/vqa_model.py

@@ -0,0 +1,9 @@
+from fastapi import File, UploadFile, Form
+
+
+class VQAModel:
+    image = UploadFile | None
+    image_default = File(None, description="Image to answer question")
+    question = str | None
+    question_default = Form(None, description="Question to answer")
+    fw_index = int | None

utils/metadata.py

@@ -26,6 +26,10 @@ DOC_SWAGGER = {
             "name": "fd",
             "description": "Detect faces from image"
         },
+        {
+            "name": "vqa",
+            "description": "Answer questions from image"
+        },
         {
             "name": "fw",
             "description": "Foward request to other services"