Merge pull request #1383 from serengil/feat-task-0911-file-input-for-api

Feat task 0911 file input for api
serengil · Nov 10, 2024 · c173ee6 · c173ee6
2 parents cc484b5 + 1de9034
commit c173ee6
Show file tree

Hide file tree

Showing 8 changed files with 412 additions and 79 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -37,6 +37,8 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pytest
+        # sending files in form data throwing error in flask 3 while running tests
+        pip install Werkzeug==2.0.2 flask==2.0.2
         pip install .
         
     - name: Test with pytest

diff --git a/README.md b/README.md
@@ -341,7 +341,7 @@ cd scripts
 
 <p align="center"><img src="https://raw.githubusercontent.com/serengil/deepface/master/icon/deepface-api.jpg" width="90%" height="90%"></p>
 
-Face recognition, facial attribute analysis and vector representation functions are covered in the API. You are expected to call these functions as http post methods. Default service endpoints will be `http://localhost:5005/verify` for face recognition, `http://localhost:5005/analyze` for facial attribute analysis, and `http://localhost:5005/represent` for vector representation. You can pass input images as exact image paths on your environment, base64 encoded strings or images on web. [Here](https://github.com/serengil/deepface/tree/master/deepface/api/postman), you can find a postman project to find out how these methods should be called.
+Face recognition, facial attribute analysis and vector representation functions are covered in the API. You are expected to call these functions as http post methods. Default service endpoints will be `http://localhost:5005/verify` for face recognition, `http://localhost:5005/analyze` for facial attribute analysis, and `http://localhost:5005/represent` for vector representation. The API accepts images as file uploads (via form data), or as exact image paths, URLs, or base64-encoded strings (via either JSON or form data), providing versatile options for different client requirements. [Here](https://github.com/serengil/deepface/tree/master/deepface/api/postman), you can find a postman project to find out how these methods should be called.
 
 **Dockerized Service** - [`Demo`](https://youtu.be/9Tk9lRQareA)
 

diff --git a/deepface/api/postman/deepface-api.postman_collection.json b/deepface/api/postman/deepface-api.postman_collection.json
@@ -1,12 +1,54 @@
 {
 	"info": {
-		"_postman_id": "4c0b144e-4294-4bdd-8072-bcb326b1fed2",
+		"_postman_id": "26c5ee53-1f4b-41db-9342-3617c90059d3",
 		"name": "deepface-api",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 	},
 	"item": [
 		{
-			"name": "Represent",
+			"name": "Represent - form data",
+			"request": {
+				"method": "POST",
+				"header": [],
+				"body": {
+					"mode": "formdata",
+					"formdata": [
+						{
+							"key": "img",
+							"type": "file",
+							"src": "/Users/sefik/Desktop/deepface/tests/dataset/img1.jpg"
+						},
+						{
+							"key": "model_name",
+							"value": "Facenet",
+							"type": "text"
+						}
+					],
+					"options": {
+						"raw": {
+							"language": "json"
+						}
+					}
+				},
+				"url": {
+					"raw": "http://127.0.0.1:5005/represent",
+					"protocol": "http",
+					"host": [
+						"127",
+						"0",
+						"0",
+						"1"
+					],
+					"port": "5005",
+					"path": [
+						"represent"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Represent - default",
 			"request": {
 				"method": "POST",
 				"header": [],
@@ -20,15 +62,15 @@
 					}
 				},
 				"url": {
-					"raw": "http://127.0.0.1:5000/represent",
+					"raw": "http://127.0.0.1:5005/represent",
 					"protocol": "http",
 					"host": [
 						"127",
 						"0",
 						"0",
 						"1"
 					],
-					"port": "5000",
+					"port": "5005",
 					"path": [
 						"represent"
 					]
@@ -37,29 +79,76 @@
 			"response": []
 		},
 		{
-			"name": "Face verification",
+			"name": "Face verification - default",
 			"request": {
 				"method": "POST",
 				"header": [],
 				"body": {
 					"mode": "raw",
-					"raw": "  {\n  \t\"img1_path\": \"/Users/sefik/Desktop/deepface/tests/dataset/img1.jpg\",\n    \"img2_path\": \"/Users/sefik/Desktop/deepface/tests/dataset/img2.jpg\",\n    \"model_name\": \"Facenet\",\n    \"detector_backend\": \"mtcnn\",\n    \"distance_metric\": \"euclidean\"\n  }",
+					"raw": "  {\n  \t\"img1\": \"/Users/sefik/Desktop/deepface/tests/dataset/img1.jpg\",\n    \"img2\": \"/Users/sefik/Desktop/deepface/tests/dataset/img2.jpg\",\n    \"model_name\": \"Facenet\",\n    \"detector_backend\": \"mtcnn\",\n    \"distance_metric\": \"euclidean\"\n  }",
+					"options": {
+						"raw": {
+							"language": "json"
+						}
+					}
+				},
+				"url": {
+					"raw": "http://127.0.0.1:5005/verify",
+					"protocol": "http",
+					"host": [
+						"127",
+						"0",
+						"0",
+						"1"
+					],
+					"port": "5005",
+					"path": [
+						"verify"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Face verification - form data",
+			"request": {
+				"method": "POST",
+				"header": [],
+				"body": {
+					"mode": "formdata",
+					"formdata": [
+						{
+							"key": "img1",
+							"type": "file",
+							"src": "/Users/sefik/Desktop/deepface/tests/dataset/img1.jpg"
+						},
+						{
+							"key": "img2",
+							"type": "file",
+							"src": "/Users/sefik/Desktop/deepface/tests/dataset/img2.jpg"
+						},
+						{
+							"key": "model_name",
+							"value": "Facenet",
+							"type": "text"
+						}
+					],
 					"options": {
 						"raw": {
 							"language": "json"
 						}
 					}
 				},
 				"url": {
-					"raw": "http://127.0.0.1:5000/verify",
+					"raw": "http://127.0.0.1:5005/verify",
 					"protocol": "http",
 					"host": [
 						"127",
 						"0",
 						"0",
 						"1"
 					],
-					"port": "5000",
+					"port": "5005",
 					"path": [
 						"verify"
 					]
@@ -68,29 +157,68 @@
 			"response": []
 		},
 		{
-			"name": "Face analysis",
+			"name": "Face analysis - default",
 			"request": {
 				"method": "POST",
 				"header": [],
 				"body": {
 					"mode": "raw",
-					"raw": "{\n    \"img_path\": \"/Users/sefik/Desktop/deepface/tests/dataset/couple.jpg\",\n    \"actions\": [\"age\", \"gender\", \"emotion\", \"race\"]\n}",
+					"raw": "{\n    \"img\": \"/Users/sefik/Desktop/deepface/tests/dataset/img1.jpg\",\n    \"actions\": [\"age\", \"gender\", \"emotion\", \"race\"]\n}",
 					"options": {
 						"raw": {
 							"language": "json"
 						}
 					}
 				},
 				"url": {
-					"raw": "http://127.0.0.1:5000/analyze",
+					"raw": "http://127.0.0.1:5005/analyze",
 					"protocol": "http",
 					"host": [
 						"127",
 						"0",
 						"0",
 						"1"
 					],
-					"port": "5000",
+					"port": "5005",
+					"path": [
+						"analyze"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Face analysis - form data",
+			"request": {
+				"method": "POST",
+				"header": [],
+				"body": {
+					"mode": "formdata",
+					"formdata": [
+						{
+							"key": "img",
+							"type": "file",
+							"src": "/Users/sefik/Desktop/deepface/tests/dataset/img1.jpg"
+						},
+						{
+							"key": "actions",
+							"value": "\"[age, gender]\"",
+							"type": "text"
+						}
+					],
+					"options": {
+						"raw": {
+							"language": "json"
+						}
+					}
+				},
+				"url": {
+					"raw": "http://localhost:5005/analyze",
+					"protocol": "http",
+					"host": [
+						"localhost"
+					],
+					"port": "5005",
 					"path": [
 						"analyze"
 					]