feat(ai-writing): 研究模板独立实体 + 配置页 + 内置范例 + 点击直接进入写作(0616 #5)

后端:
- 新持久化包 research_templates(表 ai_writing_research_templates,create_all 建表,注册 models/__init__),deps 接 research_template_store
- 路由 /api/ai-writing/research-templates CRUD(在 ai_writing.py)
- 内置范例 网摘/周报/要讯(DEFAULT_RESEARCH_TEMPLATES + seed_defaults,表空时由 list 接口幂等播种)
- tests/test_research_templates.py(9 passed)

前端:
- api/ai-writing-research-templates.ts + hooks/useResearchTemplates.ts
- 配置页 ResearchTemplatesConfigPage(/page/canvas/research-templates)CRUD
- ResearchSidebar 研究模板改用研究模板实体;点击回填整张表单并直接 startWriting 进入写作;顶部齿轮进配置页

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
fengxiangdebaoziandClaude Opus 4.8 committed 2026-06-16 17:59:05 +08:00
1 parent 0e4caa5a66
commit ba5aeefe98
12 files changed
+1141 -44

No files matched your search

@@ -168,6 +168,10 @@ async def langgraph_runtime(app: FastAPI) -> AsyncGenerator[None, None]:
app.state.article_type_store = make_article_type_store(sf)
from deerflow.persistence.research_templates import make_research_template_store
app.state.research_template_store = make_research_template_store(sf)
from deerflow.persistence.memory_config import make_user_memory_config_store
app.state.memory_config_store = make_user_memory_config_store(sf)
@@ -423,6 +427,11 @@ def get_article_type_store(request: Request):
return getattr(request.app.state, "article_type_store", None)
def get_research_template_store(request: Request):
"""Return the research template store, or None when not configured."""
return getattr(request.app.state, "research_template_store", None)
def get_memory_config_store(request: Request):
"""Return the per-user memory config store."""
val = getattr(request.app.state, "memory_config_store", None)
@@ -90,6 +90,48 @@ class ArticleTypeResponse(BaseModel):
updated_at: str
class ResearchTemplateRequest(BaseModel):
name: str
description: Optional[str] = None
article_type_key: Optional[str] = None
outline: Optional[str] = None
material_source: str = "general"
word_count: int = 800
audience: Optional[str] = None
strict_mode: bool = False
topic: Optional[str] = None
sort_order: int = 0
class UpdateResearchTemplateRequest(BaseModel):
name: Optional[str] = None
description: Optional[str] = None
article_type_key: Optional[str] = None
outline: Optional[str] = None
material_source: Optional[str] = None
word_count: Optional[int] = None
audience: Optional[str] = None
strict_mode: Optional[bool] = None
topic: Optional[str] = None
sort_order: Optional[int] = None
class ResearchTemplateResponse(BaseModel):
id: str
name: str
description: Optional[str] = None
article_type_key: Optional[str] = None
outline: Optional[str] = None
material_source: str
word_count: int
audience: Optional[str] = None
strict_mode: bool
topic: Optional[str] = None
sort_order: int
created_at: str
updated_at: str
class SessionResponse(BaseModel):
id: str
user_id: Optional[str] = None
@@ -268,6 +310,94 @@ async def delete_article_type(article_type_id: str, request: Request):
return {"success": True}
# ── 研究模板(课题研究左栏一键预填表单,需求 0616 #5)────────────────────────────
@router.get("/research-templates", response_model=list[ResearchTemplateResponse])
async def list_research_templates(request: Request):
"""列出所有研究模板,按 sort_order 升序。
新机器/空表时自动写入内置范例模板(网摘/周报/要讯),幂等仅在表为空时执行。
"""
from app.gateway.deps import get_research_template_store
store = get_research_template_store(request)
if store is None:
return []
try:
await store.seed_defaults()
except Exception:
logger.exception("ai_writing: failed to seed default research templates")
return await store.list()
@router.post("/research-templates", response_model=ResearchTemplateResponse, status_code=201)
async def create_research_template(body: ResearchTemplateRequest, request: Request):
"""新增研究模板。"""
from app.gateway.deps import get_research_template_store
store = get_research_template_store(request)
if store is None:
raise HTTPException(status_code=503, detail="Research template store not available")
return await store.create(
name=body.name,
description=body.description,
article_type_key=body.article_type_key,
outline=body.outline,
material_source=body.material_source,
word_count=body.word_count,
audience=body.audience,
strict_mode=body.strict_mode,
topic=body.topic,
sort_order=body.sort_order,
)
@router.patch("/research-templates/{template_id}", response_model=ResearchTemplateResponse)
async def update_research_template(template_id: str, body: UpdateResearchTemplateRequest, request: Request):
"""更新研究模板字段(只传需要修改的字段)。"""
from app.gateway.deps import get_research_template_store
store = get_research_template_store(request)
if store is None:
raise HTTPException(status_code=503, detail="Research template store not available")
kwargs = {}
for field in (
"name",
"description",
"article_type_key",
"outline",
"material_source",
"word_count",
"audience",
"strict_mode",
"topic",
"sort_order",
):
val = getattr(body, field)
if val is not None:
kwargs[field] = val
updated = await store.update(template_id, **kwargs)
if updated is None:
raise HTTPException(status_code=404, detail="Research template not found")
return updated
@router.delete("/research-templates/{template_id}")
async def delete_research_template(template_id: str, request: Request):
"""删除研究模板。"""
from app.gateway.deps import get_research_template_store
store = get_research_template_store(request)
if store is None:
raise HTTPException(status_code=503, detail="Research template store not available")
deleted = await store.delete(template_id)
if not deleted:
raise HTTPException(status_code=404, detail="Research template not found")
return {"success": True}
# ── 管理接口 ──────────────────────────────────────────────────────────────────
@@ -42,6 +42,7 @@ from deerflow.persistence.models.run_event import RunEventRow
from deerflow.persistence.notifications.model import NotificationRow
from deerflow.persistence.parallel_agent_tasks.model import ParallelAgentTaskRow
from deerflow.persistence.recommended_questions.model import RecommendedQuestionRow
from deerflow.persistence.research_templates.model import ResearchTemplateRow
from deerflow.persistence.roundtable_chains.model import RoundtableChainRow
from deerflow.persistence.roundtable_draft_shares.model import RoundtableDraftShareRow
from deerflow.persistence.roundtable_drafts.model import (
@@ -89,6 +90,7 @@ __all__ = [
"NotificationRow",
"ParallelAgentTaskRow",
"RecommendedQuestionRow",
"ResearchTemplateRow",
"RoundtableChainRow",
"RoundtableDraftRow",
"RoundtableDraftShareRow",
@@ -0,0 +1,15 @@
from deerflow.persistence.research_templates.model import ResearchTemplateRow
from deerflow.persistence.research_templates.sql import ResearchTemplateRepository
def make_research_template_store(session_factory) -> ResearchTemplateRepository | None:
if session_factory is None:
return None
return ResearchTemplateRepository(session_factory)
__all__ = [
"ResearchTemplateRow",
"ResearchTemplateRepository",
"make_research_template_store",
]
@@ -0,0 +1,35 @@
"""ORM model for AI writing research templates (课题研究模板).
A research template bundles a set of writing-form presets — article type,
outline, material source, word count, audience, strict mode and a topic/intent —
so a user can one-click pre-fill the whole 课题研究 form. Maintained from the
research-template config page (需求 0616 #5).
"""
from __future__ import annotations
from datetime import UTC, datetime
from sqlalchemy import Boolean, DateTime, Integer, String, Text
from sqlalchemy.orm import Mapped, mapped_column
from deerflow.persistence.base import Base
class ResearchTemplateRow(Base):
__tablename__ = "ai_writing_research_templates"
id: Mapped[str] = mapped_column(String(64), primary_key=True)
name: Mapped[str] = mapped_column(String(128), nullable=False)
description: Mapped[str | None] = mapped_column(Text, nullable=True)
# 预设字段(点击模板时回填表单)。
article_type_key: Mapped[str | None] = mapped_column(String(64), nullable=True)
outline: Mapped[str | None] = mapped_column(Text, nullable=True)
material_source: Mapped[str] = mapped_column(String(32), nullable=False, default="general")
word_count: Mapped[int] = mapped_column(Integer, nullable=False, default=800)
audience: Mapped[str | None] = mapped_column(String(128), nullable=True)
strict_mode: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
topic: Mapped[str | None] = mapped_column(Text, nullable=True)
sort_order: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=lambda: datetime.now(UTC))
updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=lambda: datetime.now(UTC))
@@ -0,0 +1,221 @@
"""SQLAlchemy-backed research template storage."""
from __future__ import annotations
import uuid
from datetime import UTC, datetime
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker
from deerflow.persistence.research_templates.model import ResearchTemplateRow
_UNSET = object()
# 新机器内置范例模板(表为空时由 seed_defaults() 写入;作为给用户的范例,内容务求规范好用)。
# article_type_key 取自默认文章类型(news/analysis/feature/report,见 20260517_02 迁移)。
DEFAULT_RESEARCH_TEMPLATES: list[dict] = [
{
"name": "网摘",
"description": "汇编近期网络热点信息,分条摘录核心要点并标注来源,快速掌握全貌",
"article_type_key": "news",
"material_source": "general",
"word_count": 1000,
"audience": "关注热点动态的一般读者",
"strict_mode": False,
"topic": (
"围绕【主题】检索并汇编近一周网络上的重要信息与热点动态,"
"逐条摘录核心事实、关键数据与原文出处,帮助读者快速掌握全貌。"
),
"outline": (
"一、热点速览(用一句话清单列出本期要点)\n"
"二、重点摘录\n"
" 1.【事件/话题标题】——核心事实、关键数据、信息来源\n"
" 2.【事件/话题标题】——……\n"
" 3.(按重要性依次罗列)\n"
"三、关联动态与背景补充(串联相关信息、补足来龙去脉)\n"
"四、小结与观察(提炼趋势或值得关注的看点)"
),
"sort_order": 0,
},
{
"name": "周报",
"description": "按周梳理工作进展、数据指标与问题风险,输出结构化周度汇报",
"article_type_key": "report",
"material_source": "general",
"word_count": 1200,
"audience": "团队成员与上级主管",
"strict_mode": True,
"topic": (
"汇总本周【项目/团队】的工作进展,撰写周报:"
"覆盖关键成果、数据指标、问题风险与下周计划,简明、客观、可量化。"
),
"outline": (
"一、本周概览(一句话总结 + 关键指标对比上周)\n"
"二、重点进展\n"
" 1. 已完成事项与成果(结论先行,附支撑数据)\n"
" 2. 关键数据 / 里程碑达成情况\n"
"三、问题与风险(逐条列出问题、影响面及应对措施)\n"
"四、下周计划与资源需求(目标、负责人、所需支持)"
),
"sort_order": 1,
},
{
"name": "要讯",
"description": "提炼最重要的资讯,精炼成简报式要点,突出核心事实与潜在影响",
"article_type_key": "analysis",
"material_source": "general",
"word_count": 600,
"audience": "需快速掌握要点的决策者",
"strict_mode": True,
"topic": (
"围绕【主题/领域】提炼近期最重要的资讯,编写要讯:"
"每条聚焦核心事实、关键背景与潜在影响,文字精炼、判断审慎。"
),
"outline": (
"一、头条要讯(1–3 条,每条用一句话点明核心)\n"
"二、要点详述(逐条展开)\n"
" · 事实:发生了什么、何时何地、涉及谁\n"
" · 背景:为何重要、与既有态势的关系\n"
" · 影响:可能带来的后果与连锁反应\n"
"三、研判与建议(给出倾向性判断与可行动建议)"
),
"sort_order": 2,
},
]
class ResearchTemplateRepository:
def __init__(self, session_factory: async_sessionmaker[AsyncSession]) -> None:
self._sf = session_factory
@staticmethod
def _row_to_dict(row: ResearchTemplateRow) -> dict:
d = row.to_dict()
for k in ("created_at", "updated_at"):
if isinstance(d.get(k), datetime):
d[k] = d[k].isoformat()
return d
async def create(
self,
*,
name: str,
description: str | None = None,
article_type_key: str | None = None,
outline: str | None = None,
material_source: str = "general",
word_count: int = 800,
audience: str | None = None,
strict_mode: bool = False,
topic: str | None = None,
sort_order: int = 0,
) -> dict:
now = datetime.now(UTC)
row = ResearchTemplateRow(
id=str(uuid.uuid4()),
name=name,
description=description,
article_type_key=article_type_key,
outline=outline,
material_source=material_source,
word_count=word_count,
audience=audience,
strict_mode=strict_mode,
topic=topic,
sort_order=sort_order,
created_at=now,
updated_at=now,
)
async with self._sf() as session:
session.add(row)
await session.commit()
await session.refresh(row)
return self._row_to_dict(row)
async def update(
self,
template_id: str,
*,
name=_UNSET,
description=_UNSET,
article_type_key=_UNSET,
outline=_UNSET,
material_source=_UNSET,
word_count=_UNSET,
audience=_UNSET,
strict_mode=_UNSET,
topic=_UNSET,
sort_order=_UNSET,
) -> dict | None:
async with self._sf() as session:
row = await session.get(ResearchTemplateRow, template_id)
if row is None:
return None
if name is not _UNSET:
row.name = name
if description is not _UNSET:
row.description = description
if article_type_key is not _UNSET:
row.article_type_key = article_type_key
if outline is not _UNSET:
row.outline = outline
if material_source is not _UNSET:
row.material_source = material_source
if word_count is not _UNSET:
row.word_count = word_count
if audience is not _UNSET:
row.audience = audience
if strict_mode is not _UNSET:
row.strict_mode = strict_mode
if topic is not _UNSET:
row.topic = topic
if sort_order is not _UNSET:
row.sort_order = sort_order
row.updated_at = datetime.now(UTC)
await session.commit()
await session.refresh(row)
return self._row_to_dict(row)
async def get(self, template_id: str) -> dict | None:
async with self._sf() as session:
row = await session.get(ResearchTemplateRow, template_id)
if row is None:
return None
return self._row_to_dict(row)
async def list(self) -> list[dict]:
stmt = select(ResearchTemplateRow).order_by(
ResearchTemplateRow.sort_order.asc(), ResearchTemplateRow.created_at.asc()
)
async with self._sf() as session:
result = await session.execute(stmt)
return [self._row_to_dict(r) for r in result.scalars()]
async def delete(self, template_id: str) -> bool:
async with self._sf() as session:
row = await session.get(ResearchTemplateRow, template_id)
if row is None:
return False
await session.delete(row)
await session.commit()
return True
async def seed_defaults(self) -> int:
"""新机器/空表时写入内置范例模板(网摘/周报/要讯)。
幂等:仅当表为空时插入;已有任何模板则跳过(避免覆盖用户配置或重复播种)。
返回插入条数。
"""
async with self._sf() as session:
existing = await session.execute(select(ResearchTemplateRow.id).limit(1))
if existing.first() is not None:
return 0
now = datetime.now(UTC)
for t in DEFAULT_RESEARCH_TEMPLATES:
session.add(
ResearchTemplateRow(id=str(uuid.uuid4()), created_at=now, updated_at=now, **t)
)
await session.commit()
return len(DEFAULT_RESEARCH_TEMPLATES)
@@ -0,0 +1,124 @@
"""Tests for the research-template store (课题研究模板,需求 0616 #5).
A research template bundles writing-form presets (article type / outline /
material source / word count / audience / strict mode / topic) for one-click
pre-fill. Covers create (with defaults) / list ordering / get / partial update /
delete.
"""
from __future__ import annotations
import pytest
import pytest_asyncio
from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine
from deerflow.persistence.base import Base
from deerflow.persistence.research_templates import ResearchTemplateRepository
@pytest_asyncio.fixture
async def store(tmp_path):
engine = create_async_engine(f"sqlite+aiosqlite:///{tmp_path / 'rt.db'}")
async with engine.begin() as conn:
import deerflow.persistence.research_templates.model # noqa: F401
await conn.run_sync(Base.metadata.create_all)
sf = async_sessionmaker(engine, expire_on_commit=False)
return ResearchTemplateRepository(sf)
@pytest.mark.asyncio
async def test_create_applies_defaults(store: ResearchTemplateRepository):
row = await store.create(name="深度分析模板")
assert row["name"] == "深度分析模板"
assert row["material_source"] == "general"
assert row["word_count"] == 800
assert row["strict_mode"] is False
assert row["article_type_key"] is None
assert row["id"]
@pytest.mark.asyncio
async def test_create_full_then_get_roundtrips(store: ResearchTemplateRepository):
created = await store.create(
name="舆情研究",
description="围绕舆情的研究模板",
article_type_key="analysis",
outline="一、背景\n二、分析\n三、结论",
material_source="notebook",
word_count=1500,
audience="决策者",
strict_mode=True,
topic="某品牌近期舆情",
sort_order=2,
)
fetched = await store.get(created["id"])
assert fetched is not None
assert fetched["article_type_key"] == "analysis"
assert fetched["outline"].startswith("一、背景")
assert fetched["material_source"] == "notebook"
assert fetched["word_count"] == 1500
assert fetched["audience"] == "决策者"
assert fetched["strict_mode"] is True
assert fetched["topic"] == "某品牌近期舆情"
@pytest.mark.asyncio
async def test_list_orders_by_sort_order(store: ResearchTemplateRepository):
await store.create(name="B", sort_order=2)
await store.create(name="A", sort_order=1)
rows = await store.list()
assert [r["name"] for r in rows] == ["A", "B"]
@pytest.mark.asyncio
async def test_update_partial_keeps_other_fields(store: ResearchTemplateRepository):
created = await store.create(name="模板", word_count=800, strict_mode=False)
updated = await store.update(created["id"], word_count=2000, strict_mode=True)
assert updated is not None
assert updated["word_count"] == 2000
assert updated["strict_mode"] is True
assert updated["name"] == "模板" # untouched
@pytest.mark.asyncio
async def test_update_missing_returns_none(store: ResearchTemplateRepository):
assert await store.update("nope", name="x") is None
@pytest.mark.asyncio
async def test_delete(store: ResearchTemplateRepository):
created = await store.create(name="待删")
assert await store.delete(created["id"]) is True
assert await store.get(created["id"]) is None
assert await store.delete(created["id"]) is False
@pytest.mark.asyncio
async def test_seed_defaults_inserts_builtins_when_empty(store: ResearchTemplateRepository):
inserted = await store.seed_defaults()
assert inserted == 3
rows = await store.list()
names = [r["name"] for r in rows]
assert names == ["网摘", "周报", "要讯"] # sort_order 0/1/2
# 内置模板内容完整(范例质量)。
by_name = {r["name"]: r for r in rows}
assert by_name["网摘"]["article_type_key"] == "news"
assert by_name["周报"]["strict_mode"] is True
assert by_name["要讯"]["outline"]
assert all(r["topic"] for r in rows)
@pytest.mark.asyncio
async def test_seed_defaults_is_idempotent(store: ResearchTemplateRepository):
assert await store.seed_defaults() == 3
# 已有模板 → 再次播种跳过,不重复、不覆盖。
assert await store.seed_defaults() == 0
assert len(await store.list()) == 3
@pytest.mark.asyncio
async def test_seed_defaults_skips_when_user_has_templates(store: ResearchTemplateRepository):
await store.create(name="用户自建")
assert await store.seed_defaults() == 0
assert [r["name"] for r in await store.list()] == ["用户自建"]