Update README.md
Browse files
README.md
CHANGED
|
@@ -1,53 +1,37 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
##
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
Visit `http://localhost:7860/docs` for the API documentation. There's only one route `/process_image` which returns
|
| 40 |
-
|
| 41 |
-
- The image with bounding boxes drawn on (in base64) format
|
| 42 |
-
- The parsed elements in a list with text descriptions
|
| 43 |
-
- The bounding box coordinates of the parsed elements
|
| 44 |
-
|
| 45 |
-
## Examples
|
| 46 |
-
|
| 47 |
-
| Before Image | After Image |
|
| 48 |
-
| ---------------------------------- | ----------------------------- |
|
| 49 |
-
|  |  |
|
| 50 |
-
|
| 51 |
-
## Related Projects
|
| 52 |
-
|
| 53 |
-
Check out [OneQuery](https://query-rho.vercel.app), an agent that browses the web and returns structured responses for any query, simple or complex. OneQuery is built using OmniParser to enhance its capabilities.
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
title: Omniparser-api
|
| 4 |
+
sdk: docker
|
| 5 |
+
emoji: 😻
|
| 6 |
+
colorFrom: red
|
| 7 |
+
colorTo: yellow
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
# Omniparser API
|
| 11 |
+
|
| 12 |
+
The Omniparser API is a versatile and efficient tool designed to parse, process, and analyze various types of documents or datasets using machine learning models.
|
| 13 |
+
|
| 14 |
+
## Features
|
| 15 |
+
|
| 16 |
+
- Upload and process documents (e.g., images, PDFs).
|
| 17 |
+
- Detect objects, text, or patterns within uploaded files.
|
| 18 |
+
- Analyze and parse structured or unstructured content.
|
| 19 |
+
- Highly configurable thresholds for precision and flexibility.
|
| 20 |
+
|
| 21 |
+
## How to Use
|
| 22 |
+
|
| 23 |
+
1. **Upload a Document**: Send a file (e.g., an image or PDF) via the `/process/` endpoint.
|
| 24 |
+
2. **Adjust Thresholds**: Configure `box_threshold` and `iou_threshold` for desired accuracy.
|
| 25 |
+
3. **Receive Results**: Get a JSON response with parsed content and processed outputs.
|
| 26 |
+
|
| 27 |
+
## Endpoints
|
| 28 |
+
|
| 29 |
+
- **`GET /`**: Welcome page for the API.
|
| 30 |
+
- **`POST /process/`**: Upload and process a document with configurable thresholds.
|
| 31 |
+
|
| 32 |
+
## Installation
|
| 33 |
+
|
| 34 |
+
1. Clone the repository:
|
| 35 |
+
```bash
|
| 36 |
+
git clone https://github.com/your-username/omniparser-api.git
|
| 37 |
+
cd omniparser-api
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|