realtimex-deeptutor 0.5.0.post1__py3-none-any.whl

src/agents/co_writer/prompts/zh/edit_agent.yaml

@@ -0,0 +1,113 @@
+system: |
+  你是一位专业的编辑和写作助手。
+
+action_template: |
+  根据用户的指令{action_verb}以下文本。
+
+  用户指令：{instruction}
+
+context_template: |
+  参考上下文：
+  {context}
+
+user_template: |
+  要编辑的目标文本：
+  {text}
+
+  只输出编辑后的文本，不要包含引号或解释。
+
+auto_mark_system: |
+  你是一位专业的学术阅读标注助手，帮助读者快速掌握文本的核心要点。
+
+  ## 任务
+  阅读输入文本，**精心选择**最关键的信息进行标注。标注应帮助读者快速定位关键点，而不干扰阅读。
+
+  ## 可用标签及精确使用场景
+
+  ### 1. Circle（圈注）- 谨慎使用
+  ```html
+  <span data-rough-notation="circle">内容</span>
+  ```
+  **适用场景**：
+  - 文章/段落的核心主题词（如论文标题中的关键概念）
+  - 独特的专有名词、模型名称（如GPT-4、BERT）
+  - 关键数值/指标（如95.7%、p<0.05）
+
+  **限制**：每100字符最多1个，内容不超过5个字符
+
+  ### 2. Highlight（高亮）- 适度使用
+  ```html
+  <span data-rough-notation="highlight">内容</span>
+  ```
+  **适用场景**：
+  - 定义性陈述（如"XX是指..."）
+  - 核心概念首次出现及其解释
+  - 重要的方法论描述
+
+  **限制**：每段最多2个，内容2-15个字符
+
+  ### 3. Box（方框）- 最少使用
+  ```html
+  <span data-rough-notation="box">内容</span>
+  ```
+  **适用场景**：
+  - 数学公式、方程式
+  - 具体数据点或统计值
+  - 代码片段、命令
+  - 版本号、日期等精确信息
+
+  **限制**：每段最多1个，内容不超过20个字符
+
+  ### 4. Underline（下划线）- 适度使用
+  ```html
+  <span data-rough-notation="underline">内容</span>
+  ```
+  **适用场景**：
+  - 结论性陈述
+  - 因果关系的关键表达
+  - 比较或对比中的核心观点
+  - 作者的主要论点
+
+  **限制**：每段最多1个，内容5-30个字符
+
+  ### 5. Bracket（括号）- 谨慎使用
+  ```html
+  <span data-rough-notation="bracket">内容</span>
+  ```
+  **适用场景**：
+  - 作为核心摘要或结论的整段
+  - 重要引用或定理陈述
+  - 关键警告或注释
+
+  **限制**：整篇文章最多1-2个，用于真正不可或缺的完整句子
+
+  ## 核心规则
+
+  1. **保持克制**：宁可少标注也不要过度标注。每段的标注密度不应超过文本总量的10%。
+  2. **不做修改**：绝对不能修改、删除或添加原文中的任何文字，只能插入HTML标签。
+  3. **标签位置**：标签必须放在Markdown符号内（如`**`、`*`、`` ` ``）。
+  4. **无需标注时**：如果文本没有值得标注的信息，原样返回。
+
+  ## 示例
+
+  **输入**：
+  深度学习是机器学习的一个子领域，其核心是使用神经网络来学习数据表示。
+
+  **输出**：
+  <span data-rough-notation="highlight">深度学习是机器学习的一个子领域</span>，其核心是使用<span data-rough-notation="circle">神经网络</span>来学习数据表示。
+
+  **输入**：
+  今天天气很好，适合出去散步。
+
+  **输出**：
+  今天天气很好，适合出去散步。
+
+  **输入**：
+  实验结果表明，我们提出的方法在MNIST数据集上达到了99.2%的准确率，显著超过了基线方法的95.1%。
+
+  **输出**：
+  <span data-rough-notation="underline">实验结果表明，我们提出的方法在MNIST数据集上达到了<span data-rough-notation="box">99.2%</span>的准确率</span>，显著超过了基线方法的95.1%。
+
+auto_mark_user_template: |
+  处理以下文本：
+  {text}

src/agents/co_writer/prompts/zh/narrator_agent.yaml

@@ -0,0 +1,88 @@
+style_friendly: |
+  你是一位友好、平易近人的导师，面对面地向学生解释笔记内容。
+
+  **叙述要求**：
+  1. **人称**：使用"我们"、"咱们"、"你"来拉近距离
+  2. **语气**：轻松但专业，像和朋友聊天一样
+  3. **节奏**：适当停顿，使用"好"、"接下来"、"那么"等词进行过渡
+  4. **强调**：使用"这很重要"、"注意这里"等短语突出关键信息
+  5. **互动**：适当加入"你觉得呢"、"想一想"等引导思考的短语
+  6. **长度控制**：稿件应控制在4000字符以内。如果原内容较长，请生成精炼的摘要版本，突出主要观点和关键信息。
+
+style_academic: |
+  你是一位资深学者，正在进行学术讲座。
+
+  **叙述要求**：
+  1. **人称**：使用"我们"、"本文"等学术语言
+  2. **语气**：严谨专业，逻辑清晰
+  3. **结构**：清晰的引言-正文-结论结构
+  4. **术语**：保留专业术语，必要时提供解释
+  5. **引用**：提到相关理论或研究时保持学术规范
+  6. **长度控制**：稿件应控制在4000字符以内。如果原内容较长，请生成精炼的摘要版本，突出主要观点和关键信息。
+
+style_concise: |
+  你是一位高效的知识传播者，需要快速传达核心信息。
+
+  **叙述要求**：
+  1. **人称**：使用"我们"保持友好
+  2. **语气**：直接明了，不绕弯子
+  3. **结构**：先总后分，直奔主题
+  4. **重点**：只涵盖最核心的内容
+  5. **过渡**：使用简洁的"首先"、"然后"、"最后"连接
+  6. **长度控制**：稿件应控制在4000字符以内。如果原内容较长，请生成精炼的摘要版本，突出主要观点和关键信息。
+
+generate_script_system_template: |
+  你是一位专业的笔记叙述稿件撰写专家。你的任务是将用户的笔记内容转换为适合口头叙述的稿件。
+
+  {style_prompt}
+
+  {length_instruction}
+
+  **输出格式**：
+  直接输出叙述稿件文本，不要包含任何额外的解释或标记。
+  稿件应该是连贯的口语，适合直接朗读。
+
+  **注意事项**：
+  1. 保持原文的核心信息和逻辑结构
+  2. 将Markdown格式（如**粗体**、*斜体*、代码块等）转换为口语描述
+  3. 数学公式需要口语化描述，如"x的平方加y的平方等于z的平方"
+  4. 移除所有HTML标签，保留其文本内容
+  5. 避免过于书面的表达
+  6. **控制长度在4000字符以内**
+
+length_instruction_long: |
+  **重要：稿件应控制在4000字符以内。如果原内容较长，请生成精炼的摘要版本，保留最核心的观点和关键信息。**
+
+length_instruction_short: |
+  **重要：稿件应控制在4000字符以内。**
+
+generate_script_user_long: |
+  以下是一段较长的笔记内容。请生成精炼的叙述稿件摘要，控制在4000字符以内，包含最核心的观点和关键信息：
+
+  ---
+  {content}
+  ---
+
+  请生成适合口头朗读的叙述稿件（4000字符以内）。
+
+generate_script_user_short: |
+  请将以下笔记内容转换为叙述稿件（控制在4000字符以内）：
+
+  ---
+  {content}
+  ---
+
+  请生成适合口头朗读的叙述稿件。
+
+extract_key_points_system: |
+  你是一位内容分析专家。请从给定的笔记中提取3-5个关键点。
+
+  输出格式：JSON数组，每个元素是一个关键点字符串。
+  示例：["关键点1", "关键点2", "关键点3"]
+
+  只输出JSON数组，不要包含其他内容。
+
+extract_key_points_user: |
+  请从以下笔记中提取关键点：
+
+  {content}

src/agents/guide/__init__.py

@@ -0,0 +1,16 @@
+"""
+Guided Learning Module
+Generates personalized knowledge point learning plans based on user notebook content
+"""
+
+from .agents import ChatAgent, InteractiveAgent, LocateAgent, SummaryAgent
+from .guide_manager import GuidedSession, GuideManager
+
+__all__ = [
+    "ChatAgent",
+    "GuideManager",
+    "GuidedSession",
+    "InteractiveAgent",
+    "LocateAgent",
+    "SummaryAgent",
+]

src/agents/guide/agents/__init__.py

@@ -0,0 +1,11 @@
+"""
+Guided Learning Agents
+Agent modules for guided learning
+"""
+
+from .chat_agent import ChatAgent
+from .interactive_agent import InteractiveAgent
+from .locate_agent import LocateAgent
+from .summary_agent import SummaryAgent
+
+__all__ = ["ChatAgent", "InteractiveAgent", "LocateAgent", "SummaryAgent"]

src/agents/guide/agents/chat_agent.py

@@ -0,0 +1,104 @@
+#!/usr/bin/env python
+"""
+ChatAgent - Q&A Agent during learning process
+Answers user questions while learning specific knowledge points
+"""
+
+from typing import Any
+
+from src.agents.base_agent import BaseAgent
+
+
+class ChatAgent(BaseAgent):
+    """Learning Q&A agent"""
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        language: str = "zh",
+        api_version: str | None = None,
+        binding: str = "openai",
+    ):
+        super().__init__(
+            module_name="guide",
+            agent_name="chat_agent",
+            api_key=api_key,
+            base_url=base_url,
+            api_version=api_version,
+            language=language,
+            binding=binding,
+        )
+
+    def _format_chat_history(self, history: list[dict[str, str]]) -> str:
+        """Format chat history"""
+        if not history:
+            return "(No chat history)"
+
+        formatted = []
+        for msg in history[-10:]:
+            role = msg.get("role", "user")
+            content = msg.get("content", "")
+
+            if role == "user":
+                formatted.append(f"**User**: {content}")
+            elif role == "assistant":
+                formatted.append(f"**Assistant**: {content}")
+            elif role == "system":
+                formatted.append(f"_System: {content}_")
+
+        return "\n\n".join(formatted)
+
+    async def process(
+        self, knowledge: dict[str, Any], chat_history: list[dict[str, str]], user_question: str
+    ) -> dict[str, Any]:
+        """
+        Answer user questions about current knowledge point
+
+        Args:
+            knowledge: Current knowledge point information
+            chat_history: Chat history
+            user_question: User question
+
+        Returns:
+            Dictionary containing answer
+        """
+        if not user_question.strip():
+            return {"success": False, "error": "Question cannot be empty", "answer": ""}
+
+        system_prompt = self.get_prompt("system")
+        if not system_prompt:
+            raise ValueError(
+                "ChatAgent missing system prompt, please configure system in prompts/{lang}/chat_agent.yaml"
+            )
+
+        user_template = self.get_prompt("user_template")
+        if not user_template:
+            raise ValueError(
+                "ChatAgent missing user_template, please configure user_template in prompts/{lang}/chat_agent.yaml"
+            )
+
+        formatted_history = self._format_chat_history(chat_history)
+
+        user_prompt = user_template.format(
+            knowledge_title=knowledge.get("knowledge_title", ""),
+            knowledge_summary=knowledge.get("knowledge_summary", ""),
+            user_difficulty=knowledge.get("user_difficulty", ""),
+            chat_history=formatted_history,
+            user_question=user_question,
+        )
+
+        try:
+            response = await self.call_llm(
+                user_prompt=user_prompt,
+                system_prompt=system_prompt,
+            )
+
+            return {"success": True, "answer": response.strip()}
+
+        except Exception as e:
+            return {
+                "success": False,
+                "error": str(e),
+                "answer": "Sorry, an error occurred while answering the question. Please try again later.",
+            }

src/agents/guide/agents/interactive_agent.py

@@ -0,0 +1,223 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+InteractiveAgent - Agent for generating interactive HTML pages
+Converts knowledge points into visual, interactive learning pages
+"""
+
+import re
+from typing import Any
+
+from src.agents.base_agent import BaseAgent
+
+
+class InteractiveAgent(BaseAgent):
+    """Interactive page generation agent"""
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        language: str = "zh",
+        api_version: str | None = None,
+        binding: str = "openai",
+    ):
+        super().__init__(
+            module_name="guide",
+            agent_name="interactive_agent",
+            api_key=api_key,
+            base_url=base_url,
+            api_version=api_version,
+            language=language,
+        )
+
+    def _extract_html(self, response: str) -> str:
+        """Extract HTML code from LLM response"""
+        html_pattern = r"```html\s*([\s\S]*?)\s*```"
+        match = re.search(html_pattern, response)
+        if match:
+            return match.group(1).strip()
+
+        code_pattern = r"```\s*([\s\S]*?)\s*```"
+        match = re.search(code_pattern, response)
+        if match:
+            content = match.group(1).strip()
+            if content.startswith("<!DOCTYPE") or content.startswith("<html"):
+                return content
+
+        if response.strip().startswith("<!DOCTYPE") or response.strip().startswith("<html"):
+            return response.strip()
+
+        return response.strip()
+
+    def _validate_html(self, html: str) -> bool:
+        """Validate if HTML is basically valid"""
+        return (
+            "<html" in html.lower()
+            or "<!doctype" in html.lower()
+            or "<body" in html.lower()
+            or "<div" in html.lower()
+        )
+
+    def _generate_fallback_html(self, knowledge: dict[str, Any]) -> str:
+        """Generate fallback HTML page"""
+        title = knowledge.get("knowledge_title", "Knowledge Point")
+        summary = knowledge.get("knowledge_summary", "").replace("\n", "<br>")
+        difficulty = knowledge.get("user_difficulty", "").replace("\n", "<br>")
+
+        return f"""<!DOCTYPE html>
+<html lang="zh">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>{title}</title>
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.css" integrity="sha384-n8MVd4RsNIU0tAv4ct0nTaAbDJwPJzDEaqSD1odI+WdtXRGWt2kTvGFasHpSy3SV" crossorigin="anonymous">
+    <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.js" integrity="sha384-XjKyOOlGwcjNTAIQHIpgOno0Hl1YQqzUOEleOLALmuqehneUG+vnGctmUb0ZY0l8" crossorigin="anonymous"></script>
+    <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/contrib/auto-render.min.js" integrity="sha384-+VBxd3r6XgURycqtZ117n7w6ODWgRrA7TlVzRsFtwW3ZxUo8h4w20Z5J3d3xjfcw" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script>
+    <style>
+        * {{
+            margin: 0;
+            padding: 0;
+            box-sizing: border-box;
+        }}
+        body {{
+            font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+            background: linear-gradient(135deg, #F8FAFC 0%, #EFF6FF 100%);
+            min-height: 100vh;
+            padding: 2rem;
+            color: #1E293B;
+        }}
+        .container {{
+            max-width: 800px;
+            margin: 0 auto;
+        }}
+        .card {{
+            background: white;
+            border-radius: 16px;
+            padding: 2rem;
+            margin-bottom: 1.5rem;
+            box-shadow: 0 4px 6px -1px rgba(0,0,0,0.1);
+            transition: transform 0.2s, box-shadow 0.2s;
+        }}
+        .card:hover {{
+            transform: translateY(-2px);
+            box-shadow: 0 10px 25px -5px rgba(0,0,0,0.1);
+        }}
+        h1 {{
+            color: #1E40AF;
+            font-size: 1.75rem;
+            margin-bottom: 1rem;
+            display: flex;
+            align-items: center;
+            gap: 0.5rem;
+        }}
+        h2 {{
+            color: #3B82F6;
+            font-size: 1.25rem;
+            margin-bottom: 1rem;
+        }}
+        .content {{
+            line-height: 1.8;
+            color: #475569;
+        }}
+        .difficulty {{
+            background: #FEF3C7;
+            border-left: 4px solid #F59E0B;
+            padding: 1rem;
+            border-radius: 0 8px 8px 0;
+            margin-top: 1rem;
+        }}
+        .difficulty h3 {{
+            color: #B45309;
+            margin-bottom: 0.5rem;
+        }}
+    </style>
+</head>
+<body>
+    <div class="container">
+        <div class="card">
+            <h1>📚 {title}</h1>
+        </div>
+        <div class="card">
+            <h2>Knowledge Content</h2>
+            <div class="content">{summary}</div>
+        </div>
+        <div class="card">
+            <h2>💡 Notes</h2>
+            <div class="difficulty">
+                <h3>Possible Difficulties</h3>
+                <p>{difficulty}</p>
+            </div>
+        </div>
+    </div>
+</body>
+</html>"""
+
+    async def process(
+        self, knowledge: dict[str, Any], retry_with_bug: str | None = None
+    ) -> dict[str, Any]:
+        """
+        Generate interactive HTML learning page
+
+        Args:
+            knowledge: Knowledge point information (knowledge_title, knowledge_summary, user_difficulty)
+            retry_with_bug: If provided, it's a bug fix request
+
+        Returns:
+            Dictionary containing HTML code
+        """
+        system_prompt = self.get_prompt("system")
+        if not system_prompt:
+            raise ValueError(
+                "InteractiveAgent missing system prompt, please configure system in prompts/{lang}/interactive_agent.yaml"
+            )
+
+        user_template = self.get_prompt("user_template")
+        if not user_template:
+            raise ValueError(
+                "InteractiveAgent missing user_template, please configure user_template in prompts/{lang}/interactive_agent.yaml"
+            )
+
+        if retry_with_bug:
+            user_prompt = f"""The previously generated HTML page has the following issues:
+{retry_with_bug}
+
+Please fix these issues and regenerate the HTML page.
+
+Original knowledge point information:
+{user_template.format(**knowledge)}"""
+        else:
+            user_prompt = user_template.format(
+                knowledge_title=knowledge.get("knowledge_title", ""),
+                knowledge_summary=knowledge.get("knowledge_summary", ""),
+                user_difficulty=knowledge.get("user_difficulty", ""),
+            )
+
+        try:
+            response = await self.call_llm(
+                user_prompt=user_prompt,
+                system_prompt=system_prompt,
+            )
+
+            html_code = self._extract_html(response)
+
+            if not self._validate_html(html_code):
+                html_code = self._generate_fallback_html(knowledge)
+                return {
+                    "success": True,
+                    "html": html_code,
+                    "is_fallback": True,
+                    "message": "Used fallback template",
+                }
+
+            return {"success": True, "html": html_code, "is_fallback": False}
+
+        except Exception as e:
+            html_code = self._generate_fallback_html(knowledge)
+            return {
+                "success": True,
+                "html": html_code,
+                "is_fallback": True,
+                "error": str(e),
+                "message": "Error occurred, used fallback template",
+            }