feat: add mock conversation api and models

.gitignore

@@ -6,6 +6,10 @@ dist/
 wheels/
 *.egg-info
 
+# ide
+.idea/
+.vscode/
+
 # Virtual environments
 .venv
 
@@ -18,3 +22,6 @@ app.log
 # API key
 api_key.txt
 
+.ruff_cache/
+
+*_UML*

app/api/chat_api.py

@@ -3,16 +3,23 @@
 from typing import List
 from fastapi import APIRouter, HTTPException, Depends
 from app.schema.chat_schema import ChatCompletionRequest, ChatCompletionResponse, MessageResponse, PlotResponse
+from app.schema.conversation import ConversationResponse
 from app.service.chat_service import ChatService
 from app.security.auth_service import AuthService
+from app.core.api_response import api_response
+
 
 router = APIRouter(prefix="/v1", tags=["chat"])
 service = ChatService()
 auth_service = AuthService()
 
+################
+# chat completion api list
+################
 # create a chat completion
-@router.post("/chat/completions", response_model=ChatCompletionResponse, dependencies=[Depends(auth_service.verify_credentials)])
-async def create(req: ChatCompletionRequest, username: str = Depends(auth_service.verify_credentials)):
+@api_response()
+@router.post("/chat/completions", response_model=ChatCompletionResponse)
+async def create_chat_completion(req: ChatCompletionRequest, username: str = Depends(auth_service.verify_credentials)):
     """
     Chat completion API - Given a list of messages comprising a conversation, the model will return a response.
     If completion_id is not provided, start a new chat completion by providing a list of messages.
@@ -26,8 +33,8 @@ async def create(req: ChatCompletionRequest, username: str = Depends(auth_servic
 
 
 # get all chat completions
-@router.get("/chat/completions", response_model=List[ChatCompletionResponse], dependencies=[Depends(auth_service.verify_credentials)])
-async def find(username: str = Depends(auth_service.verify_credentials)):
+@router.get("/chat/completions", response_model=List[ChatCompletionResponse])
+async def list_chat_completions(username: str = Depends(auth_service.verify_credentials)):
     """
     Get all chat completions
     Summary: First load the chat interface(UI) for list of chat completions on the left side.
@@ -46,8 +53,8 @@ async def find(username: str = Depends(auth_service.verify_credentials)):
 
 
 # get a chat completion by id
-@router.get("/chat/completions/{completion_id}", response_model=ChatCompletionResponse, dependencies=[Depends(auth_service.verify_credentials)])
-async def find_by_id(completion_id: str, username: str = Depends(auth_service.verify_credentials)):
+@router.get("/chat/completions/{completion_id}", response_model=ChatCompletionResponse)
+async def retrieve_chat_completion(completion_id: str, username: str = Depends(auth_service.verify_credentials)):
     """
     Get a chat completion by id
     Summary: Click on a chat completion on the left side to load the chat completion on the right side.
@@ -59,8 +66,8 @@ async def find_by_id(completion_id: str, username: str = Depends(auth_service.ve
 
 
 # get all messages for a chat completion
-@router.get("/chat/completions/{completion_id}/messages", response_model=List[MessageResponse], dependencies=[Depends(auth_service.verify_credentials)])
-async def find_messages(completion_id: str, username: str = Depends(auth_service.verify_credentials)):
+@router.get("/chat/completions/{completion_id}/messages", response_model=List[MessageResponse])
+async def list_messages(completion_id: str, username: str = Depends(auth_service.verify_credentials)):
     """
     Get all messages for a chat completion
     Summary: Click on a chat completion on the left side to load the chat completion on the right side.
@@ -71,9 +78,12 @@ async def find_messages(completion_id: str, username: str = Depends(auth_service
         raise HTTPException(status_code=500, detail=str(e))
 
 
+################
+# plot api list
+################
 # get a plot for a message
-@router.get("/chat/completions/{completion_id}/messages/{message_id}/plot", response_model=PlotResponse, dependencies=[Depends(auth_service.verify_credentials)])
-async def find_plot(completion_id: str, message_id: str, username: str = Depends(auth_service.verify_credentials)):
+@router.get("/chat/completions/{completion_id}/messages/{message_id}/plot", response_model=PlotResponse)
+async def retrieve_plot(completion_id: str, message_id: str, username: str = Depends(auth_service.verify_credentials)):
     """
     Get a plot figure for a message to visualize the data
     Summary: Click on a message on the right side to load the plot on the right side.
@@ -84,7 +94,32 @@ async def find_plot(completion_id: str, message_id: str, username: str = Depends
         raise HTTPException(status_code=500, detail=str(e))
 
 
+################
+# conversation api list
+################
+# GET https://chatgpt.com/backend-api/conversations
+# GET https://chatgpt.com/backend-api/conversations/{completion_id}
 
 
+# get all conversations
+@api_response()
+@router.get("/conversations", response_model=List[ConversationResponse])
+async def list_conversations(username: str = Depends(auth_service.verify_credentials)):
+    """
+    Get all conversations
+    """
+    try:
+        return await service.find_all_conversations(username)
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=str(e))
 
-
+# get a conversation by id
+@router.get("/conversations/{completion_id}", response_model=ConversationResponse)
+async def retrieve_conversation(completion_id: str, username: str = Depends(auth_service.verify_credentials)):
+    """
+    Get a conversation by id
+    """
+    try:
+        return await service.find_conversation_by_id(completion_id)
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=str(e))

app/core/__init__.py

@@ -0,0 +1,3 @@
+"""
+Core module for the application.
+"""

app/model/chat_model.py

@@ -37,7 +37,11 @@ from typing import List
 #     },
 #     {
 #       "role": "assistant",
-#       "content": "**Between Cities**: Take a high-speed train (Italo or Trenitalia) from Rome to Florence. Book in advance for tickets around €25-35 one-way (1.5 hours). Trains depart from Roma Termini and arrive at Firenze Santa Maria Novella. Check schedules on trenitalia.com or italo.it.\n\n**Within Florence**: Florence is compact and walkable, so you won’t need much public transport. For longer distances (e.g., to Piazzale Michelangelo), use ATAF buses (~€1.50 per ride, buy tickets at tabaccherie). Alternatively, rent a bike (~€10/day) for a scenic way to explore. Taxis are pricier (~€10-15 for short trips), so stick to walking or buses for budget travel."
+#       "content": "**Between Cities**: Take a high-speed train (Italo or Trenitalia) from Rome to Florence. Book in advance for tickets around €25-35 one-way (1.5 hours). Trains depart from Roma Termini and arrive at Firenze Santa Maria Novella. Check schedules on trenitalia.com or italo.it.\n\n**Within Florence**: Florence is compact and walkable, so you won’t need much public transport. For longer distances (e.g., to Piazzale Michelangelo), use ATAF buses (~€1.50 per ride, buy tickets at tabaccherie). Alternatively, rent a bike (~€10/day) for a scenic way to explore. Taxis are pricier (~€10-15 for short trips), so stick to walking or buses for budget travel.",
+#        "plot": {
+#            "data": {},
+#            "layout": {}
+#        }
 #     }
 #   ],
 #   "temperature": 0.8,

app/repository/chat_repository.py

@@ -20,6 +20,9 @@ class ChatRepository:
         completion_id = str(result.upserted_id) if result.upserted_id else entity.completion_id
         entity.completion_id = completion_id
 
+        # save conversation if new chat completion
+        # TODO: save conversation
+
         return entity
 
     def find(self, query: dict, page: int = 1, limit: int = 10, sort: dict = None, project: dict = None) -> List[ChatCompletion]:

app/service/chat_service.py

@@ -5,6 +5,9 @@ from app.schema.chat_schema import ChatCompletionRequest, ChatCompletionResponse
 from app.model.chat_model import ChatCompletion, ChatMessage
 import uuid
 
+from app.schema.conversation import ConversationResponse
+
+
 class ChatService:
     def __init__(self):
         self.chat_repository = ChatRepository()
@@ -44,4 +47,9 @@ class ChatService:
     async def find_messages(self, completion_id: str) -> List[ChatMessage]:
         return self.chat_repository.find_messages(completion_id)
     
-    
+    # conversation service
+    async def find_all_conversations(self, username: str) -> List[ConversationResponse]:
+        raise NotImplementedError("Not implemented")
+    
+    async def find_conversation_by_id(self, completion_id: str) -> ConversationResponse:
+        raise NotImplementedError("Not implemented")