Skip to content

Commit 578c656

Browse files
authored
Update Readme.md
1 parent d7300e3 commit 578c656

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

Readme.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ __Both HTTP and GRPC APIs are supported__
1616

1717
Use docker to run NSFW Sherlock
1818

19+
###
20+
__UPDATE 0.0.0.4:__
21+
22+
Now you can use additional API, which will give you labels (Drawings, Neutral, Hentai, Porn, Sexy) and its values directly. Implemented on both Web and GRPC APIs.
23+
For Web: /pic/labels
24+
For GRPC: Please refer to protofile in ./proto
1925

2026
###
2127

@@ -33,6 +39,24 @@ __Usage with Git Clone:__
3339
HTTP:
3440
docker run -e APP_ENV=http -p 4000:4000 nsfwsherlock
3541
(POST /pic/check) req: {"base64": "base64 string of image", filename: "image.jpg"}
42+
res: {
43+
"status": "ok",
44+
"message": "success",
45+
"nsfwText": true/false,
46+
"nsfwPic": true/false
47+
}
48+
49+
(POST /pic/labels) req: {"base64": "base64 string of image", filename: "image.jpg"},
50+
res: {
51+
"status": "ok",
52+
"message": "success",
53+
"drawings": 0.0,
54+
"hentai": 0.0,
55+
"neutral": 0.0,
56+
"porn": 0.0,
57+
"sexy": 0.0,
58+
"nsfwText": true/false,
59+
},
3660

3761
---------------------------------------------
3862

@@ -55,6 +79,24 @@ __Usage with Docker Hub:__
5579
HTTP:
5680
docker run -e APP_ENV=http -p 4000:4000 m1chl/nsfw-sherlock
5781
(POST /pic/check) req: {"base64": "base64 string of image", filename: "image.jpg"}
82+
res: {
83+
"status": "ok",
84+
"message": "success",
85+
"nsfwText": true/false,
86+
"nsfwPic": true/false
87+
}
88+
89+
(POST /pic/labels) req: {"base64": "base64 string of image", filename: "image.jpg"},
90+
res: {
91+
"status": "ok",
92+
"message": "success",
93+
"drawings": 0.0,
94+
"hentai": 0.0,
95+
"neutral": 0.0,
96+
"porn": 0.0,
97+
"sexy": 0.0,
98+
"nsfwText": true/false,
99+
},
58100

59101

60102
---------------------------------------------

0 commit comments

Comments
 (0)