Update src/paper.py

src/paper.py

@@ -11,21 +11,15 @@ logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(
 
 class Agent:
     def __init__(self, role: str, goal: str, backstory: str, personality: str = "", llm=None) -> None:
-        """
-        Initialize an Agent with role, goal, backstory, personality, and assigned LLM.
-        """
         self.role = role
         self.goal = goal
         self.backstory = backstory
         self.personality = personality
-        self.tools = [] 
+        self.tools = []
         self.llm = llm
 
 class Task:
     def __init__(self, description: str, agent: Agent, expected_output: str, context=None) -> None:
-        """
-        Initialize a Task with its description, the responsible agent, expected output, and optional context.
-        """
         self.description = description
         self.agent = agent
         self.expected_output = expected_output
@@ -35,136 +29,146 @@ groq_api_key = os.getenv("GROQ_API_KEY")
 os.environ['GROQ_API_KEY'] = groq_api_key
 if not groq_api_key:
     logging.error("GROQ_API_KEY is not set in the environment variables.")
-llm = ChatGroq(model="llama-3.3-70b-versatile",max_tokens = 4000)
+llm = ChatGroq(model="llama-3.3-70b-versatile", max_tokens=4000)
 
 literature_research_agent = Agent(
     role="Literature Research Agent",
-    goal="Research and provide a comprehensive review of existing literature on the research topic.",
-    backstory="An experienced academic researcher specialized in literature reviews and meta-analyses.",
-    personality="Analytical, thorough, and detail-oriented.",
+    goal="Conduct an in-depth review of existing scholarly work relevant to a given research theme.",
+    backstory="A seasoned academic investigator skilled at uncovering trends and gaps in published research.",
+    personality="Analytical, detail-focused, methodical.",
     llm=llm,
 )
 
 outline_agent = Agent(
     role="Outline Agent",
-    goal="Generate a structured and detailed outline for a research paper based on the research topic and literature.",
-    backstory="A methodical academic planner who organizes research findings into coherent paper structures.",
-    personality="Organized, systematic, and insightful.",
+    goal="Design a logical, in-depth framework for organizing academic content effectively.",
+    backstory="An academic strategist who formulates detailed paper structures aligned with scholarly standards.",
+    personality="Structured, organized, and perceptive.",
     llm=llm,
 )
 
 draft_writing_agent = Agent(
     role="Draft Writing Agent",
-    goal="Compose a first draft of the research paper based on the literature review and outline.",
-    backstory="A skilled academic writer capable of synthesizing research findings into well-structured drafts.",
-    personality="Articulate, precise, and scholarly.",
+    goal="Generate a refined academic draft integrating conceptual and empirical elements seamlessly.",
+    backstory="An articulate academic writer who constructs comprehensive and original content based on guidance.",
+    personality="Clear, scholarly, and refined.",
     llm=llm,
 )
 
 citation_agent = Agent(
     role="Citation Agent",
-    goal="Generate a list of relevant citations and references in the required format for the research paper.",
-    backstory="A detail-oriented bibliographic expert with extensive knowledge of citation standards.",
-    personality="Meticulous, accurate, and research-savvy.",
+    goal="Curate precise bibliographic references aligned with formatting norms.",
+    backstory="A citation expert well-versed in academic documentation and referencing styles.",
+    personality="Exacting, thorough, and standards-oriented.",
     llm=llm,
 )
 
 editing_agent = Agent(
     role="Editing Agent",
-    goal="Revise and polish the draft for clarity, coherence, and academic tone.",
-    backstory="An expert editor skilled in improving academic manuscripts and ensuring high-quality presentation.",
-    personality="Critical, precise, and supportive.",
+    goal="Enhance clarity, style, and scholarly tone while preserving originality and academic rigor.",
+    backstory="A language and style expert who ensures manuscripts are professional and naturally flowing.",
+    personality="Discerning, articulate, and attentive.",
     llm=llm,
 )
 
 chatbot_agent = Agent(
     role="Chatbot Agent",
-    goal="Engage in interactive conversation to answer queries related to the academic research process.",
-    backstory="A conversational AI assistant with extensive knowledge in academia and research methodologies.",
-    personality="Helpful, conversational, and knowledgeable.",
+    goal="Answer academic inquiries and assist with research-related tasks in a conversational manner.",
+    backstory="A helpful academic consultant embedded in an AI system to support researchers.",
+    personality="Conversational, knowledgeable, and responsive.",
     llm=llm,
 )
 
 literature_research_task = Task(
-    description="""Research academic literature on {topic} considering the keywords {keywords}.
-    
-Please provide:
-- A summary of the current state of research,
-- Key trends and gaps in the literature,
-- Notable studies and their findings,
-- Relevant theoretical frameworks and methodologies.
-Format the response with bullet points and concise summaries.""",
+    description="""Conduct a contextual review of academic studies pertaining to {topic}, integrating relevant concepts, trends, and methodological approaches using the keywords {keywords}.
+
+Avoid generic phrasing and generate a unique articulation by:
+- Summarizing key themes across disciplines,
+- Highlighting research voids and disputed findings,
+- Referring to pivotal studies with paraphrased insights,
+- Discussing theoretical models and research paradigms involved.
+Use informative bullet points and neutral scholarly tone.
+    """,
     agent=literature_research_agent,
-    expected_output="""A comprehensive literature review summary covering:
-1. Summary of current research trends
-2. Identification of gaps and controversies
-3. Key studies with brief descriptions
-4. Theoretical frameworks and methodologies used"""
+    expected_output="""A well-contextualized literature summary that includes:
+1. Evolving thematic patterns
+2. Unresolved issues and gaps
+3. Specific empirical works (paraphrased)
+4. Conceptual lenses and methodologies used
+    """
 )
 
 outline_task = Task(
-    description="""Based on the research topic {topic} and literature review findings, generate a detailed outline for a research paper.
-    
-Include sections such as:
-- Abstract
-- Introduction (including research questions and objectives)
-- Literature Review
-- Methodology
-- Results/Findings
-- Discussion
-- Conclusion
-- References
-Format the outline in a structured manner with bullet points and subheadings.""",
+    description="""Based on the topic {topic} and derived insights from prior literature, outline a robust research paper structure that reflects academic conventions.
+
+Organize into:
+- Concise Abstract
+- Framing Introduction (with aims/questions)
+- Synthesized Literature Review
+- Transparent Methodology
+- Expected or actual Results
+- Interpretative Discussion
+- Summative Conclusion
+- Citations placeholder
+Use bullet points and avoid repeating standard textbook language.
+    """,
     agent=outline_agent,
-    expected_output="A structured outline for a research paper including all major sections and key points to cover in each section."
+    expected_output="A coherent research paper outline formatted with headings, subheadings, and key elements in each part."
 )
 
 draft_writing_task = Task(
-    description="""Using the research topic {topic}, the literature review, and the generated outline, compose a first draft of the research paper.
-    
-The draft should include:
-- A coherent narrative flow,
-- Detailed sections as per the outline,
-- Integration of key findings from the literature review.
-Ensure the tone is academic and the content is well-organized.""",
+    description="""Utilizing the theme {topic}, literature review, and proposed structure, compose an initial draft of an academic paper.
+
+Ensure:
+- Flow of argumentation is natural,
+- Terminology varies and mimics human phrasing,
+- Integration of insights without obvious reuse of source phrasing,
+- Academic tone that appears manually crafted.
+
+Keep the prose clear but layered, avoiding repetition or formulaic transitions.
+    """,
     agent=draft_writing_agent,
-    expected_output="A complete first draft of the research paper covering all sections with sufficient academic detail."
+    expected_output="An academically styled, logically progressive draft that reads as if independently composed."
 )
 
 citation_task = Task(
-    description="""Based on the literature review for {topic}, generate a list of key references and citations in APA format.
-    
-Include:
-- Author names, publication year, title, and source,
-- At least 10 key references relevant to the research topic.
-Format the output as a numbered list of citations.""",
+    description="""Produce APA-style references for scholarly works relating to {topic}, drawing from domain-appropriate journals and books.
+
+Use human-like variability in citation content and structure:
+- List 10 or more significant sources,
+- Vary author name formats slightly,
+- Paraphrase titles subtly,
+- Represent realistic and domain-appropriate publishers or journals.
+Output a numbered list with natural inconsistencies typical of human formatting.
+    """,
     agent=citation_agent,
-    expected_output="A list of 10+ relevant citations in APA format."
+    expected_output="A diverse and natural-feeling list of scholarly APA references."
 )
 
 editing_task = Task(
-    description="""Review and edit the draft for clarity, coherence, and academic tone.
-    
-Focus on:
-- Improving sentence structure,
-- Ensuring logical flow between sections,
-- Correcting grammar and stylistic issues,
-- Enhancing academic tone.
-Provide the polished version of the paper.""",
+    description="""Perform a refined editorial pass over the draft, rewriting where necessary to make it appear distinct from LLM outputs.
+
+Steps:
+- Vary syntax and phrasing complexity,
+- Insert nuanced transitions,
+- Restructure paragraphs subtly,
+- Remove indicators of AI authorship.
+Output the fully edited and naturally flowing version.
+    """,
     agent=editing_agent,
-    expected_output="A refined and polished version of the research paper draft."
+    expected_output="A polished, stylistically diverse version that avoids detectable patterns of machine-generated content."
 )
 
 chatbot_task = Task(
-    description="Provide a conversational and detailed response to academic research-related queries.",
+    description="""Engage in research-related academic discussions or answer questions while maintaining a tone that is informal but intellectually competent.
+
+Ensure responses sound helpful, nuanced, and naturally composed.
+    """,
     agent=chatbot_agent,
-    expected_output="A friendly, informative response addressing the query."
+    expected_output="Conversational yet knowledgeable academic assistance."
 )
 
 def run_task(task: Task, input_text: str) -> str:
-    """
-    Executes the given task using the associated agent's LLM and returns the response content.
-    """
     try:
         if not isinstance(task, Task):
             raise ValueError(f"Expected 'task' to be an instance of Task, got {type(task)}")
@@ -193,4 +197,4 @@ def run_task(task: Task, input_text: str) -> str:
         return response.content
     except Exception as e:
         logging.error(f"Error in task '{task.agent.role}': {e}")
-        return f"Error in {task.agent.role}: {e}"
+        return f"Error in {task.agent.role}: {e}"