Skip to content

Commit db2c5db

Browse files
docs: Complete missing enumerations in models.md [AI-assisted] (#216)
Add comprehensive documentation for UpdateStatus and RiskLevel enums, and complete AssessmentType enum with missing values (QUESTIONABLE, QUALITY_INDICATOR, HIJACKED). Provides conceptual explanations of when each enum value is used in the assessment pipeline, data synchronization, and risk categorization systems. Fixes #205 Co-authored-by: florath-ai-assistant[bot] <Andreas.Florath@telekom.de>
1 parent 4045f06 commit db2c5db

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/api-reference/models.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,14 @@ Aggregated BibTeX file assessment.
118118

119119
**BackendStatus:** FOUND, NOT_FOUND, ERROR, RATE_LIMITED, TIMEOUT
120120

121-
**AssessmentType** (`src/aletheia_probe/enums.py`): PREDATORY, LEGITIMATE, SUSPICIOUS, UNKNOWN
121+
**AssessmentType** (`src/aletheia_probe/enums.py`): Classification results from backend assessments. Core values PREDATORY, LEGITIMATE, SUSPICIOUS, UNKNOWN represent standard assessment outcomes. QUESTIONABLE indicates venues requiring closer scrutiny. QUALITY_INDICATOR represents positive quality signals. HIJACKED identifies legitimate venues compromised by predatory operators. Used by aggregation logic to determine final assessment confidence.
122122

123123
**EvidenceType** (`src/aletheia_probe/enums.py`): PREDATORY_LIST, LEGITIMATE_LIST, HEURISTIC, QUALITY_INDICATOR
124124

125+
**UpdateStatus** (`src/aletheia_probe/enums.py`): Tracks data source synchronization outcomes. SUCCESS indicates completed updates, FAILED represents synchronization errors, SKIPPED shows intentionally bypassed updates, IN_PROGRESS tracks active sync operations, CURRENT indicates data is already up-to-date, ERROR represents unexpected failures. Used by cache systems to manage backend data freshness and sync reliability.
126+
127+
**RiskLevel** (`src/aletheia_probe/enums.py`): Categorizes risk assessment severity for retraction analysis. NONE indicates no risk detected, NOTE represents informational findings, LOW/MODERATE/HIGH represent increasing risk levels, CRITICAL indicates severe risk requiring immediate attention. Used by retraction checking systems to prioritize and classify findings based on severity and impact.
128+
125129
## Working with Models
126130

127131
**Serialization:** Pydantic provides `model_dump()` (to dict), `model_dump_json()` (to JSON), `model_validate_json()` (from JSON).

0 commit comments

Comments
 (0)