Merge branch 'main' of https://github.com/adexoxo13/ResearchAgent

Author: adexoxo13

api/research_api.py

@@ -72,11 +72,16 @@ def post(self):
 
             # Construct API response
             return {
-                "topic": structured_response.topic,  # Research topic title
-                "summary": html_summary,  # HTML-formatted content
-                "sources": structured_response.sources,  # Reference URLs
-                "tools": structured_response.tools_used,  # AI tools utilized
-                "download_link": f"/download/{filename}",  # File access endpoint
+                "topic": structured_response.topic, 
+                # Research topic title
+                "summary": html_summary,  
+                # HTML-formatted content
+                "sources": structured_response.sources, 
+                # Reference URLs
+                "tools": structured_response.tools_used,  
+                # AI tools utilized
+                "download_link": f"/download/{filename}",  
+                # File access endpoint
                 "processing_time": round(
                     time.time() - start_time, 2
                 ),  # Duration in seconds
@@ -87,7 +92,8 @@ def post(self):
             print("Error in /research:", e)  # Server-side logging
             return {
                 "error": str(e),  # Developer-facing message
-                "details": "Check server logs for more information",  # User guidance
+                "details": "Check server logs for more information",  
+                # User guidance
             }, 500  # HTTP 500 Internal Server Error
 
 
@@ -109,7 +115,8 @@ def get(self, filename):
         - Enable authentication in production
         """
         # Configure secure download path
-        downloads_folder = os.path.join(os.getcwd(), "outputs")  # Isolate files
+        downloads_folder = os.path.join(os.getcwd(), "outputs") 
+        # Isolate files
 
         # Safe file serving with Flask's send_from_directory
         return send_from_directory(
@@ -122,7 +129,7 @@ def get(self, filename):
 """
 API Security Notes:
 1. Authentication: Currently disabled (enable method_decorators for JWT)
-2. Input Validation: 
+2. Input Validation:
    - Research endpoint validates query exists
    - Download endpoint needs filename sanitization
 3. File Security:

tools.py

@@ -1,8 +1,9 @@
 """
 AI Research Agent - Core Tools Module
 
-This module implements essential research capabilities for an AI assistant system,
-integrating web search, Wikipedia access, and persistent storage functionality.
+This module implements essential research capabilities for an AI assistant
+system, integrating web search, Wikipedia access, and persistent storage 
+functionality.
 """
 
 # Import LangChain components for knowledge retrieval and tool integration
@@ -85,7 +86,7 @@ def save_to_txt(data: str, filename: str = "research_output.txt"):
 
 Usage Flow:
 1. Agent uses search_tool for initial investigation
-2. Verifies facts with wiki_tool 
+2. Verifies facts with wiki_tool
 3. Saves validated findings with save_tool
 4. Process repeats for iterative research
 """

utils/agent_setup.py

@@ -73,29 +73,36 @@ class ResearchResponse(BaseModel):
     [
         (
             "system",
-            """You are a research assistant that will help generate a research paper.
-            Answer the user query and use necessary tools.
-            Wrap the output in this format and provide no other text\n{format_instructions}""",
+            """You are a research assistant that will
+            help generate a research paper. Answer the
+            user query and use the necessary tools. Wrap
+            the output in this format and provide no
+            other text\n{format_instructions}""",
         ),
-        ("placeholder", "{chat_history}"),  # Conversation context storage
-        ("human", "{query}"),  # User input placeholder
-        ("placeholder", "{agent_scratchpad}"),  # Agent's working memory
+        ("placeholder", "{chat_history}"),
+        # Conversation context storage
+        ("human", "{query}"),
+        # User input placeholder
+        ("placeholder", "{agent_scratchpad}"),
+        # Agent's working memory
     ]
 ).partial(format_instructions=parser.get_format_instructions())
 
 # -----------------------------------------------------------------------------
 # Tool Configuration
 # -----------------------------------------------------------------------------
 tools = [search_tool, save_tool]  # Core research tools
-# tools = [search_tool, wiki_tool, save_tool]  # Uncomment for Wikipedia integration
+# tools = [search_tool, wiki_tool, save_tool]
+# Uncomment for Wikipedia integration
 
 # -----------------------------------------------------------------------------
 # Agent Assembly
 # -----------------------------------------------------------------------------
 agent = create_tool_calling_agent(llm=llm, prompt=prompt, tools=tools)
 
 agent_executor = AgentExecutor(
-    agent=agent, tools=tools, verbose=True  # Enable detailed execution logging
+    agent=agent, tools=tools, verbose=True
+    # Enable detailed execution logging
 )
 
 """