GodsDevProject commited on
Commit
113424c
·
verified ·
1 Parent(s): c61fa39

Create reports/explainability.py

Browse files
Files changed (1) hide show
  1. reports/explainability.py +53 -11
reports/explainability.py CHANGED
@@ -1,14 +1,56 @@
1
- def explainability_report(results):
2
- agencies = {r["agency"] for r in results}
3
- return f"""
4
- ### Explainability Report
 
5
 
6
- **Purpose:** Public FOIA discovery
7
- **Agencies:** {', '.join(agencies)}
 
 
8
 
9
- Safeguards:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  - Robots.txt enforcement
11
- - Kill switches
12
- - Redaction detection
13
- - FOIA exemption surfacing
14
- """
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ """
2
+ Explainability Report
3
+ Federal FOIA Intelligence Search
4
+ Public Electronic Reading Rooms Only
5
+ """
6
 
7
+ EXPLAINABILITY_SUMMARY = """
8
+ Federal FOIA Intelligence Search is a public-interest discovery system
9
+ that indexes only documents already released by U.S. Government agencies
10
+ in FOIA Electronic Reading Rooms.
11
 
12
+ The platform does not bypass access controls, does not scrape restricted
13
+ systems, and does not declassify information.
14
+ """
15
+
16
+
17
+ DATA_SOURCES_EXPLANATION = """
18
+ All indexed materials originate from agency-operated FOIA Electronic
19
+ Reading Rooms. Each result includes explicit source attribution.
20
+
21
+ No content is modified, inferred, or enhanced beyond the released record.
22
+ """
23
+
24
+
25
+ SAFETY_CONTROLS = """
26
+ Safety mechanisms include:
27
  - Robots.txt enforcement
28
+ - Per-agency automated kill switches
29
+ - Health and latency monitoring
30
+ - Redaction-aware previews
31
+ - Clear labeling of stub vs live sources
32
+ """
33
+
34
+
35
+ INTENDED_USE = """
36
+ This system is intended for:
37
+ - Journalists
38
+ - Academic researchers
39
+ - Legal professionals
40
+ - Members of the public conducting FOIA research
41
+
42
+ It is not intended for operational intelligence use or surveillance.
43
+ """
44
+
45
+
46
+ def generate_explainability_report() -> str:
47
+ """
48
+ Return a consolidated explainability narrative suitable for
49
+ regulators, reviewers, or Trust & Safety teams.
50
+ """
51
+ return "\n\n".join([
52
+ EXPLAINABILITY_SUMMARY,
53
+ DATA_SOURCES_EXPLANATION,
54
+ SAFETY_CONTROLS,
55
+ INTENDED_USE,
56
+ ])