Spaces:
Running on Zero
Running on Zero
File size: 16,408 Bytes
19d779e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 | """Controlled Variable-level descent through direct GCMD children."""
from __future__ import annotations
from pydantic import BaseModel, ConfigDict, Field
from gcmd_classifier.classification.candidates import (
VariableCandidate,
build_variable_candidates,
validate_variable_candidate_relationship,
)
from gcmd_classifier.classification.routers import ModelCallMetadata, TermBranchSeed
from gcmd_classifier.config import ModelSettings
from gcmd_classifier.errors import UnknownCandidateIDError
from gcmd_classifier.llm.base import (
ModelClient,
ModelRequest,
ModelStage,
RetryPolicy,
generate_with_retries,
)
from gcmd_classifier.llm.prompts import ParentContext, build_variable_prompt
from gcmd_classifier.llm.schemas import CandidateDecision, VariableResponse
from gcmd_classifier.models import (
ArticleRecord,
HierarchyLevel,
OutputError,
OutputWarning,
SupportType,
)
from gcmd_classifier.vocabulary.index import VocabularyIndex
_VARIABLE_PARENT_LEVELS = {"Term", "Variable_Level_1", "Variable_Level_2"}
_VARIABLE_LEVELS = {"Variable_Level_1", "Variable_Level_2", "Variable_Level_3"}
class EvidenceStep(BaseModel):
"""Evidence and routing metadata for one stage in a branch lineage."""
model_config = ConfigDict(extra="forbid", frozen=True)
branch_id: str = Field(min_length=1)
UUID: str = Field(min_length=1)
name: str = Field(min_length=1)
level: str = Field(min_length=1)
evidence: str = Field(min_length=1)
support_type: SupportType
confidence: float | None = Field(default=None, ge=0.0, le=1.0)
reason: str | None = None
candidate_id: str | None = None
class VariableTerminalOutcome(BaseModel):
"""Terminal outcome for one independently descended branch."""
model_config = ConfigDict(extra="forbid", frozen=True)
branch_id: str = Field(min_length=1)
parent_branch_id: str = Field(min_length=1)
topic_uuid: str = Field(min_length=1)
topic_name: str = Field(min_length=1)
term_uuid: str = Field(min_length=1)
term_name: str = Field(min_length=1)
final_uuid: str = Field(min_length=1)
final_name: str = Field(min_length=1)
final_level: HierarchyLevel
final_canonical_path: str = Field(min_length=1)
path_components: tuple[str, ...] = Field(min_length=1)
evidence: str = Field(min_length=1)
evidence_trail: tuple[EvidenceStep, ...] = Field(default_factory=tuple)
support_type: SupportType
confidence: float | None = Field(default=None, ge=0.0, le=1.0)
reason: str | None = None
stop_reason: str | None = None
candidate_id: str | None = None
prompt_version: str | None = None
model_provider: str | None = None
model_name: str | None = None
retry_count: int = Field(default=0, ge=0)
class VariableBranchError(BaseModel):
"""Explicit branch-level failure that does not cancel sibling branches."""
model_config = ConfigDict(extra="forbid", frozen=True)
branch_id: str = Field(min_length=1)
parent_branch_id: str = Field(min_length=1)
parent_uuid: str = Field(min_length=1)
parent_name: str = Field(min_length=1)
parent_level: str = Field(min_length=1)
code: str = Field(min_length=1)
message: str = Field(min_length=1)
class VariableDescentResult(BaseModel):
"""Result of controlled Variable-level descent for one Term branch."""
model_config = ConfigDict(extra="forbid", frozen=True)
terminals: tuple[VariableTerminalOutcome, ...] = Field(default_factory=tuple)
errors: tuple[VariableBranchError, ...] = Field(default_factory=tuple)
warnings: tuple[OutputWarning, ...] = Field(default_factory=tuple)
diagnostics: tuple[OutputError, ...] = Field(default_factory=tuple)
@property
def terminal_count(self) -> int:
"""Number of successful terminal branch outcomes."""
return len(self.terminals)
@property
def has_errors(self) -> bool:
"""Whether any independent branch failed during descent."""
return bool(self.errors)
def descend_variables(
*,
article: ArticleRecord,
term_branch: TermBranchSeed,
vocabulary: VocabularyIndex,
model_client: ModelClient,
settings: ModelSettings,
retry_policy: RetryPolicy | None = None,
) -> VariableDescentResult:
"""Descend from a selected Term branch through supported direct Variable children."""
term = vocabulary.get(term_branch.term_uuid)
trail = (_evidence_from_term_branch(term_branch),)
context = _BranchContext(
topic_uuid=term_branch.parent_topic_uuid,
topic_name=term_branch.parent_topic_name,
term_uuid=term_branch.term_uuid,
term_name=term_branch.term_name,
)
terminals, errors = _descend_parent(
article=article,
parent_uuid=term.UUID,
parent_branch_id=term_branch.branch_id,
branch_id=term_branch.branch_id,
candidate_id=term_branch.candidate_id,
parent_evidence=term_branch.evidence,
parent_support_type=term_branch.support_type,
parent_confidence=term_branch.confidence,
parent_reason=term_branch.reason,
trail=trail,
context=context,
vocabulary=vocabulary,
model_client=model_client,
settings=settings,
retry_policy=retry_policy or RetryPolicy.from_settings(settings),
parent_metadata=None,
)
return VariableDescentResult(terminals=terminals, errors=errors)
class _BranchContext(BaseModel):
model_config = ConfigDict(extra="forbid", frozen=True)
topic_uuid: str
topic_name: str
term_uuid: str
term_name: str
def _descend_parent(
*,
article: ArticleRecord,
parent_uuid: str,
parent_branch_id: str,
branch_id: str,
candidate_id: str | None,
parent_evidence: str,
parent_support_type: SupportType,
parent_confidence: float | None,
parent_reason: str | None,
trail: tuple[EvidenceStep, ...],
context: _BranchContext,
vocabulary: VocabularyIndex,
model_client: ModelClient,
settings: ModelSettings,
retry_policy: RetryPolicy,
parent_metadata: ModelCallMetadata | None,
) -> tuple[tuple[VariableTerminalOutcome, ...], tuple[VariableBranchError, ...]]:
parent = vocabulary.get(parent_uuid)
_validate_variable_parent(parent.level)
if parent.level == "Variable_Level_3":
return (
(
_terminal_outcome(
parent=parent,
branch_id=branch_id,
parent_branch_id=parent_branch_id,
context=context,
evidence=parent_evidence,
support_type=parent_support_type,
confidence=parent_confidence,
reason=parent_reason,
stop_reason="Selected Variable_Level_3 is a leaf node.",
candidate_id=candidate_id,
trail=trail,
metadata=parent_metadata,
),
),
(),
)
candidates = build_variable_candidates(vocabulary, parent_uuid=parent_uuid)
if not candidates:
return (
(
_terminal_outcome(
parent=parent,
branch_id=branch_id,
parent_branch_id=parent_branch_id,
context=context,
evidence=parent_evidence,
support_type=parent_support_type,
confidence=parent_confidence,
reason=parent_reason,
stop_reason="No direct Variable children are available.",
candidate_id=candidate_id,
trail=trail,
metadata=parent_metadata,
),
),
(),
)
candidates_by_id = {candidate.candidate_id: candidate for candidate in candidates}
response = _call_variable_model(
article=article,
parent=parent,
candidates=candidates,
vocabulary=vocabulary,
model_client=model_client,
settings=settings,
retry_policy=retry_policy,
)
_validate_selected_candidate_ids(response.parsed.selected, candidates_by_id)
metadata = _model_metadata(response)
if response.parsed.stop_at_parent:
return (
(
_terminal_outcome(
parent=parent,
branch_id=branch_id,
parent_branch_id=parent_branch_id,
context=context,
evidence=parent_evidence,
support_type=parent_support_type,
confidence=parent_confidence,
reason=parent_reason,
stop_reason=response.parsed.stop_reason,
candidate_id=candidate_id,
trail=trail,
metadata=metadata,
),
),
(),
)
terminals: list[VariableTerminalOutcome] = []
errors: list[VariableBranchError] = []
for decision in response.parsed.selected:
candidate = candidates_by_id[decision.candidate_id]
child = vocabulary.get(candidate.variable_uuid)
child_branch_id = f"{branch_id}/variable:{candidate.candidate_id}"
try:
validate_variable_candidate_relationship(
candidate,
selected_parent_uuid=parent_uuid,
index=vocabulary,
)
child_trail = (
*trail,
_evidence_from_child(
child=child,
branch_id=child_branch_id,
decision=decision,
),
)
child_terminals, child_errors = _descend_parent(
article=article,
parent_uuid=child.UUID,
parent_branch_id=branch_id,
branch_id=child_branch_id,
candidate_id=decision.candidate_id,
parent_evidence=decision.evidence,
parent_support_type=decision.support_type,
parent_confidence=decision.confidence,
parent_reason=decision.reason,
trail=child_trail,
context=context,
vocabulary=vocabulary,
model_client=model_client,
settings=settings,
retry_policy=retry_policy,
parent_metadata=metadata,
)
terminals.extend(child_terminals)
errors.extend(child_errors)
except Exception as exc:
errors.append(
_branch_error(
branch_id=child_branch_id,
parent_branch_id=branch_id,
parent=child,
exc=exc,
)
)
return tuple(terminals), tuple(errors)
def _call_variable_model(
*,
article: ArticleRecord,
parent,
candidates: tuple[VariableCandidate, ...],
vocabulary: VocabularyIndex,
model_client: ModelClient,
settings: ModelSettings,
retry_policy: RetryPolicy,
):
parent_context = ParentContext(
candidate_id=parent.UUID,
name=parent.name,
level=parent.level,
canonical_path=parent.canonical_path,
)
prompt = build_variable_prompt(
article=article,
parent=parent_context,
candidates=tuple(candidate.prompt_candidate for candidate in candidates),
prompt_version=settings.prompt_version_variable,
)
request = ModelRequest.from_settings(
stage=ModelStage.VARIABLE,
prompt=prompt,
response_schema=VariableResponse,
settings=settings,
metadata={
"DOI": article.DOI,
"parent_uuid": parent.UUID,
"parent_level": parent.level,
"candidate_ids": tuple(candidate.candidate_id for candidate in candidates),
"candidate_uuids": tuple(candidate.variable_uuid for candidate in candidates),
"vocabulary_version": vocabulary.vocabulary_version,
},
)
return generate_with_retries(model_client, request, retry_policy)
def _validate_selected_candidate_ids(
selected: list[CandidateDecision],
candidates_by_id: dict[str, VariableCandidate],
) -> None:
seen: set[str] = set()
for decision in selected:
if decision.candidate_id not in candidates_by_id:
raise UnknownCandidateIDError(
f"Variable model selected unknown candidate_id {decision.candidate_id!r}."
)
if decision.candidate_id in seen:
raise UnknownCandidateIDError(
f"Variable model selected duplicate candidate_id {decision.candidate_id!r}."
)
seen.add(decision.candidate_id)
def _terminal_outcome(
*,
parent,
branch_id: str,
parent_branch_id: str,
context: _BranchContext,
evidence: str,
support_type: SupportType,
confidence: float | None,
reason: str | None,
stop_reason: str | None,
candidate_id: str | None,
trail: tuple[EvidenceStep, ...],
metadata: ModelCallMetadata | None,
) -> VariableTerminalOutcome:
return VariableTerminalOutcome(
branch_id=branch_id,
parent_branch_id=parent_branch_id,
topic_uuid=context.topic_uuid,
topic_name=context.topic_name,
term_uuid=context.term_uuid,
term_name=context.term_name,
final_uuid=parent.UUID,
final_name=parent.name,
final_level=parent.level,
final_canonical_path=parent.canonical_path,
path_components=parent.path_components,
evidence=evidence,
evidence_trail=trail,
support_type=support_type,
confidence=confidence,
reason=reason,
stop_reason=stop_reason,
candidate_id=candidate_id,
prompt_version=None if metadata is None else metadata.prompt_version,
model_provider=None if metadata is None else metadata.provider,
model_name=None if metadata is None else metadata.model_name,
retry_count=0 if metadata is None else metadata.retry_count,
)
def _evidence_from_term_branch(term_branch: TermBranchSeed) -> EvidenceStep:
return EvidenceStep(
branch_id=term_branch.branch_id,
UUID=term_branch.term_uuid,
name=term_branch.term_name,
level=term_branch.term_level,
evidence=term_branch.evidence,
support_type=term_branch.support_type,
confidence=term_branch.confidence,
reason=term_branch.reason,
candidate_id=term_branch.candidate_id,
)
def _evidence_from_child(*, child, branch_id: str, decision: CandidateDecision) -> EvidenceStep:
return EvidenceStep(
branch_id=branch_id,
UUID=child.UUID,
name=child.name,
level=child.level,
evidence=decision.evidence,
support_type=decision.support_type,
confidence=decision.confidence,
reason=decision.reason,
candidate_id=decision.candidate_id,
)
def _branch_error(
*,
branch_id: str,
parent_branch_id: str,
parent,
exc: Exception,
) -> VariableBranchError:
return VariableBranchError(
branch_id=branch_id,
parent_branch_id=parent_branch_id,
parent_uuid=parent.UUID,
parent_name=parent.name,
parent_level=parent.level,
code=exc.__class__.__name__,
message=str(exc),
)
def _validate_variable_parent(level: str) -> None:
if level not in _VARIABLE_PARENT_LEVELS and level not in _VARIABLE_LEVELS:
raise ValueError(f"Unsupported Variable descent parent level: {level!r}.")
def _model_metadata(response) -> ModelCallMetadata:
token_usage = response.token_usage
return ModelCallMetadata(
provider=response.provider,
model_name=response.model_name,
prompt_version=response.prompt_version,
retry_count=response.retry_count,
duration_seconds=response.duration_seconds,
input_tokens=None if token_usage is None else token_usage.input_tokens,
output_tokens=None if token_usage is None else token_usage.output_tokens,
total_tokens=None if token_usage is None else token_usage.total_tokens,
estimated_cost=response.estimated_cost,
)
|