summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJules Laplace <julescarbon@gmail.com>2019-04-23 13:26:03 +0200
committerJules Laplace <julescarbon@gmail.com>2019-04-23 13:26:03 +0200
commitdf83af26503a17a614fd504acab40256c4b2a645 (patch)
tree90b6b9eb7e8f86532cfb872a6e4ee1094837c91e /docs
parent1b30746ee4d38cd6acdbf339b4605700f07fc02a (diff)
specs
Diffstat (limited to 'docs')
-rw-r--r--docs/specifications.md31
1 files changed, 28 insertions, 3 deletions
diff --git a/docs/specifications.md b/docs/specifications.md
index 6840a8d..48106dd 100644
--- a/docs/specifications.md
+++ b/docs/specifications.md
@@ -63,8 +63,8 @@ Example response for a successful image upload with a match, within the standard
"success": True,
"match": True,
"closest_match": {
- "sha256: "eadc688cd557ee351fa9b718e87a6e8dfb9c9fce69e9944c71c0f58f8b972632",
- "score": 0
+ "sha256: "ed294c4a0bf1fc7120fe3fde8d96a9ac",
+ "score": 0
}
}
"
@@ -79,8 +79,33 @@ Get match, but with more permissive threshold
"success": True,
"match": True,
"closest_match": {
- "sha256: "eadc688cd557ee351fa9b718e87a6e8dfb9c9fce69e9944c71c0f58f8b972632",
+ "sha256: "efbaaffdcc01e45461b41dd2294020c4",
"score": 7
},
}
```
+
+Get top similar matches, but with more permissive threshold
+
+`check.vframe.io/v1/similar/?limit=10`
+
+```
+{
+ "success": True,
+ "match": True,
+ "matches": [
+ {
+ "sha256: "ed294c4a0bf1fc7120fe3fde8d96a9ac",
+ "score": 3
+ },
+ {
+ "sha256: "efbaaffdcc01e45461b41dd2294020c4",
+ "score": 7
+ },
+ {
+ "sha256: "fb06955237230dfe085bff351f3124ea",
+ "score": 11
+ },
+ ],
+}
+```