Merge pull request #42 from oxbridge-econ/abdur/get-user-doc-count

app/app.py

@@ -10,7 +10,7 @@ from fastapi.responses import JSONResponse
 from apscheduler.schedulers.asyncio import AsyncIOScheduler
 from apscheduler.triggers.cron import CronTrigger
 
-from routes import category, summary, keyword, lda # pylint: disable=import-error
+from routes import category, summary, keyword, lda, entity # pylint: disable=import-error
 
 
 class Config: # pylint: disable=too-few-public-methods
@@ -172,6 +172,7 @@ app.include_router(category.router)
 app.include_router(summary.router)
 app.include_router(keyword.router)
 app.include_router(lda.router)
+app.include_router(entity.router)
 
 @app.get("/_health")
 def health():

app/controllers/entity.py

@@ -0,0 +1,29 @@
+"""Controller for entity-related operations."""
+from models.database import entity_collection
+
+def retrieve_hot_entity():
+    """Retrieves the top 200 documents from a MongoDB collection,
+    sorted by the occurrence field in descending order.
+    The function returns a dict containing the count of documents and a list of documents
+    Parameters
+    None
+
+    Type: dict
+    Structure:
+
+    Count (int): The number of documents retrieved (up to 200).
+    Items (list): A list of dictionaries, each containing:
+
+    entity: The value of the entity field from the document.
+    entityType: The value of the entityType field from the document.
+    total_occurrence: The value of the occurrence field from the document.
+    """
+    result = list(entity_collection.find(
+        {},
+        {'entity': 1, 'entityType': 1, 'total_occurrence': '$occurrence', '_id': 0}
+    ).sort('occurrence', -1).limit(200))
+    res = {
+        "Count": len(result),
+        "Items": result
+    }
+    return res

app/routes/entity.py

@@ -0,0 +1,32 @@
+"""This module defines the /lda route for the FastAPI application."""
+
+import logging
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
+from controllers.entity import retrieve_hot_entity # pylint: disable=import-error
+
+# Configure logger
+logger = logging.getLogger(__name__)
+
+# Create FastAPI Router
+router = APIRouter(prefix="/entity", tags=["entity"])
+
+@router.get('/hot')
+async def get_hot_entity():
+    """
+    Handles GET requests to retrieve hot entity.
+
+    Returns:
+        dict: JSON response containing count and a list of hot entity.
+    """
+    return JSONResponse(content=retrieve_hot_entity())
+
+@router.post('/hot')
+async def post_hot_entity():
+    """
+    Handles GET requests to retrieve hot entity.
+
+    Returns:
+        dict: JSON response containing count and a list of hot entity.
+    """
+    return JSONResponse(content=retrieve_hot_entity())

app/routes/summary.py

@@ -62,7 +62,6 @@ async def get_user_document_stats(
             detail="Internal server error while retrieving document statistics."
         )
 
-
 @router.get('')
 async def get_summary() -> JSONResponse:
     """