diff options
| author | Jules Laplace <julescarbon@gmail.com> | 2019-04-23 13:10:45 +0200 |
|---|---|---|
| committer | Jules Laplace <julescarbon@gmail.com> | 2019-04-23 13:10:45 +0200 |
| commit | f5f30912a2efd9c3d47cc9aeaf6a542211b00474 (patch) | |
| tree | 094c4d1e006711b3f7724f2aaf869e21ac5cb406 /docs/specifications.md | |
| parent | 79f0e696f3f6067a0841a37404fb546dedaa07cb (diff) | |
edits
Diffstat (limited to 'docs/specifications.md')
| -rw-r--r-- | docs/specifications.md | 73 |
1 files changed, 20 insertions, 53 deletions
diff --git a/docs/specifications.md b/docs/specifications.md index ec5c81f..6840a8d 100644 --- a/docs/specifications.md +++ b/docs/specifications.md @@ -48,72 +48,39 @@ Example response for a successful image upload with no match: ``` { - "success": True, - "match": False, - "closest_matches": - [ - { - "sha256: "cf80cd8aed482d5d1527d7dc72fceff84e6326592848447d2dc0b0e87dfc9a90", - "score": 2 - }, - { - "sha256: "156350ca18fa04545c4192432860c7efe9ddba18ea6e40e4da81bb7097a7166f", - "score": 3 - } - ] -" + "success": True, + "match": False +} ``` -Example response for a successful image upload with a match: +Example response for a successful image upload with a match, within the standard similarity threshold: `check.vframe.io/v1/match/` ``` { - "success": True, - "match": True, - "match": - { - "sha256: "eadc688cd557ee351fa9b718e87a6e8dfb9c9fce69e9944c71c0f58f8b972632", - "score": 0 - }, - "close_matches": - [ - { - "sha256: "cf80cd8aed482d5d1527d7dc72fceff84e6326592848447d2dc0b0e87dfc9a90", - "score": 2 - }, - { - "sha256: "156350ca18fa04545c4192432860c7efe9ddba18ea6e40e4da81bb7097a7166f", - "score": 2 - } - ] + "success": True, + "match": True, + "closest_match": { + "sha256: "eadc688cd557ee351fa9b718e87a6e8dfb9c9fce69e9944c71c0f58f8b972632", + "score": 0 + } +} " ``` Get match, but with more permissive threshold -`check.vframe.io/v1/match/threshold/3/` +`check.vframe.io/v1/match/?threshold=10` ``` { - "success": True, - "match": True, - "matches": - { - "sha256: "eadc688cd557ee351fa9b718e87a6e8dfb9c9fce69e9944c71c0f58f8b972632", - "score": 0 - }, - "closest_matches": - [ - { - "sha256: "cf80cd8aed482d5d1527d7dc72fceff84e6326592848447d2dc0b0e87dfc9a90", - "score": 3 - }, - { - "sha256: "156350ca18fa04545c4192432860c7efe9ddba18ea6e40e4da81bb7097a7166f", - "score": 3 - } - ] -"
\ No newline at end of file + "success": True, + "match": True, + "closest_match": { + "sha256: "eadc688cd557ee351fa9b718e87a6e8dfb9c9fce69e9944c71c0f58f8b972632", + "score": 7 + }, +} +``` |