GodsDevProject commited on
Commit
8a105bc
Β·
verified Β·
1 Parent(s): c905ea6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +124 -35
README.md CHANGED
@@ -1,62 +1,151 @@
 
 
 
 
 
 
 
 
 
 
1
  # πŸ›οΈ Federal FOIA Intelligence Search
2
  ### Public Electronic Reading Rooms Only
3
 
4
- This Hugging Face Space provides **live search access to U.S. Government FOIA documents**
5
- released through official public Electronic Reading Rooms.
 
6
 
7
  ---
8
 
9
- ## βœ… What This App Does
10
- - Searches **public FOIA portals** (e.g. FBI Vault, CIA Reading Room)
11
- - Clearly labels **Live vs Stub** results
12
- - Allows export **only** for lawfully retrievable documents
13
- - Requires explicit consent for extended (blocked) agencies
 
 
 
14
 
15
  ---
16
 
17
- ## πŸ”’ Stub Results (Transparency Only)
 
 
 
 
 
 
 
 
 
 
 
18
 
19
- Some agencies do **not** permit automated access or do not provide public FOIA search endpoints.
20
 
21
- These are represented as **stub adapters**:
22
- - NSA
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  - NGA
24
- - (Others may be added similarly)
25
 
26
- Stub results:
27
- - ❌ Do not perform network requests
28
- - ❌ Do not retrieve documents
29
- - ❌ Cannot be exported
30
 
31
- > ℹ️ Stub results are informational and cannot be exported.
 
 
32
 
33
  ---
34
 
35
- ## πŸ“€ Export Rules
36
- Only results from **live public FOIA sources** are exportable.
 
 
 
 
 
37
 
38
  ---
39
 
40
- ## 🧠 Ethics & Compliance
41
- - No classified systems accessed
42
- - No bypassing robots.txt
43
- - No scraping restricted endpoints
44
- - No personal data collected
45
- - Public FOIA releases only
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
46
 
47
  ---
48
 
49
- ## βœ… FINAL HF REVIEWER RESPONSE
50
 
51
- > This Space performs automated searches only against U.S. Government FOIA Electronic Reading Rooms that explicitly permit public access.
52
- >
53
- > Agencies that block automated access or lack public search endpoints are represented with clearly labeled stub results for transparency only.
54
- >
55
- > Stub adapters do not perform network requests and cannot export content.
56
- >
57
- > This application indexes only documents lawfully released to the public under FOIA.
58
 
59
  ---
60
 
61
- ## πŸ“œ Intended Use
62
- Research, journalism, transparency, and educational use only.
 
1
+ ---
2
+ license: mit
3
+ title: 'FOIA DECLASSIFIED DOCUMENTS SEARCH '
4
+ sdk: gradio
5
+ colorFrom: purple
6
+ colorTo: gray
7
+ pinned: true
8
+ short_description: 'FOIA DECLASSIFIED DOCUMENTS SEARCH '
9
+ ---
10
+
11
  # πŸ›οΈ Federal FOIA Intelligence Search
12
  ### Public Electronic Reading Rooms Only
13
 
14
+ A **live federated search application** for discovering documents published in **public U.S. Government FOIA Electronic Reading Rooms**.
15
+
16
+ This application **does not scrape**, **does not bypass access controls**, and **does not access classified, restricted, or non-public systems**.
17
 
18
  ---
19
 
20
+ ## πŸ” What This App Does
21
+
22
+ - Searches **publicly available FOIA libraries**
23
+ - Aggregates results across multiple agencies
24
+ - Clearly distinguishes:
25
+ - 🟒 **Live public sources**
26
+ - πŸ”’ **Stub / informational coverage**
27
+ - Provides transparency tooling for journalists, researchers, and the public
28
 
29
  ---
30
 
31
+ ## πŸ›‘οΈ Compliance & Safety Guarantees
32
+
33
+ - βœ… Public Electronic Reading Rooms only
34
+ - βœ… Honors robots.txt per adapter
35
+ - βœ… No authentication, credentials, or scraping
36
+ - βœ… No training, inference, or ML on restricted data
37
+ - βœ… Stub results **cannot be exported**
38
+ - βœ… All exported documents link to public URLs
39
+
40
+ > **Stub results are informational and cannot be exported.**
41
+
42
+ ---
43
 
44
+ ## 🧠 Search Modes
45
 
46
+ ### Standard Mode (Default)
47
+ - Live public FOIA reading rooms
48
+ - Safe for export
49
+ - No experimental features
50
+
51
+ ### Extended Coverage Mode (Opt-In)
52
+ Some agencies publish material inconsistently or restrict automation.
53
+
54
+ Extended mode:
55
+ - Requires user acknowledgment
56
+ - Clearly labels blocked or stubbed agencies
57
+ - Never exports restricted results
58
+
59
+ Agencies currently marked as **blocked or partial**:
60
+ - DIA
61
  - NGA
 
62
 
63
+ ---
64
+
65
+ ## 🧾 Export Rules
 
66
 
67
+ - ZIP export is enabled **only when live results are present**
68
+ - Stub results are excluded automatically
69
+ - All exports are traceable to public URLs
70
 
71
  ---
72
 
73
+ ## πŸ“Š Built-In Transparency Tools
74
+
75
+ - πŸ“Š **Agency coverage heatmap**
76
+ - ⏱️ **Per-agency latency & health badges**
77
+ - πŸ•’ **Release timeline (by publication date)**
78
+ - 🌐 **Agency discovery status**
79
+ - 🧾 **Court-ready citation formatting (public documents only)**
80
 
81
  ---
82
 
83
+ ## βš–οΈ Phase-3 Expansion Pack (Planned)
84
+
85
+ These features are **architectural extensions** and are **not active by default**.
86
+
87
+ ### 🧾 Court Tools
88
+ - Litigation appendix generator (PDF)
89
+ - Exhibit numbering (A-1, A-2…)
90
+ - Declaration-ready citation blocks
91
+ - FOIA exemption (b-code) frequency charts
92
+
93
+ ### πŸ“° Journalism Tools
94
+ - Timeline narrative builder
95
+ - Source confidence tags
96
+ - β€œWhat’s missing” agency gap analysis
97
+ - Redaction density metrics
98
+
99
+ ### βš–οΈ Compliance Controls
100
+ - Export locked to live results only
101
+ - Every document traceable to public URL
102
+ - Stub data never enters PDFs
103
+ - Optional disclosure watermarking
104
+
105
+ ### 🧠 Advanced (Opt-In)
106
+ - Semantic clustering by topic (post-retrieval only)
107
+ - Cross-agency entity graphs
108
+ - FOIA response-time benchmarking
109
+
110
+ > No Phase-3 feature enables access to non-public data.
111
+
112
+ ---
113
+
114
+ ## πŸ“œ Why This Does Not Violate Intelligence Restrictions
115
+
116
+ - The app queries **only public-facing FOIA libraries**
117
+ - No inference is performed on classified material
118
+ - No automation targets restricted systems
119
+ - All content is already published by the agencies themselves
120
+ - The app functions as a **search index**, not a data broker
121
+
122
+ ---
123
+
124
+ ## πŸ§ͺ Testing & Reliability
125
+
126
+ - Adapter compliance tests ensure:
127
+ - Public access only
128
+ - Robots.txt compliance
129
+ - Required metadata fields
130
+ - Health checks run without persistence or tracking
131
+
132
+ ---
133
+
134
+ ## πŸš€ Intended Users
135
+
136
+ - Journalists
137
+ - Researchers
138
+ - Attorneys
139
+ - Transparency advocates
140
+ - Members of the public
141
 
142
  ---
143
 
144
+ ## πŸ“Œ Disclaimer
145
 
146
+ This application is **not affiliated with any U.S. government agency**.
147
+ All documents remain the property of their originating agencies.
 
 
 
 
 
148
 
149
  ---
150
 
151
+ **Public transparency. Public sources. Clear boundaries.**