Added detect_faces params

README.md

@@ -267,6 +267,10 @@ class SavedObjectOptions(TypedDict):
 class AllOptionsDict(ExpandedOptionsDict):
     prediction_count: int
 
+
+class RecognizeOptionsDict(AllOptionsDict):
+    detect_faces: bool
+
 ```
 | Option              | Type    | Notes                                     |
 | --------------------| ------  | ----------------------------------------- |
@@ -275,6 +279,10 @@ class AllOptionsDict(ExpandedOptionsDict):
 | prediction_count    | integer | maximum number of subject predictions per face. It returns the most similar subjects. Default value: 1    |
 | face_plugins        | string  | comma-separated slugs of face plugins. If empty, no additional information is returned. [Learn more](https://github.com/exadel-inc/CompreFace/tree/master/docs/Face-services-and-plugins.md)    |
 | status              | boolean | if true includes system information like execution_time and plugin_version fields. Default value is false    |
+| detect_faces              | boolean | if true the parameter specifies whether to perform image detection or not. Default value is true   |
+| page      | integer |  page number of examples to return. Can be used for pagination. Default value is 0.      |
+| size      | integer | faces on page (page size). Can be used for pagination. Default value is 20.             |
+| subject   | string  | what subject examples endpoint should return. If empty, return examples for all subjects.|
 
 Example of face recognition with object:
 
@@ -284,7 +292,8 @@ recognition.recognize_image(image_path=image_path, options={
     "det_prob_threshold": 0.8,
     "prediction_count": 1,
     "face_plugins": "calculator,age,gender,landmarks",
-    "status": "true"
+    "status": "true",
+    "detect_faces": True,
 })
 ```
 
@@ -310,7 +319,7 @@ recognition.recognize_image(image_path, options)
 | Argument           | Type    | Required | Notes                                                                                                                                          |
 | ------------------ | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
 | image_path         | image   | required | Image can pass from url, local path or bytes. Max size is 5Mb                                                         |
-| options            | object  | optional | `AllOptionsDict` object can be used in this method. See more [here](#options-structure).  |
+| options            | object  | optional | `RecognizeOptionsDict` object can be used in this method. See more [here](#options-structure).  |
 
 Response:
 

compreface/client/recognize_face_from_image.py

@@ -16,7 +16,7 @@
 import requests
 
 from compreface.common.multipart_constructor import multipart_constructor
-from compreface.common.typed_dict import AllOptionsDict, check_fields_by_name
+from compreface.common.typed_dict import RecognizeOptionsDict, check_fields_by_name
 from compreface.config.api_list import RECOGNIZE_API
 from ..common import ClientRequest
 
@@ -44,7 +44,7 @@ def get(self):
         :return: json from server.
     """
 
-    def post(self, image: str = "" or bytes, options: AllOptionsDict = {}):
+    def post(self, image: str = "" or bytes, options: RecognizeOptionsDict = {}):
         url: str = self.url + "?"
 
         # Validation loop and adding fields to the url.

compreface/common/typed_dict.py

@@ -42,6 +42,10 @@ class AllOptionsDict(ExpandedOptionsDict):
     prediction_count: int
 
 
+class RecognizeOptionsDict(AllOptionsDict):
+    detect_faces: bool
+
+
 """ 
     Checks fields with necessary rules.
     :param name: key from dictionary.
@@ -78,7 +82,7 @@ def check_fields_by_name(name: str, value: Any):
                 and row.find("pose") == -1
             ):
                 raise IncorrectFieldException(
-                    "face_plugins must be only contains calculator,age,gender,landmarks,mask. "
+                    "face_plugins must be only contains calculator,age,gender,landmarks,mask,pose."
                     "Incorrect value {}".format(row)
                 )
     if name == "page" or name == "size":

compreface/service/recognition_service.py

@@ -14,7 +14,11 @@
     permissions and limitations under the License.
  """
 
-from compreface.common.typed_dict import AllOptionsDict, PredictionCountOptionsDict
+from compreface.common.typed_dict import (
+    AllOptionsDict,
+    PredictionCountOptionsDict,
+    RecognizeOptionsDict,
+)
 from typing import List
 
 from ..common import Service
@@ -51,7 +55,9 @@ def get_available_functions(self) -> List[str]:
         """
         return self.available_services
 
-    def recognize_image(self, image_path: str, options: AllOptionsDict = {}) -> dict:
+    def recognize_image(
+        self, image_path: str, options: RecognizeOptionsDict = {}
+    ) -> dict:
         """
         Recognize faces from the uploaded image
 

compreface/use_cases/recognize_face_from_image.py

@@ -14,7 +14,7 @@
     permissions and limitations under the License.
  """
 
-from compreface.common.typed_dict import AllOptionsDict
+from compreface.common.typed_dict import RecognizeOptionsDict
 from dataclasses import dataclass
 from ..client import RecognizeFaceFromImageClient
 
@@ -30,6 +30,6 @@ def __init__(self, domain: str, port: str, api_key: str):
             api_key=api_key, domain=domain, port=port
         )
 
-    def execute(self, request: Request, options: AllOptionsDict = {}) -> dict:
+    def execute(self, request: Request, options: RecognizeOptionsDict = {}) -> dict:
         result: dict = self.recognize_face_from_image.post(request.image_path, options)
         return result

examples/recognize_face_from_image.py

@@ -31,6 +31,7 @@
         "prediction_count": 1,
         "status": "true",
         "face_plugins": "calculator",
+        "detect_faces": True,
     },
 )