diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 12 insertions, 4 deletions
@@ -35,14 +35,22 @@ DB_PASS=some_new_password #### POST /v1/match -Check if an image is in the database. If no images are found within the similarity threshold, add this image to the database. +Check if an image is in the database. If no images are found within the threshold, this image will be added to the database. -Options: +Form parameters: - `threshold` (default: 6) - Minimum similarity threshold. This is the Hamming distance used for phash comparisons. -- `add` (default: true) - Pass `false` if you do not want the image added to the database. +- `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) #### POST /v1/similar -- `limit` (default: 10) - Number of results to return. +Find similar images to a query image. + +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) |