GodsDevProject commited on
Commit
42d3562
Β·
verified Β·
1 Parent(s): 3c58fe9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +248 -58
README.md CHANGED
@@ -12,99 +12,289 @@ short_description: 'FOIA DECLASSIFIED DOCUMENTS SEARCH '
12
  ---
13
 
14
  # πŸ›οΈ Federal FOIA Intelligence Search
 
15
 
16
- **Public FOIA Electronic Reading Rooms β€” Link-Out Search Only**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
 
18
- This Hugging Face Space provides a **federated discovery interface** for official U.S. Government Freedom of Information Act (FOIA) Electronic Reading Rooms.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
 
20
- ⚠️ **This application does not scrape, crawl, mirror, store, or redistribute documents.**
21
- All results link directly to authoritative government sources.
 
 
 
 
 
 
 
 
22
 
23
  ---
24
 
25
- ## 🎯 Purpose
 
 
 
 
 
26
 
27
- - Accelerate public-interest research
28
- - Support journalism, litigation prep, and academic inquiry
29
- - Provide court-ready citations and documentation workflows
30
- - Enable **explicitly gated AI analysis** for public documents
31
 
32
  ---
33
 
34
- ## βœ”οΈ Core Guarantees
35
 
36
- - οΏ½οΏ½οΏ½ **Link-out only** to official FOIA libraries
37
- - πŸ“„ **No document hosting or redistribution**
38
- - 🧾 **Bluebook-formatted citations**
39
- - 🧠 **AI analysis is explicit opt-in**
40
- - βš–οΈ **LIVE results only are exportable**
41
- - 🚫 **STUB coverage is informational only**
42
 
43
  ---
44
 
45
- ## πŸ›οΈ Live FOIA Sources
46
 
47
- | Agency | Official Source |
48
- |------|----------------|
49
- | CIA | cia.gov/readingroom |
50
- | FBI | vault.fbi.gov |
51
- | DOJ | justice.gov/foia |
52
- | DHS | dhs.gov/foia |
53
- | State Dept | foia.state.gov |
54
- | GSA | gsa.gov |
55
- | NSA | nsa.gov |
56
 
57
  ---
58
 
59
- ## 🧠 AI & Semantic Features (Opt-In)
60
 
61
- AI functionality is **disabled by default**.
62
 
63
- When enabled by the user:
64
- - PDFs are processed **only when explicitly selected**
65
- - AI analysis is **user-initiated**
66
- - Outputs include:
67
- - Disclosure footer
68
- - Integrity hash
69
- - Source citation
70
- - AI output **is not a primary source** and **not legal advice**
71
 
72
- Optional FAISS semantic indexing operates on **metadata only** unless PDF analysis is explicitly requested.
73
 
74
  ---
75
 
76
- ## πŸ—‚οΈ Exports & Research Tools
77
 
78
- - 🧾 Bluebook citations
79
- - πŸ“¦ Journalist ZIP (links + citations only)
80
- - πŸ“„ FOIA request generator (PDF)
81
- - πŸ›οΈ Litigation appendix generator
82
- - πŸ“Š Entity graphs & timelines
83
 
84
  ---
85
 
86
- ## πŸ” Trust & Safety
87
 
88
- - No scraping or crawling
89
- - No robots.txt bypass
90
- - No credentialed systems
91
- - No personal data collection
92
- - Stateless execution
93
 
94
- See:
95
- - `TRUST_SAFETY.md`
96
- - `LEGAL_MEMO.md`
 
 
 
 
 
97
 
98
  ---
99
 
100
- ## πŸš€ Deployment
101
 
102
- Designed for **Hugging Face Spaces (Gradio)**
103
- No API keys required.
 
 
 
104
 
105
  ---
106
 
107
- ## πŸ“œ Disclaimer
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
108
 
109
- This tool assists discovery and analysis of public records.
110
- Always verify information against the original government source.
 
12
  ---
13
 
14
  # πŸ›οΈ Federal FOIA Intelligence Search
15
+ ### Public Electronic Reading Rooms Β· Evidence-Grade Citations Β· Responsible AI
16
 
17
+ ---
18
+
19
+ ## Executive Summary
20
+
21
+ **Federal FOIA Intelligence Search** is a **read-only, transparency-first research application** designed to help users **discover, organize, cite, and export publicly released U.S. government records** from official **FOIA Electronic Reading Rooms**.
22
+
23
+ This application is intentionally built to meet:
24
+
25
+ - πŸ“° Investigative journalism standards
26
+ - βš–οΈ Legal evidentiary and citation expectations
27
+ - 🧠 Responsible AI principles
28
+ - πŸ›‘οΈ Hugging Face Trust & Safety requirements
29
+
30
+ At all times, the system prioritizes **public accountability, verifiability, and user control** over automation or opaque data processing.
31
+
32
+ ---
33
+
34
+ ## Core Principles
35
+
36
+ 1. **Public Records Only**
37
+ 2. **Link-Out, Not Scraping**
38
+ 3. **User-Initiated Actions Only**
39
+ 4. **Explicit AI Opt-In**
40
+ 5. **Court-Ready Outputs**
41
+ 6. **Zero Background Data Collection**
42
+
43
+ ---
44
+
45
+ ## Supported Federal Agencies (Link-Out Only)
46
+
47
+ The app generates **official search links** to the following FOIA Electronic Reading Rooms:
48
+
49
+ - CIA β€” Central Intelligence Agency
50
+ - FBI β€” Federal Bureau of Investigation
51
+ - DOJ β€” Department of Justice
52
+ - DHS β€” Department of Homeland Security
53
+ - U.S. Department of State
54
+ - GSA β€” General Services Administration
55
+ - NSA β€” National Security Agency
56
+
57
+ > ⚠️ **Important:**
58
+ > This application **does not scrape, crawl, mirror, or store** documents from any agency.
59
+ > Each result redirects the user to the **agency’s official FOIA website**.
60
+
61
+ ---
62
+
63
+ ## How the App Works (Detailed)
64
+
65
+ ### Step 1 β€” User Search
66
+ The user enters a search term in the unified FOIA search bar.
67
+
68
+ ### Step 2 β€” Federated Link Generation
69
+ For each supported agency, the app:
70
+ - Generates an agency-specific FOIA search URL
71
+ - Measures request latency (for transparency)
72
+ - Produces structured metadata (agency, URL, timestamp)
73
+
74
+ ### Step 3 β€” Results Presentation
75
+ Results are displayed in two formats:
76
+ - A structured data table
77
+ - A polished card-based results gallery
78
+
79
+ No documents are downloaded automatically.
80
+
81
+ ### Step 4 β€” Optional Actions
82
+ Users may then:
83
+ - View or download documents from the agency website
84
+ - Generate citations, appendices, and exports
85
+ - Explicitly opt-in to AI analysis
86
+
87
+ ---
88
+
89
+ ## Feature Overview
90
+
91
+ ### πŸ” Polished FOIA Search Interface
92
+
93
+ - Unified search bar across agencies
94
+ - Clear agency attribution
95
+ - Latency badges for transparency
96
+ - No hidden background requests
97
+
98
+ ---
99
+
100
+ ### πŸ“š Exhibit-Aware Bluebook Citations
101
+
102
+ Each FOIA result is assigned:
103
+ - A cryptographic citation hash
104
+ - A sequential Exhibit ID (A-1, A-2, etc.)
105
+ - A Bluebook-formatted citation
106
+
107
+ **Designed for:**
108
+ - Court filings
109
+ - Academic papers
110
+ - Investigative reporting
111
+ - FOIA compliance audits
112
+
113
+ ---
114
+
115
+ ### βš–οΈ Litigation Appendix & Table of Authorities (PDF)
116
+
117
+ Generates a court-ready PDF containing:
118
+ - Title page
119
+ - Generation timestamp
120
+ - Sequential exhibit list
121
+ - Full Bluebook citations
122
+ - Implicit Table of Authorities
123
+
124
+ > πŸ“Œ The appendix contains **no AI-generated facts** β€” citations only.
125
 
126
+ ---
127
+
128
+ ### πŸ“ FOIA Request Generator
129
+
130
+ Provides **ready-to-edit FOIA request drafts** that:
131
+ - Reference the selected agency
132
+ - Include the user’s topic
133
+ - Follow standard FOIA request conventions
134
+
135
+ > ⚠️ Templates must be reviewed and customized before submission.
136
+
137
+ ---
138
+
139
+ ### 🧠 AI Analysis (Strictly Opt-In)
140
+
141
+ AI features are **disabled by default**.
142
+
143
+ To enable AI, the user must explicitly:
144
+ 1. Enable AI analysis
145
+ 2. (Optionally) allow PDF text extraction
146
+
147
+ AI analysis includes:
148
+ - Source attribution
149
+ - Context boundaries
150
+ - Mandatory disclosure block
151
+ - Cryptographic integrity hash
152
 
153
+ ---
154
+
155
+ ### πŸ”Ž AI Citation Cross-Checking
156
+
157
+ When AI is enabled:
158
+ - All analysis is tied to a selected FOIA record
159
+ - Unsupported claims are prevented
160
+ - Missing citation context is flagged
161
+
162
+ This reduces hallucinations and misuse.
163
 
164
  ---
165
 
166
+ ### πŸ“Š Analytical Visualizations
167
+
168
+ Available visual tools:
169
+ - Agency Coverage Heatmap
170
+ - Domain / Entity Frequency Graph
171
+ - Timeline of FOIA publication dates
172
 
173
+ These operate **only on metadata**, not document contents.
 
 
 
174
 
175
  ---
176
 
177
+ ### πŸ—‚ Journalist & Reviewer Export Bundles
178
 
179
+ One-click ZIP export containing:
180
+ - `citations.txt` β€” Bluebook citations
181
+ - `links.csv` β€” structured dataset
182
+ - Shareable evidence bundle
 
 
183
 
184
  ---
185
 
186
+ ### πŸ“€ Share Pages (Metadata Only)
187
 
188
+ Users may generate a temporary Share ID that:
189
+ - Preserves citation metadata
190
+ - Never hosts documents
191
+ - Exists only in memory
 
 
 
 
 
192
 
193
  ---
194
 
195
+ ## AI Disclosure & Integrity
196
 
197
+ Every AI output includes:
198
 
199
+ - Explicit disclosure notice
200
+ - User-initiated confirmation
201
+ - Integrity hash for auditability
 
 
 
 
 
202
 
203
+ AI outputs are **not evidence** and **not legal advice**.
204
 
205
  ---
206
 
207
+ ## Privacy & Security
208
 
209
+ - No accounts
210
+ - No cookies
211
+ - No analytics
212
+ - No persistent storage
213
+ - In-memory session state only
214
 
215
  ---
216
 
217
+ ## Warnings & Disclaimers ⚠️
218
 
219
+ ### Not Legal Advice
220
+ This application does not provide legal advice.
 
 
 
221
 
222
+ ### Not Evidence
223
+ AI summaries are not admissible evidence.
224
+
225
+ ### Public Records Only
226
+ The app cannot access unreleased, classified, or restricted materials.
227
+
228
+ ### No Government Affiliation
229
+ This project is independent and not affiliated with any U.S. government entity.
230
 
231
  ---
232
 
233
+ ## Tips & Best Practices
234
 
235
+ - βœ… Always verify citations at the source
236
+ - βœ… Use appendices for formal submissions
237
+ - βœ… Treat AI as a research assistant, not an authority
238
+ - ❌ Do not submit AI text as sworn testimony
239
+ - ❌ Do not assume FOIA completeness
240
 
241
  ---
242
 
243
+ ## Known Limitations
244
+
245
+ - No full-text indexing
246
+ - PDF extraction may fail on scanned documents
247
+ - Latency reflects link generation only
248
+
249
+ ---
250
+
251
+ ## Considerations for Responsible Use
252
+
253
+ - FOIA records may be incomplete or redacted
254
+ - Agencies publish at different cadences
255
+ - Absence of evidence is not evidence of absence
256
+
257
+ ---
258
+
259
+ ## Hugging Face Trust & Safety Alignment
260
+
261
+ This Space:
262
+ - Does not scrape or crawl
263
+ - Does not bypass authentication
264
+ - Does not host sensitive data
265
+ - Does not train on user input
266
+ - Does not automate surveillance
267
+
268
+ All AI functionality is:
269
+ - User-controlled
270
+ - Transparent
271
+ - Auditable
272
+
273
+ ---
274
+
275
+ ## Future & Planned Expansions (Non-Operational)
276
+
277
+ Potential future enhancements may include:
278
+ - Additional federal agencies
279
+ - State-level FOIA reading rooms
280
+ - Advanced citation validation
281
+ - Redaction comparison tools
282
+ - FOIA release trend analysis
283
+ - Multi-appendix case bundling
284
+
285
+ All future features will maintain:
286
+ - Public-only access
287
+ - Explicit user consent
288
+ - Responsible AI design
289
+
290
+ ---
291
+
292
+ ## Final Note
293
+
294
+ This application was built with a single guiding principle:
295
+
296
+ > **Transparency without automation abuse. Evidence without distortion. AI only when invited.**
297
+
298
+ ---
299
 
300
+ πŸ›οΈ **Public Records. Verified Sources. Responsible Intelligence.**