You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Complete models.md with missing field descriptions [AI-assisted] (#214)
Add comprehensive documentation for previously undocumented model fields:
- QueryInput: acronym_expanded_from, extracted_acronym_mappings
- AssessmentResult: acronym_expanded_from, acronym_expansion_used
- BackendResult: execution_time_ms, evidence_type
- BibtexEntry: is_retracted, retraction_info
- BibtexAssessmentResult: retracted_articles_count, articles_checked_for_retraction
Documentation now explains the conceptual purpose and usage context for each
field, addressing the incomplete API reference that was misleading developers.
Closes#204
Co-authored-by: florath-ai-assistant[bot] <Andreas.Florath@telekom.de>
Copy file name to clipboardExpand all lines: docs/api-reference/models.md
+51-11Lines changed: 51 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,27 +12,50 @@ All models are defined in `src/aletheia_probe/models.py` using Pydantic for vali
12
12
13
13
Normalized query input passed to backends.
14
14
15
-
**Concept:** Contains normalized journal information extracted from user input, including identifiers (ISSN, DOI), alternative names, and venue type detection.
15
+
**Concept:** Contains normalized journal information extracted from user input, including identifiers (ISSN, DOI), alternative names, venue type detection, and acronym expansion tracking.
-`normalized_name` - Processed journal/conference name
20
+
-`identifiers` - Dictionary of ISSN, DOI, etc.
21
+
-`aliases` - Alternative names discovered
22
+
-`venue_type` - Detected venue classification
23
+
-`acronym_expanded_from` - Original acronym if expansion was applied (e.g., "ICSE" → "International Conference on Software Engineering"). Populated when acronym expansion feature resolves conference abbreviations.
24
+
-`extracted_acronym_mappings` - Dictionary of acronym-to-full-name mappings discovered during normalization. Tracks what expansions were found and applied.
18
25
19
26
## Result Models
20
27
21
28
### BackendResult
22
29
23
30
Individual backend query result.
24
31
25
-
**Concept:** Contains assessment from a single backend, including status (FOUND/NOT_FOUND/ERROR/TIMEOUT/RATE_LIMITED), confidence score (0.0-1.0, validated), assessment type, response timing, and cache indicator.
32
+
**Concept:** Contains assessment from a single backend, including status, confidence score, assessment type, response timing, evidence classification, and execution metrics.
-`cached` - Whether result was retrieved from cache
41
+
-`execution_time_ms` - Backend execution time in milliseconds. Measures actual backend processing time separate from network/cache overhead.
42
+
-`evidence_type` - Type of evidence used: "predatory_list", "legitimate_list", or "heuristic". Indicates the source and nature of the assessment evidence.
28
43
29
44
### AssessmentResult
30
45
31
46
Final aggregated assessment.
32
47
33
-
**Concept:** Combines all backend results with weighted scoring, reasoning, and metadata.
48
+
**Concept:** Combines all backend results with weighted scoring, reasoning, metadata, and acronym expansion tracking.
-`backend_results` - List of individual backend results
54
+
-`reasoning` - Human-readable explanations
55
+
-`metadata` - Journal metadata if available
56
+
-`processing_time` - Total assessment duration
57
+
-`acronym_expanded_from` - Original acronym if assessment used acronym expansion (e.g., "ICSE" → full conference name). Tracks when expansion influenced results.
58
+
-`acronym_expansion_used` - Boolean indicating whether acronym expansion was applied. Distinguishes direct name queries from acronym-based queries.
36
59
37
60
## Metadata Models
38
61
@@ -60,17 +83,34 @@ Backend configuration.
60
83
61
84
Single BibTeX entry representation.
62
85
63
-
**Concept:** Extracted venue information from BibTeX entries with retraction status tracking.
86
+
**Concept:** Extracted venue information from BibTeX entries with comprehensive metadata and retraction status tracking.
-`issn` - International Standard Serial Number if available
95
+
-`is_retracted` - Boolean indicating whether the article has been retracted. Determined by checking retraction databases for articles with DOIs.
96
+
-`retraction_info` - Dictionary containing retraction details when `is_retracted` is true. Includes retraction reason, date, and source information.
66
97
67
98
### BibtexAssessmentResult
68
99
69
100
Aggregated BibTeX file assessment.
70
101
71
-
**Concept:** Statistics and results from assessing all venues in a BibTeX file, broken down by venue type and assessment category.
72
-
73
-
**Fields:** Entry counts, assessment counts (predatory/legitimate/suspicious), venue type breakdowns, retraction counts, processing time
102
+
**Concept:** Comprehensive statistics and results from assessing all venues in a BibTeX file, with detailed breakdowns by venue type, assessment category, and retraction analysis.
103
+
104
+
**Key Fields:**
105
+
-`total_entries` - Total number of entries processed
106
+
-`entries_with_journals` - Number of entries with identifiable venues
107
+
-`assessment_results` - List of (entry, assessment) pairs for detailed results
-`conference_entries` / `journal_entries` - Venue type breakdowns with specific counters
110
+
-`venue_type_counts` - Dictionary mapping venue types to counts
111
+
-`retracted_articles_count` - Number of retracted articles discovered. Populated by checking articles with DOIs against retraction databases.
112
+
-`articles_checked_for_retraction` - Number of articles that were checked for retraction status. Indicates how many articles had DOIs available for retraction checking.
113
+
-`processing_time` - Total assessment duration in seconds
0 commit comments