arshaan-nazir commited on
Commit
74aae89
·
verified ·
1 Parent(s): b5724ac

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -2
README.md CHANGED
@@ -8,7 +8,70 @@ sdk_version: 5.12.0
8
  app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
- short_description: 'This Hugging Face Space provides a receipt OCR service that '
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
+ short_description: 'This Hugging Face Space provides restaurant receipts OCR.'
12
  ---
13
 
14
+ ## Features
15
+
16
+ - **Multi-Language Support**: Process receipts in multiple languages including English, Chinese, French, German, Korean, Japanese, and more
17
+ - **LLM Integration**: Use Groq or OpenAI for structured JSON formatting
18
+ - **Flexible Output**: Get raw OCR text or formatted JSON based on your needs
19
+ - **Secure API Key Handling**: Safely input your API keys for LLM processing
20
+
21
+ ## How to Use
22
+
23
+ 1. **Upload Receipt**: Upload a clear image of your receipt
24
+ 2. **Select Language**: Choose the primary language of your receipt
25
+ 3. **LLM Processing** (Optional):
26
+ - Select your preferred LLM provider (Groq or OpenAI)
27
+ - Enter your API key
28
+ 4. **Process**: Click "Process Receipt" to get results
29
+
30
+ ## Output Format
31
+
32
+ The app provides JSON output with the following structure:
33
+ ```json
34
+ {
35
+ "restaurant_name": string,
36
+ "date": string,
37
+ "time": string,
38
+ "table_number": string or number,
39
+ "server_name": string,
40
+ "payment_method": string,
41
+ "items": [
42
+ {
43
+ "name": string,
44
+ "quantity": number,
45
+ "price": number
46
+ }
47
+ ],
48
+ "subtotal": number,
49
+ "tax": number,
50
+ "tip": number,
51
+ "total": number,
52
+ "receipt_number": string
53
+ }
54
+ ```
55
+
56
+ ## Supported Languages
57
+
58
+ - English
59
+ - Chinese Simplified
60
+ - French
61
+ - German
62
+ - Korean
63
+ - Japanese
64
+ - Italian
65
+ - Spanish
66
+ - Portuguese
67
+ - Russian
68
+ - Arabic
69
+ - Hindi
70
+ - Vietnamese
71
+ - Thai
72
+
73
+ ## Notes
74
+
75
+ - Image quality affects OCR accuracy
76
+ - For best results, ensure receipt is well-lit and clearly visible
77
+ - LLM processing requires valid API keys from Groq or OpenAI