业务文档起草口径草稿:只产出定义与逐字引用,不产出取数

文档里写的是业务说法,不是库里的表和 SQL。模型回复里出现 SQL、表名、列名的一律丢弃;
每条定义必须能在原文里按归一化空白逐字定位,定位不到就不进草稿。草稿在 path_pending
状态下不是合法图,因此不写进 workflows.graph。
This commit is contained in:
ThearchyHelios
2026-11-03 22:42:28 +08:00
parent 753c35918d
commit 4f0aa62dcc
2 changed files with 796 additions and 0 deletions
+568
View File
@@ -0,0 +1,568 @@
"""业务文档 → 口径草稿:只产出定义,不产出取数(docs/design/next-round/02-口径账本.md 做法 8 的文档一侧)。
**为什么草稿只到定义为止。** 文档里写的是业务说法(名称、同义词、粒度、时间字段、过滤、分子分母、维度),不是库里的
表、列和 SQL。取数必须来自一次真实运行:运行里执行过什么、结果对不对,只有运行本身能证明。所以这个模块的产出固定为
定义卡需要的那几项,模型回复里一旦出现 SQL / 表名 / 列名字段,整条指标丢弃,不带着它往下走。
**为什么草稿不写成图。** path_pending 的草稿还没有取数路径,不是合法图(validate_graph 会挡),写进 workflows.graph
只会让工作流列表和画布读到一个跑不了的版本。草稿先独立存在,等取数路径有了、人审过了再进版本。这个模块因此不碰
数据库:纯逻辑 + 一次模型调用,调用方拿到结果自己决定存哪里。
**为什么引用要逐字核对。** 「文档里说过」是这份草稿唯一的事实来源。模型转述得再像,也要能在原文里按归一化空白
(换行、制表、全角空格)定位到那一句;定位不到就不算引用。span 是原文下标,界面据此高亮,也是之后复核的依据。
**为什么错误只说给人看。** dropped 里的 reason 直接进界面,写清楚哪一条为什么不算;机器要判别的只有 STATUSES。
"""
from __future__ import annotations
import copy
import json
import re
from collections.abc import Iterable, Mapping
from typing import Any
#: 草稿的状态。path_pending 不是合法图,attached 之后取数路径才来自一次真实运行。
STATUSES = ("drafting", "questions_open", "path_pending", "attached", "rejected")
#: 一次发给模型的总字数上限(按 chunk 边界截断,见 extract)
MAX_INPUT_CHARS = 40000
#: 引用归一化之后少于这么多字,说明它指不出一句完整的话,丢掉
MIN_QUOTE_CHARS = 8
#: 指标对象里固定出现的字段(提示词和归一化都按这一份)
METRIC_FIELDS = ("name", "synonyms", "unit", "grain", "time_field", "filters", "numerator", "denominator",
"dimensions", "definition", "open_questions")
#: definition 里固定出现的字段
DEFINITION_FIELDS = ("text", "scope", "exclusions", "owner", "effective_from", "citations")
#: 这些字段本身就是在描述取数;草稿里出现一律删掉(含嵌套)
FORBIDDEN_FIELDS = ("table", "column", "sql", "tables")
#: 「select … from …」和模板占位符都是取数的痕迹,不是业务定义
_SQL_TRACE = re.compile(r"\bselect\b[\s\S]{0,4000}?\bfrom\b", re.IGNORECASE)
_TEMPLATE_TRACE = "{{"
#: 空白归一化:换行、制表、全角空格都算空白
_SPACE = re.compile(r"\s+")
_TRAILING_COMMA = re.compile(r",\s*([}\]])")
_FENCE = re.compile(r"```[A-Za-z0-9_-]*\s*")
_SYSTEM = """你是业务口径整理助手。你只读给定的业务文档,把其中的指标整理成「口径草稿」。
硬性约束:
1. 只输出一个 JSON 对象,不要写解释、不要写 Markdown 代码块之外的话。
2. 每条断言都必须带 citations:引用必须逐字抄原文,chunk 写材料里方括号内的 id。核对不上、或原文里没有依据的,
不要写进指标,写进 open_questions。
3. 绝不输出 SQL、表名、列名、库名,也不要猜它们。你写的是业务定义,不是取数。
4. 拿不准的不要猜,写进 open_questions,用一句问得清的话。
5. 不要编造文档里没有的数字、单位、生效日期。
输出格式:
{
"metrics": [
{
"name": "指标名称",
"synonyms": ["同义词"],
"unit": "单位(文档没写就留空)",
"grain": "粒度(如 日 / 月 / 订单行)",
"time_field": "业务时间字段的业务叫法",
"filters": ["过滤条件的业务描述"],
"numerator": "分子的业务描述",
"denominator": "分母的业务描述",
"dimensions": ["可拆分的业务维度"],
"definition": {
"text": "口径说明",
"scope": "适用范围",
"exclusions": ["不包含的情况"],
"owner": "文档写明的负责人或部门",
"effective_from": "生效日期(文档原文写法)",
"citations": [{"chunk": "c1", "quote": "逐字原文"}]
},
"open_questions": ["还没说清、需要业务确认的问题"]
}
],
"open_questions": ["跨指标的未决问题"]
}
"""
class DraftUnavailable(Exception):
"""没有可用的起草模型(没有接入、只有演示模型、或模型不可用)。message 给人看。"""
def _collapse(text: str) -> str:
return _SPACE.sub(" ", text).strip()
def _normalized(text: str) -> tuple[str, list[int]]:
"""归一化空白,并记下每个归一化字符来自原文的哪个下标。
连续空白合成一个空格,映射到这段空白的第一个字符;开头结尾的空白不参与定位(引用本来就不该以空白开头)。
结尾的映射不靠「空格 + 1」算,返回的 span 用最后一个非空白字符的下标 + 1,跨行时才不会把换行算丢。
"""
out: list[str] = []
index: list[int] = []
for i, ch in enumerate(text):
if ch.isspace():
if not out or out[-1] == " ":
continue
out.append(" ")
index.append(i)
else:
out.append(ch)
index.append(i)
while out and out[-1] == " ":
out.pop()
index.pop()
return "".join(out), index
def verify_quote(text: str, quote: str) -> tuple[int, int] | None:
"""把引用定位回原文,返回原文的 [start, end);找不到返回 None。
两侧都先归一化空白再逐字比:换行、制表、全角空格、连续空格都不该让一句原文对不上。
"""
if not isinstance(text, str) or not isinstance(quote, str):
return None
normalized_text, index = _normalized(text)
normalized_quote, _ = _normalized(quote)
if not normalized_quote:
return None
at = normalized_text.find(normalized_quote)
if at < 0:
return None
return index[at], index[at + len(normalized_quote) - 1] + 1
def _salvage_metrics(text: str) -> list[dict]:
"""从被截断的回复里捞出已经完整的指标对象(数组里逐个平衡的 {...})。
截断常常发生在最后一条指标中间:前面那些完整的仍然能核对引用,不必整份回复作废。
"""
at = text.find('"metrics"')
if at < 0:
return []
start = text.find("[", at + len('"metrics"'))
if start < 0:
return []
out: list[dict] = []
depth = 0
begin: int | None = None
in_string = False
escaped = False
for i in range(start + 1, len(text)):
ch = text[i]
if in_string:
if escaped:
escaped = False
elif ch == "\\":
escaped = True
elif ch == '"':
in_string = False
continue
if ch == '"':
in_string = True
elif ch == "{":
if depth == 0:
begin = i
depth += 1
elif ch == "}":
depth -= 1
if depth == 0 and begin is not None:
try:
item = json.loads(text[begin:i + 1])
except (json.JSONDecodeError, RecursionError):
item = None
if isinstance(item, dict):
out.append(item)
begin = None
elif depth < 0:
break
return out
def _raw_metrics(raw: Any) -> list[Any]:
"""raw 可能是 dict、指标列表,或带围栏 / 前后废话 / 截断的 JSON 文本。"""
if isinstance(raw, Mapping):
metrics = raw.get("metrics")
return metrics if isinstance(metrics, list) else []
if isinstance(raw, list):
return raw
if not isinstance(raw, str):
return []
try:
data = parse_reply(raw)
except ValueError:
salvaged = _salvage_metrics(raw)
if not salvaged:
raise
return salvaged
metrics = data.get("metrics")
return metrics if isinstance(metrics, list) else []
def _strip_forbidden(value: Any) -> Any:
"""递归删掉取数字段。文档里可能出现「按 table 分」这种话,但它不是指标定义的一部分。"""
if isinstance(value, dict):
return {k: _strip_forbidden(v) for k, v in value.items() if k not in FORBIDDEN_FIELDS}
if isinstance(value, list):
return [_strip_forbidden(v) for v in value]
return value
def _citation_list(metric: dict) -> list[Any]:
top = metric.get("citations")
if isinstance(top, list):
return top
definition = metric.get("definition")
if isinstance(definition, Mapping) and isinstance(definition.get("citations"), list):
return definition["citations"]
return []
def _check_citation(citation: Any, chunks: Mapping[str, dict]) -> dict | None:
"""一条引用:chunk 存在、quote 至少 8 字、能在原文里逐字定位,才补上 document_id 和 span。"""
if not isinstance(citation, Mapping):
return None
chunk_id = citation.get("chunk") or citation.get("chunk_id") or citation.get("chunkId")
quote = citation.get("quote")
if not isinstance(chunk_id, str) or chunk_id not in chunks or not isinstance(quote, str):
return None
if len(_collapse(quote)) < MIN_QUOTE_CHARS:
return None
chunk = chunks[chunk_id] if isinstance(chunks[chunk_id], Mapping) else {}
span = verify_quote(str(chunk.get("content") or ""), quote)
if span is None:
return None
out = dict(citation)
out.pop("chunk_id", None)
out.pop("chunkId", None)
out["chunk"] = chunk_id
out["document_id"] = str(chunk.get("document_id") or "")
out["span"] = [span[0], span[1]]
return out
def _has_sql_trace(metric: Any) -> bool:
try:
body = json.dumps(metric, ensure_ascii=False, default=str)
except (TypeError, ValueError):
body = str(metric)
return bool(_SQL_TRACE.search(body)) or _TEMPLATE_TRACE in body
def normalize_metrics(raw: Any, chunks: dict[str, dict]) -> tuple[list[dict], list[dict]]:
"""校验模型交回的指标。返回 (合格指标, 丢弃原因)。
丢弃原因的形状是 {"name": …, "reason": …}:name 是能认出是哪一条的名字,认不出就按序号说。
引用是逐条丢的(chunk 不存在、太短、对不上原文),一条都不剩时整条指标丢弃——没有出处的定义不进草稿。
"""
items = _raw_metrics(raw)
good: list[dict] = []
dropped: list[dict] = []
for position, item in enumerate(items, start=1):
fallback = f"第 {position} 条"
if not isinstance(item, Mapping):
dropped.append({"name": fallback, "reason": "不是一个对象"})
continue
name = item.get("name")
if not isinstance(name, str) or not name.strip():
dropped.append({"name": fallback, "reason": "缺少指标名称"})
continue
name = name.strip()
# 先看取数痕迹再删字段:SQL 就写在 sql 字段里的,删掉字段就看不出来了
if _has_sql_trace(item):
dropped.append({"name": name, "reason": "含有 SQL、表名或模板占位符的痕迹:草稿只产出定义,不产出取数"})
continue
cleaned = _strip_forbidden(dict(item))
cleaned["name"] = name
citations = [kept for kept in (_check_citation(c, chunks) for c in _citation_list(item)) if kept]
if not citations:
dropped.append({"name": name, "reason": "没有一条引用能在原文里逐字核对上(或引用不足 8 字)"})
continue
cleaned["citations"] = citations
definition = cleaned.get("definition")
if not isinstance(definition, dict):
definition = {}
definition = dict(definition)
definition["citations"] = copy.deepcopy(citations)
cleaned["definition"] = definition
synonyms = cleaned.get("synonyms")
cleaned["synonyms"] = [s.strip() for s in synonyms if isinstance(s, str) and s.strip()] \
if isinstance(synonyms, list) else []
questions = cleaned.get("open_questions")
cleaned["open_questions"] = [q for q in questions if isinstance(q, str) and q.strip()] \
if isinstance(questions, list) else []
good.append(cleaned)
return good, dropped
def parse_reply(text: str) -> dict:
"""从模型回复里取出 JSON 对象:容忍围栏、前后废话、尾随逗号;取不出来抛 ValueError。
截断的回复这里一律当失败:只捞得回一半的 JSON 不是可核对的结果,由 normalize_metrics 决定要不要按指标对象抢救。
"""
if not isinstance(text, str):
raise ValueError("模型回复不是文字")
body = text.strip()
if body.startswith("```"):
body = _FENCE.sub("", body, count=1)
if body.rstrip().endswith("```"):
body = body.rstrip()[:-3].rstrip()
start, end = body.find("{"), body.rfind("}")
if start < 0 or end <= start:
raise ValueError("回复里没有 JSON 对象")
body = body[start:end + 1]
try:
data = json.loads(body)
except (json.JSONDecodeError, RecursionError):
# 只在第一次失败后试尾随逗号,免得把引用里的 ",}" 也改掉
try:
data = json.loads(_TRAILING_COMMA.sub(r"\1", body))
except (json.JSONDecodeError, RecursionError):
raise ValueError("回复里的 JSON 不完整或格式不对") from None
if not isinstance(data, dict):
raise ValueError("回复里的 JSON 不是对象")
return data
def _order(chunks: Mapping[str, dict]) -> list[str]:
def key(chunk_id: str) -> tuple[int, str]:
chunk = chunks[chunk_id] if isinstance(chunks[chunk_id], Mapping) else {}
ordinal = chunk.get("ordinal")
return (ordinal if isinstance(ordinal, int) else 0, chunk_id)
return sorted(chunks, key=key)
def _doc_line(doc: Any) -> str:
if not isinstance(doc, Mapping):
return str(doc)
doc_id = doc.get("document_id") or doc.get("id") or ""
title = doc.get("title") or doc.get("filename") or doc.get("name") or doc_id
return f"- {doc_id}:{title}"
def _chunk_block(chunk_id: str, chunk: Any) -> str:
chunk = chunk if isinstance(chunk, Mapping) else {}
ordinal = chunk.get("ordinal")
where = f" · 第 {ordinal} 段" if isinstance(ordinal, int) else ""
document = chunk.get("document_id") or ""
return f"[{chunk_id}](文档 {document}{where})\n{chunk.get('content') or ''}"
def _human(docs: list[dict], chunks: Mapping[str, dict], guidance: str, datasource: dict | None) -> str:
parts = ["文档清单:", *(_doc_line(doc) for doc in docs), "", "逐段原文(引用时 chunk 写方括号里的 id,quote 逐字抄):"]
parts.extend(_chunk_block(chunk_id, chunks[chunk_id]) for chunk_id in _order(chunks))
parts.append("")
if datasource:
bits = [str(datasource.get(key)) for key in ("name", "type", "dialect", "description")
if datasource.get(key)]
parts.append("数据源:{}(只用来写清楚适用范围,不要据此猜表名或列名)".format(" · ".join(bits)))
parts.append("用户补充要求:{}".format(guidance.strip() if guidance and guidance.strip() else "(无)"))
return "\n".join(parts)
def prompt(docs: list[dict], chunks: dict[str, dict], guidance: str = "",
datasource: dict | None = None) -> list[Any]:
"""构造 system + human。材料只放文档与逐段原文;数据源只给名字和类型,不给表结构。"""
from langchain_core.messages import HumanMessage, SystemMessage
return [SystemMessage(content=_SYSTEM), HumanMessage(content=_human(docs, chunks, guidance, datasource))]
def _chars(messages: Iterable[Any]) -> int:
return sum(len(str(getattr(message, "content", "") or "")) for message in messages)
def _fit(docs: list[dict], chunks: dict[str, dict], guidance: str,
datasource: dict | None) -> tuple[dict[str, dict], bool]:
"""按 chunk 边界把输入压到 MAX_INPUT_CHARS 以内;只剩一段还超就截这一段的内容。
从后往前丢(ordinal 大的先丢),保留文档开头的事实;被丢掉的段落不会出现在提示里,模型也就不会引用它。
"""
kept = dict(chunks)
order = _order(kept)
truncated = False
while _chars(prompt(docs, kept, guidance, datasource)) > MAX_INPUT_CHARS and len(order) > 1:
kept.pop(order.pop())
truncated = True
if _chars(prompt(docs, kept, guidance, datasource)) > MAX_INPUT_CHARS and order:
chunk_id = order[0]
chunk = dict(kept[chunk_id]) if isinstance(kept[chunk_id], Mapping) else {}
content = str(chunk.get("content") or "")
excess = _chars(prompt(docs, kept, guidance, datasource)) - MAX_INPUT_CHARS
chunk["content"] = content[:max(0, len(content) - excess)]
kept[chunk_id] = chunk
truncated = True
return kept, truncated
async def extract(session: Any, *, docs: list[dict], chunks: dict[str, dict], guidance: str = "",
datasource: dict | None = None, model: Any = None) -> dict:
"""一次模型调用,返回 {"metrics", "dropped", "open_questions", "truncated", "model_id"}。
不落库。model 可注入(测试用假对象:有 async ainvoke(messages),回复有 .content);不给就按设置解析,
模型不可用时抛 DraftUnavailable,reason 原样给人看。输入超限按 chunk 截断,truncated 交调用方在界面上说清楚。
"""
from app.engine.state import message_text
if model is None:
from app.data.recipe_ai import resolve_draft_model
model, model_id, availability = await resolve_draft_model(session)
if model is None or not getattr(availability, "available", False):
raise DraftUnavailable(getattr(availability, "reason", "") or "AI 起草不可用")
else:
named = getattr(model, "model_name", None) or getattr(model, "model", None)
model_id = named if isinstance(named, str) else ""
kept, truncated = _fit(docs, chunks, guidance, datasource)
reply = await model.ainvoke(prompt(docs, kept, guidance, datasource))
text = message_text(reply)
try:
data = parse_reply(text)
except ValueError:
# 截断的回复:能捞回几条完整的指标就交几条,其余交给调用方说明
data = {"metrics": _salvage_metrics(text)}
if not data["metrics"]:
raise
metrics, dropped = normalize_metrics(data, kept)
questions = data.get("open_questions")
return {
"metrics": metrics,
"dropped": dropped,
"open_questions": questions if isinstance(questions, list) else [],
"truncated": truncated,
"model_id": model_id,
}
def _key(value: Any) -> str:
"""同名判定:去掉所有空白(含全角空格)再小写。"""
return re.sub(r"\s+", "", value).casefold() if isinstance(value, str) else ""
def _words(metric: Mapping[str, Any]) -> list[str]:
out: list[str] = []
name = metric.get("name")
if isinstance(name, str) and name.strip():
out.append(name)
synonyms = metric.get("synonyms")
if isinstance(synonyms, list):
out.extend(s for s in synonyms if isinstance(s, str) and s.strip())
keys: list[str] = []
for word in out:
key = _key(word)
if key and key not in keys:
keys.append(key)
return keys
def _unit(value: Any) -> str:
return _key(value)
def _definition_text(metric: Mapping[str, Any]) -> str:
definition = metric.get("definition")
text = definition.get("text") if isinstance(definition, Mapping) else None
if not isinstance(text, str):
# 现有口径那一侧交上来的是 definition_text(见模块说明的入参形状)
text = metric.get("definition_text")
return _collapse(text) if isinstance(text, str) else ""
def _reason(draft: Mapping[str, Any], existing: Mapping[str, Any]) -> str:
parts: list[str] = []
if _unit(draft.get("unit")) != _unit(existing.get("unit")):
parts.append("单位不同(草稿「{}」,现有「{}」)".format(draft.get("unit") or "未写", existing.get("unit") or "未写"))
if _definition_text(draft) != _definition_text(existing):
parts.append("定义说明不同")
return ";".join(parts) or "定义不一致"
def alignment(metrics: list[dict], existing: list[dict]) -> dict:
"""草稿和现有口径对齐:new / duplicate / conflict。
同名按 name 与 synonyms 去空白、转小写后相等算;一个草稿指标可能撞上多条现有指标,只要有一条完全相同就算
duplicate(说明这一条已经有出处),否则按第一条不同的写 conflict 和原因。
"""
index: dict[str, list[dict]] = {}
for entry in existing:
if not isinstance(entry, Mapping):
continue
for key in _words(entry):
index.setdefault(key, []).append(dict(entry))
result: dict[str, list[Any]] = {"new": [], "duplicate": [], "conflict": []}
for metric in metrics:
if not isinstance(metric, Mapping):
continue
name = metric.get("name")
if not isinstance(name, str) or not name.strip():
continue
name = name.strip()
matched: list[dict] = []
seen: set[int] = set()
for key in _words(metric):
for entry in index.get(key, ()):
if id(entry) not in seen:
seen.add(id(entry))
matched.append(entry)
if not matched:
result["new"].append(name)
continue
same = [e for e in matched
if _unit(e.get("unit")) == _unit(metric.get("unit"))
and _definition_text(e) == _definition_text(metric)]
if same:
entry = same[0]
result["duplicate"].append({"name": name, "workflow_id": entry.get("workflow_id"),
"version": entry.get("version"), "node_id": entry.get("node_id")})
else:
entry = matched[0]
result["conflict"].append({"name": name, "workflow_id": entry.get("workflow_id"),
"version": entry.get("version"), "reason": _reason(metric, entry)})
return result
def _find_card(card_metrics: list[dict], draft: Mapping[str, Any]) -> dict | None:
keys = set(_words(draft))
for card in card_metrics:
if isinstance(card, dict) and keys.intersection(_words(card)):
return card
return None
def merge_definition(card_metrics: list[dict], draft_metrics: list[dict]) -> tuple[list[dict], list[str]]:
"""把草稿的 definition 并进同名 / 同义词的口径卡指标;不改 expression / id。
只并 definition:草稿不知道取数,改写式子或 id 会破坏已有口径的算法。匹配不上的进 warnings,由人决定新建还是忽略。
"""
merged = copy.deepcopy(list(card_metrics))
warnings: list[str] = []
for draft in draft_metrics:
if not isinstance(draft, Mapping):
continue
name = draft.get("name")
name = name.strip() if isinstance(name, str) and name.strip() else ""
target = _find_card(merged, draft)
if target is None:
warnings.append(f"草稿指标「{name or '(未命名)'}」在口径卡上找不到同名或同义词指标,定义未合并")
continue
definition = draft.get("definition")
if not isinstance(definition, Mapping) or not definition:
warnings.append(f"草稿指标「{name}」没有可合并的定义说明")
continue
base = target.get("definition")
base = dict(base) if isinstance(base, Mapping) else {}
for key, value in definition.items():
if value is not None:
base[key] = copy.deepcopy(value)
target["definition"] = base
return merged, warnings
__all__ = [
"DEFINITION_FIELDS", "DraftUnavailable", "FORBIDDEN_FIELDS", "MAX_INPUT_CHARS", "METRIC_FIELDS",
"MIN_QUOTE_CHARS", "STATUSES", "alignment", "extract", "merge_definition", "normalize_metrics",
"parse_reply", "prompt", "verify_quote",
]
+228
View File
@@ -0,0 +1,228 @@
"""口径草稿的纯逻辑(app/ledger/docdraft.py)。
- 引用定位:跨行、连续空格、全角空格都能还原到原文下标,找不到就是 None;
- 指标归一化:缺名、没有可核对的引用、带 SQL 痕迹整条丢弃;引用太短、chunk 不存在逐条丢弃;顺手删掉取数字段;
- 回复解析:围栏、前后废话、尾随逗号都认,截断的抛 ValueError;
- 对齐:new / duplicate / conflict(单位或定义不同);
- 合并定义:同名或同义词命中,不动 expression / id,匹配不上进 warnings;
- extract:注入假模型(不调真模型),输入超限按 chunk 边界截断。
"""
from __future__ import annotations
from types import SimpleNamespace
from app.ledger import docdraft
CHUNK = ("本季度销售额按订单创建时间统计,退款订单不计入销售额。"
"订单数按已支付订单统计,一个订单算一单。")
CHUNKS = {"c1": {"ordinal": 0, "content": CHUNK, "document_id": "doc-1"}}
def metric(name="销售额", quote="销售额按订单创建时间统计", **extra):
item = {
"name": name,
"synonyms": ["营业额"],
"unit": "元",
"definition": {"text": "按订单创建时间统计", "citations": [{"chunk": "c1", "quote": quote}]},
}
item.update(extra)
return item
# ==========================================================================
# verify_quote
# ==========================================================================
def test_verify_quote_restores_original_span_across_lines_and_spaces():
text = "口径说明:\n销售额\u3000按订单创建时间统计,\n\n退款不计入。\n"
span = docdraft.verify_quote(text, "销售额 按订单创建时间统计, 退款")
assert span is not None
start, end = span
assert text[start:end] == "销售额\u3000按订单创建时间统计,\n\n退款"
def test_verify_quote_ignores_extra_spaces():
text = "订单 数"
assert docdraft.verify_quote(text, "订单 数") == (0, 6)
assert docdraft.verify_quote(text, " 订单\t数 ") == (0, 6)
def test_verify_quote_handles_full_width_space_and_missing_quote():
text = "销售额\u3000合计"
assert docdraft.verify_quote(text, "销售额 合计") == (0, 6)
assert docdraft.verify_quote(text, "毛利率") is None
assert docdraft.verify_quote(text, " ") is None
# ==========================================================================
# normalize_metrics
# ==========================================================================
def test_normalize_metrics_keeps_a_verified_metric_and_hands_over_span():
good, dropped = docdraft.normalize_metrics({"metrics": [metric()]}, CHUNKS)
assert dropped == []
[item] = good
[citation] = item["citations"]
assert citation["document_id"] == "doc-1"
assert citation["chunk"] == "c1"
assert CHUNK[citation["span"][0]:citation["span"][1]] == "销售额按订单创建时间统计"
assert item["definition"]["citations"] == item["citations"]
def test_normalize_metrics_drops_a_metric_without_a_name():
good, dropped = docdraft.normalize_metrics({"metrics": [metric(name=" ")]}, CHUNKS)
assert good == []
assert dropped[0]["reason"] == "缺少指标名称"
def test_normalize_metrics_drops_short_quotes_and_unknown_chunks_per_citation():
item = metric(quote="销售额")
item["definition"]["citations"].append({"chunk": "missing", "quote": "退款订单不计入销售额"})
good, dropped = docdraft.normalize_metrics({"metrics": [item]}, CHUNKS)
# 两条引用都不可用:一条太短,一条 chunk 不存在
assert good == []
assert "引用" in dropped[0]["reason"]
# 一条可用、一条不可用:只丢不可用的那条
item = metric()
item["definition"]["citations"] += [{"chunk": "missing", "quote": "退款订单不计入销售额"}]
good, dropped = docdraft.normalize_metrics({"metrics": [item]}, CHUNKS)
assert dropped == []
assert len(good[0]["citations"]) == 1
def test_normalize_metrics_drops_sql_traces_and_strips_forbidden_fields():
traced = metric(notes="select sum(amount) from orders")
good, dropped = docdraft.normalize_metrics({"metrics": [traced]}, CHUNKS)
assert good == []
assert "SQL" in dropped[0]["reason"]
templated = metric(notes="{{ input.period }}")
good, dropped = docdraft.normalize_metrics({"metrics": [templated]}, CHUNKS)
assert good == []
assert "SQL" in dropped[0]["reason"]
clean = metric(table="orders", column="amount", sql="", filter={"tables": ["orders"]})
# sql 是空串,没有 select … from,按字段删除处理而不是整条丢弃
good, dropped = docdraft.normalize_metrics({"metrics": [clean]}, CHUNKS)
assert dropped == []
assert set(good[0]) & set(docdraft.FORBIDDEN_FIELDS) == set()
assert good[0]["filter"] == {}
# ==========================================================================
# parse_reply
# ==========================================================================
def test_parse_reply_accepts_fences_chatter_and_trailing_commas():
text = '好的,结果如下:\n```json\n{"metrics": [{"name": "销售额",},],}\n```\n以上。'
assert docdraft.parse_reply(text) == {"metrics": [{"name": "销售额"}]}
def test_parse_reply_rejects_a_truncated_object():
try:
docdraft.parse_reply('{"metrics": [{"name": "销售额"')
except ValueError as e:
assert "不完整" in str(e) or "没有" in str(e)
else: # pragma: no cover - 只有实现走样时才会到这里
raise AssertionError("截断的 JSON 应当抛 ValueError")
# ==========================================================================
# alignment
# ==========================================================================
EXISTING = [
{"workflow_id": "wf-1", "version": 3, "node_id": "card", "name": "销售额",
"synonyms": ["GMV"], "unit": "元", "definition_text": "按订单创建时间统计"},
{"workflow_id": "wf-2", "version": 1, "node_id": "card", "name": "订单数",
"synonyms": [], "unit": "单", "definition_text": "按已支付订单统计"},
]
def test_alignment_reports_new_duplicate_and_conflict():
draft = [
{"name": "成交额", "synonyms": ["gmv "], "unit": "元", "definition": {"text": "按订单创建时间统计"}},
{"name": "订单数 ", "unit": "万元", "definition": {"text": "按已支付订单统计"}},
{"name": "客单价", "unit": "元", "definition": {"text": "销售额除以订单数"}},
]
result = docdraft.alignment(draft, EXISTING)
assert result["new"] == ["客单价"]
assert result["duplicate"] == [{"name": "成交额", "workflow_id": "wf-1", "version": 3, "node_id": "card"}]
[conflict] = result["conflict"]
assert conflict["name"] == "订单数"
assert conflict["workflow_id"] == "wf-2"
assert "单位不同" in conflict["reason"]
def test_alignment_conflicts_when_only_the_definition_differs():
draft = [{"name": "销售额", "unit": "元", "definition": {"text": "按发货时间统计"}}]
[conflict] = docdraft.alignment(draft, EXISTING)["conflict"]
assert conflict["reason"] == "定义说明不同"
# ==========================================================================
# merge_definition
# ==========================================================================
def test_merge_definition_matches_by_synonym_and_keeps_expression():
cards = [{"id": "gmv", "name": "销售额", "synonyms": ["GMV"], "expression": "cell(nodes.q, 0, '金额')",
"definition": {"text": "旧说明", "owner": "财务"}}]
drafts = [
{"name": "成交额", "synonyms": ["gmv"], "definition": {"text": "新说明", "scope": "全渠道"}},
{"name": "客单价", "definition": {"text": "销售额除以订单数"}},
]
merged, warnings = docdraft.merge_definition(cards, drafts)
[card] = merged
assert card["id"] == "gmv"
assert card["expression"] == "cell(nodes.q, 0, '金额')"
assert card["definition"] == {"text": "新说明", "owner": "财务", "scope": "全渠道"}
assert len(warnings) == 1 and "客单价" in warnings[0]
# ==========================================================================
# extract
# ==========================================================================
class FakeModel:
model_name = "fake-model"
def __init__(self, text: str) -> None:
self.text = text
self.messages: list = []
async def ainvoke(self, messages):
self.messages = messages
return SimpleNamespace(content=self.text)
async def test_extract_uses_the_injected_model_and_normalizes_its_reply():
reply = """```json
{"metrics": [{"name": "销售额", "unit": "元",
"definition": {"text": "按订单创建时间统计",
"citations": [{"chunk": "c1", "quote": "销售额按订单创建时间统计"}]}}],
"open_questions": ["退款订单是否算销售额?"]}
```"""
model = FakeModel(reply)
result = await docdraft.extract(None, docs=[{"document_id": "doc-1", "title": "口径说明"}],
chunks=CHUNKS, model=model)
assert result["model_id"] == "fake-model"
assert result["truncated"] is False
assert result["open_questions"] == ["退款订单是否算销售额?"]
[item] = result["metrics"]
assert item["citations"][0]["document_id"] == "doc-1"
async def test_extract_truncates_at_chunk_boundaries_and_flags_it():
first = "第一段:" + "销售额按订单创建时间统计。" * 2000
second = "第二段:" + "退款订单不计入销售额。" * 2000
chunks = {
"c1": {"ordinal": 0, "content": first, "document_id": "doc-1"},
"c2": {"ordinal": 1, "content": second, "document_id": "doc-1"},
}
model = FakeModel('{"metrics": [], "open_questions": []}')
result = await docdraft.extract(None, docs=[], chunks=chunks, model=model)
assert result["truncated"] is True
sent = "\n".join(str(getattr(m, "content", "")) for m in model.messages)
assert "第二段" not in sent
assert len(sent) <= docdraft.MAX_INPUT_CHARS