feat: Chats & FD services

.gitignore

@@ -2,6 +2,7 @@ env/
 __pycache__/
 .env
 temp/*
+data/*
 
 # Keep the .gitkeep file in the temp/ directory
 !.gitkeep

README.md

@@ -41,6 +41,14 @@ curl --location 'https://{domain}/service/fw/' --request 'POST' --data '{"url":"
 curl --location 'https://{domain}/service/fw/' --request 'DELETE' --data '{"index":0}'
 ```
 
+### Server Health Checker
+
+```bash
+curl --location '{children-base-domain}/health'
+```
+
+This route checks the health status of children server. The children is considered as good health when it return anything with status 200.
+
 ### Children Server Endpoint Request & Response
 
 - `/api/rembg/`
@@ -59,6 +67,64 @@ curl --location 'https://{domain}/service/fw/' --request 'DELETE' --data '{"inde
 }
 ```
 
+- `/api/fd/`
+
+```json
+// Request. Form-data
+{
+    "image": "<image-data"
+}
+
+// Response. JSON
+{
+    "data": {
+        "faces": []
+    }
+}
+```
+
+- `/api/chats/`
+
+```json
+// Request. JSON
+{
+    "prompt": "A Prompt from user"
+}
+
+// Response. JSON
+{
+    "data": {
+        "message": "A Message from AI"
+    }
+}
+```
+
+- `/api/chats/:id`
+
+```json
+// Request. JSON
+{
+    "prompt": "A Prompt from user",
+    "conversation": [
+        {
+            "role": "user",
+            "content": "Message A"
+        },
+        {
+            "role": "assistant",
+            "content": "Message B"
+        }
+    ]
+}
+
+// Response. JSON
+{
+    "data": {
+        "message": "A Message from AI"
+    }
+}
+```
+
 ## 😊 Contributors
 
 - GDSC-FPTU [[gdsc-fptu](https://github.com/gdsc-fptu)]

apps/apis/chats/__init__.py

@@ -1,6 +1,10 @@
-from fastapi import APIRouter
+import os
+from fastapi import APIRouter, HTTPException, Depends
 from fastapi.responses import JSONResponse
-from fastapi.requests import Request
+from .models.chats_model import ChatsModel
+from .controllers.conversation_storage import is_conversation_storage_exist, get_conversation_storage, create_conversation_storage, delete_conversation_storage, update_conversation_storage
+from .controllers.openai_controller import send_message, send_message_conversation
+from apps.services.foward.fw_middleware import forward_request, forward_middleware
 
 router = APIRouter(prefix='/chats')
 router_base_configs = {
@@ -10,24 +14,63 @@ router_base_configs = {
 
 
 # Message
-@router.post("/:conversation_id", **router_base_configs)
-def message():
-    return {"message": "Hello World"}
+@router.post("/", **router_base_configs)
+def message(data: ChatsModel, fw_index=Depends(forward_middleware)):
+    # Forward request
+    fw_data = {
+        "data": {"prompt": data.prompt}
+    }
+    fw_response = forward_request(fw_index, fw_data, '/api/chats/')
+    if fw_response is not None:
+        return {"message": fw_response["data"]["message"]}
 
+    response = send_message(data.prompt)
+    return {"message": response}
 
-# Get conversations
-@router.get("/get", **router_base_configs)
-def get_conversations():
-    return {"conversations": "Hello World"}
+
+# Message to conversation
+@router.post("/{cid}", **router_base_configs)
+def conversation(cid: str, data: ChatsModel, fw_index=Depends(forward_middleware)):
+    is_exist = is_conversation_storage_exist(cid)
+    if not is_exist:
+        raise HTTPException(status_code=404, detail="Conversation not found")
+
+    # Forward request
+    fw_data = {
+        "data": {"prompt": data.prompt, "conversation": get_conversation_storage(cid)}
+    }
+    fw_response = forward_request(fw_index, fw_data, f'/api/chats/{cid}')
+    if fw_response is not None:
+        # Update conversation
+        update_conversation_storage(cid, "user", data.prompt)
+        update_conversation_storage(
+            cid, "assistant", fw_response["data"]["message"])
+        return {"message": fw_response["data"]["message"]}
+
+    response = send_message_conversation(cid, data.prompt)
+    return {"message": response}
+
+
+# Get conversation by id
+@router.get("/{cid}", **router_base_configs)
+def get_conversation(cid: str):
+    is_exist = is_conversation_storage_exist(cid)
+    if not is_exist:
+        raise HTTPException(status_code=404, detail="Conversation not found")
+
+    conversation = get_conversation_storage(cid)
+    return {"conversation": conversation}
 
 
 # Create conversation
-@router.post("/create", **router_base_configs)
+@router.get("/create", **router_base_configs)
 def create_conversation():
-    return {"conversation_id": "Hello World"}
+    cid = create_conversation_storage()
+    return {"conversation_id": cid}
 
 
 # Delete conversation
-@router.delete("/delete", **router_base_configs)
-def delete_conversation():
-    return {"conversation": "Hello World"}
+@router.delete("/delete/{cid}", **router_base_configs)
+def delete_conversation(cid: str):
+    delete_conversation_storage(cid)
+    return {"conversation_id": cid}

apps/apis/chats/controllers/conversation_storage.py

@@ -0,0 +1,43 @@
+import uuid
+from utils.local_storage import read_from_local, save_to_local, remove_from_local
+from utils.constants import DATA_DIR
+
+
+def is_conversation_storage_exist(id: str) -> bool:
+    # Check if conversation exist
+    return read_from_local(f"{id}.json", DATA_DIR) is not None
+
+
+def get_conversation_storage(id: str) -> list:
+    # Get conversation
+    conversation = read_from_local(f"{id}.json", DATA_DIR)
+    # Return conversation
+    return conversation
+
+
+def create_conversation_storage() -> str:
+    # Generate conversation id
+    conversation_id = str(uuid.uuid4())
+    # Save to local
+    save_to_local([], f"{conversation_id}.json", False, DATA_DIR)
+    # Return conversation id
+    return conversation_id
+
+
+def update_conversation_storage(id: str, role: str, message: str) -> list:
+    # Get conversation
+    conversation = get_conversation_storage(id)
+    # Append new message
+    conversation.append({
+        "role": role,
+        "content": message
+    })
+    # Save to local
+    save_to_local(conversation, f"{id}.json", False, DATA_DIR)
+    # Return conversation
+    return conversation
+
+
+def delete_conversation_storage(id: str):
+    # Delete conversation
+    remove_from_local(f"{id}.json", DATA_DIR)

apps/apis/chats/controllers/openai_controller.py

@@ -0,0 +1,37 @@
+import os
+from openai import OpenAI
+from .conversation_storage import get_conversation_storage, update_conversation_storage
+
+
+BASE_ENHANCE_PROMPT = {
+    "role": "system", "content": "You are a helpful assistant. You are helping a customer to solve a problem."}
+
+
+client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
+
+
+def send_message(prompt: str):
+    return client.chat.completions.create(
+        model="gpt-3.5-turbo",
+        messages=[
+            BASE_ENHANCE_PROMPT,
+            {"role": "user", "content": prompt}
+        ]
+    ).choices[0].message.content
+
+
+def send_message_conversation(conversation_id: str, prompt: str):
+    # Update conversation
+    update_conversation_storage(conversation_id, "user", prompt)
+    # Generate response
+    response = client.chat.completions.create(
+        model="gpt-3.5-turbo",
+        messages=[
+            BASE_ENHANCE_PROMPT,
+            *get_conversation_storage(conversation_id),
+            {"role": "user", "content": prompt}
+        ]
+    ).choices[0].message.content
+    # Update conversation
+    update_conversation_storage(conversation_id, "assistant", response)
+    return response

apps/apis/chats/models/chats_model.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel, Field
+
+
+class ChatsModel(BaseModel):
+    prompt: str = Field(..., example="Hello, I'm a chatbot")

apps/apis/fd/__init__.py

@@ -1,5 +1,9 @@
-from fastapi import APIRouter
+from fastapi import APIRouter, Depends, HTTPException
 from fastapi.responses import JSONResponse
+from apps.services.foward.fw_middleware import forward_request, forward_middleware
+from .models.fd_model import FaceDetectionModel
+from .controllers.fd_controller import faces_detection_controller
+
 
 router = APIRouter(prefix='/fd')
 router_base_configs = {
@@ -10,5 +14,28 @@ router_base_configs = {
 
 # Face detection
 @router.post("/", **router_base_configs)
-def faces_detection():
-    return {"faces": "Hello World"}
+async def faces_detection(
+    image: FaceDetectionModel.image = FaceDetectionModel.image_default,
+    fw_index: FaceDetectionModel.fw_index = Depends(forward_middleware)
+):
+    # Forward request
+    fw_data = {
+        "files": {"image": image.file}
+    }
+    fw_response = forward_request(fw_index, fw_data, '/api/fd/')
+    if fw_response is not None:
+        return JSONResponse({
+            "faces": fw_response["data"]["faces"]
+        })
+
+    # Check if image is None
+    if image is None:
+        raise HTTPException(status_code=400, detail="Image is required")
+    # Check if image is empty
+    if image.filename == '':
+        raise HTTPException(status_code=400, detail="Image is empty")
+    # Read image
+    image_bytes = await image.read()
+    # Process image
+    detected_faces = faces_detection_controller(image_bytes)
+    return JSONResponse({"faces": detected_faces})

apps/apis/fd/controllers/fd_controller.py

@@ -0,0 +1,32 @@
+import numpy as np
+import cv2 as cv
+import mediapipe as mp
+from mediapipe.tasks import python
+from mediapipe.tasks.python import vision
+
+base_options = python.BaseOptions(model_asset_path='resources/fd_model.tflite')
+options = vision.FaceDetectorOptions(base_options=base_options)
+detector = vision.FaceDetector.create_from_options(options)
+
+
+def format_detections(detection_result):
+    faces = []
+    for detection in detection_result.detections:
+        face = {
+            "bbox": {
+                "x": detection.bounding_box.origin_x,
+                "y": detection.bounding_box.origin_y,
+                "width": detection.bounding_box.width,
+                "height": detection.bounding_box.height,
+            },
+        }
+        faces.append(face)
+    return faces
+
+
+def faces_detection_controller(image: bytes):
+    cv_image = cv.imdecode(np.frombuffer(image, np.uint8), cv.IMREAD_COLOR)
+    mp_image = mp.Image(image_format=mp.ImageFormat.SRGB, data=cv_image)
+    # Process image
+    detection_result = detector.detect(mp_image)
+    return format_detections(detection_result)

apps/apis/fd/models/fd_model.py

@@ -0,0 +1,8 @@
+from fastapi import File, UploadFile
+
+
+class FaceDetectionModel:
+    image = UploadFile | None
+    image_default = File(
+        None, description="Image for face detection", example="image.jpg")
+    fw_index = int | None

apps/services/foward/fw_middleware.py

@@ -18,7 +18,7 @@ async def verify_fw_resources(url: str) -> bool:
 async def forward_middleware(fw: str = None):
     # Verify forward destination index
     try:
-        if fw != 'auto':
+        if fw != 'auto' and fw is not None:
             fw = int(fw)
     except Exception:
         raise HTTPException(
@@ -46,12 +46,16 @@ async def forward_middleware(fw: str = None):
             fw = None
     # If forward destination is not auto, update forward destination tasks
     else:
-        update_fw_destination(fw, fw_destinations[fw]['tasks'] + 1)
+        if fw is not None:
+            update_fw_destination(fw, fw_destinations[fw]['tasks'] + 1)
 
     return fw
 
 
 def forward_request(fw_index: int, data: Any, endpoint: str = '', method: Literal['GET', 'POST', 'PUT', 'DELETE'] = 'POST'):
+    # Return None if fw_index is None
+    if fw_index is None:
+        return None
     # Get forward destination url
     fw_destinations = get_fw_destinations()
     fw_url = fw_destinations[fw_index]['url'] + endpoint

apps/services/foward/fw_storage.py

@@ -1,11 +1,12 @@
 from utils.local_storage import read_from_local, save_to_local
+from utils.constants import DATA_DIR
 
 
 FOWARD_JSON_FILE = 'forward.json'
 
 
 def get_fw_destinations() -> list:
-    destinations = read_from_local(FOWARD_JSON_FILE)
+    destinations = read_from_local(FOWARD_JSON_FILE, DATA_DIR)
     if destinations is None:
         return []
     return destinations
@@ -23,7 +24,7 @@ def append_fw_destination(url: str):
         "url": url
     })
     # Save to local
-    save_to_local(forward_destinations, FOWARD_JSON_FILE, False)
+    save_to_local(forward_destinations, FOWARD_JSON_FILE, False, DATA_DIR)
     # Return index
     return len(forward_destinations) - 1
 
@@ -34,7 +35,7 @@ def update_fw_destination(index: int, tasks: int):
     # Update destination
     forward_destinations[index]['tasks'] = tasks
     # Save to local
-    save_to_local(forward_destinations, FOWARD_JSON_FILE, False)
+    save_to_local(forward_destinations, FOWARD_JSON_FILE, False, DATA_DIR)
 
 
 def delete_fw_destination(index: int):
@@ -43,4 +44,4 @@ def delete_fw_destination(index: int):
     # Delete destination
     del forward_destinations[index]
     # Save to local
-    save_to_local(forward_destinations, FOWARD_JSON_FILE, False)
+    save_to_local(forward_destinations, FOWARD_JSON_FILE, False, DATA_DIR)

main.py

@@ -2,7 +2,6 @@
 import os
 import uvicorn
 from apps.create_app import create_app
-from apps.services.foward.fw_middleware import forward_middleware
 # Import routers
 from apps.apis import router as api_router
 from apps.services import router as service_router

utils/constants.py

@@ -4,6 +4,8 @@ APP_DOMAIN = "http://localhost:8000"
 
 TEMP_DIR = os.path.join(os.getcwd(), 'temp')
 
+DATA_DIR = os.path.join(os.getcwd(), 'data')
+
 DOC_TEMPLATE = f'''
 <!DOCTYPE html>
 <html>

utils/local_storage.py

@@ -31,7 +31,7 @@ def parse_filename(filename: str):
     return filename
 
 
-def save_to_local(file: bytes | Any, filename: str, is_parse_filename: bool = True):
+def save_to_local(file: bytes | Any, filename: str, is_parse_filename: bool = True, directory: str = TEMP_DIR):
     # Parse filename
     if is_parse_filename:
         filename = parse_filename(filename)
@@ -43,7 +43,7 @@ def save_to_local(file: bytes | Any, filename: str, is_parse_filename: bool = Tr
     else:
         mode = 'wb'
     # Save file
-    with open(os.path.join(TEMP_DIR, filename), mode) as f:
+    with open(os.path.join(directory, filename), mode) as f:
         if file_extension == 'json':
             json.dump(file, f)
         else:
@@ -52,7 +52,7 @@ def save_to_local(file: bytes | Any, filename: str, is_parse_filename: bool = Tr
     return f"{APP_DOMAIN}/static/{filename}"
 
 
-def read_from_local(filename: str):
+def read_from_local(filename: str, directory: str = TEMP_DIR):
     # Get type of file
     file_extension = filename.split('.')[-1]
     # Get read mode
@@ -61,21 +61,21 @@ def read_from_local(filename: str):
     else:
         mode = 'rb'
     # If file is exist, return file
-    if os.path.isfile(os.path.join(TEMP_DIR, filename)):
-        with open(os.path.join(TEMP_DIR, filename), mode) as f:
+    if os.path.isfile(os.path.join(directory, filename)):
+        with open(os.path.join(directory, filename), mode) as f:
             if file_extension == 'json':
                 return json.load(f)
             return f.read()
 
 
-def remove_from_local(filename: str):
+def remove_from_local(filename: str, directory: str = TEMP_DIR):
     # If file is exist, add number to filename
-    if os.path.isfile(os.path.join(TEMP_DIR, filename)):
-        os.remove(os.path.join(TEMP_DIR, filename))
+    if os.path.isfile(os.path.join(directory, filename)):
+        os.remove(os.path.join(directory, filename))
 
 
-def remove_from_local_with_expire(filename: str, expire: int):
+def remove_from_local_with_expire(filename: str, expire: int, directory: str = TEMP_DIR):
     # Remove file after expire time
     if expire is not None and expire > 0:
-        t = Timer(expire, remove_from_local, args=[filename])
+        t = Timer(expire, remove_from_local, args=[filename, directory])
         t.start()