diff options
| -rw-r--r-- | README.md | 15 |
1 files changed, 6 insertions, 9 deletions
@@ -1,7 +1,6 @@ # VFRAME Check API -VFRAME Check API Service - +The VFRAME Check API Service uses perceptual hash to disambiguate similar images as well as provide an image-based search engine. ## Quick Start @@ -11,7 +10,7 @@ VFRAME Check API Service ``` apt install git nginx mysql-server mysql-client mysql_secure_installation -mysql -r root +mysql -u root -p ``` Create MySQL user: @@ -40,7 +39,6 @@ python cli_phash.py import -i 'static/sample_set_test_01/images/*' Build the Javascript frontend: ``` -npm run watch npm run build ``` @@ -53,7 +51,6 @@ python cli_flask.py run The server will be running on http://0.0.0.0:5000/ - ### Endpoints #### POST /v1/match @@ -64,8 +61,8 @@ Form parameters: - `threshold` (default: 6) - Minimum similarity threshold. This is the Hamming distance used for phash comparisons. - `limit` (default: 1) - Number of results to return. -- `url` - Image URL to fetch and test (will be stored if `add` is true) -- `q` (file) - Uploaded file to test (will not be stored) +- `url` - Image URL to fetch and test (will be added if not found!) +- `q` (file) - Uploaded file to test (will not be added) #### POST /v1/similar @@ -75,6 +72,6 @@ Form parameters: - `threshold` (default: 20) - Minimum similarity threshold. - `limit` (default: 10) - Number of results to return. -- `url` - Image URL to fetch and test (will be stored if `add` is true) -- `q` (file) - Uploaded file to test (will not be stored) +- `url` - Image URL to fetch and test +- `q` (file) - Uploaded file to test |