Changed readme.md

Author: Artsiom Khadzkou

README.md

@@ -14,13 +14,11 @@
     permissions and limitations under the License.
  """
 
-from compreface.common.multipart_constructor import multipart_constructor
-import os
 import requests
-from compreface.common.typed_dict import AllOptionsDict, check_fields_by_name
+from compreface.common.multipart_constructor import multipart_constructor
+from compreface.common.typed_dict import ExpandedOptionsDict, check_fields_by_name
 from ..common import ClientRequest
 from compreface.config.api_list import DETECTION_API
-from requests_toolbelt.multipart.encoder import MultipartEncoder
 
 
 class DetectFaceFromImageClient(ClientRequest):
@@ -46,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: ExpandedOptionsDict = {}):
         url: str = self.url + '?'
 
         # Validation loop and adding fields to the url.

compreface/client/detect_face_from_image.py

@@ -13,14 +13,11 @@
     or implied. See the License for the specific language governing
     permissions and limitations under the License.
  """
+import requests
 
 from compreface.common.multipart_constructor import multipart_constructor
-from compreface.common.typed_dict import ExpandedOptionsDict, check_fields_by_name
+from compreface.common.typed_dict import AllOptionsDict, check_fields_by_name
 from compreface.config.api_list import RECOGNIZE_API
-import os
-import requests
-from requests_toolbelt.multipart.encoder import MultipartEncoder
-
 from ..common import ClientRequest
 
 
@@ -47,7 +44,7 @@ def get(self):
         :return: json from server.
     """
 
-    def post(self, image: str = '' or bytes, options: ExpandedOptionsDict = {}):
+    def post(self, image: str = '' or bytes, options: AllOptionsDict = {}):
         url: str = self.url + "?"
 
         # Validation loop and adding fields to the url.

compreface/client/recognize_face_from_image.py

@@ -20,7 +20,7 @@
 import os
 
 from requests_toolbelt.multipart.encoder import MultipartEncoder
-from compreface.common.typed_dict import AllOptionsDict, check_fields_by_name
+from compreface.common.typed_dict import ExpandedOptionsDict, check_fields_by_name
 from compreface.common.client import ClientRequest
 
 
@@ -53,7 +53,7 @@ def get(self):
     def post(self,
              source_image: str = '' or bytes,
              target_image: str = '' or bytes,
-             options: AllOptionsDict = {}) -> dict:
+             options: ExpandedOptionsDict = {}) -> dict:
 
         url: str = self.url + '/verify?'
         # Validation loop and adding fields to the url.

compreface/client/verify_face_from_image.py

@@ -24,12 +24,12 @@ class DetProbOptionsDict(TypedDict):
 
 class ExpandedOptionsDict(DetProbOptionsDict):
     limit: int
-    prediction_count: int
     status: bool
+    face_plugins: str
 
 
 class AllOptionsDict(ExpandedOptionsDict):
-    face_plugins: str
+    prediction_count: int
 
 
 """ 

compreface/common/typed_dict.py

@@ -14,7 +14,7 @@
     permissions and limitations under the License.
  """
 
-from compreface.common.typed_dict import AllOptionsDict
+from compreface.common.typed_dict import ExpandedOptionsDict
 from compreface.use_cases.detect_face_from_image import DetectFaceFromImage
 from typing import List
 
@@ -41,7 +41,7 @@ def get_available_functions(self) -> List[str]:
         """
         return self.available_services
 
-    def detect(self, image_path: str, options: AllOptionsDict = {}) -> dict:
+    def detect(self, image_path: str, options: ExpandedOptionsDict = {}) -> dict:
         """
         Detect face in image
         :param image_path:

compreface/service/detection_service.py

@@ -14,7 +14,7 @@
     permissions and limitations under the License.
  """
 
-from compreface.common.typed_dict import ExpandedOptionsDict
+from compreface.common.typed_dict import AllOptionsDict
 from typing import List
 
 from ..common import Service
@@ -49,7 +49,7 @@ def get_available_functions(self) -> List[str]:
         """
         return self.available_services
 
-    def recognize(self, image_path: str, options: ExpandedOptionsDict = {}) -> dict:
+    def recognize(self, image_path: str, options: AllOptionsDict = {}) -> dict:
         """
         Recognize image
         :param image_path:

compreface/service/recognition_service.py

@@ -15,10 +15,8 @@
  """
 
 from compreface.use_cases.verifiy_face_from_images import VerifyFaceFromImage
-from requests.api import request
-from compreface.common.typed_dict import AllOptionsDict
+from compreface.common.typed_dict import ExpandedOptionsDict
 from compreface.client.verify_face_from_image import VerifyFaceFromImageClient
-from compreface.collections.face_collections import FaceCollection
 from typing import List
 
 from ..common import Service
@@ -44,7 +42,7 @@ def get_available_functions(self) -> List[str]:
         """
         return self.available_services
 
-    def verify(self, source_image_path: str, target_image_path: str, options: AllOptionsDict) -> dict:
+    def verify(self, source_image_path: str, target_image_path: str, options: ExpandedOptionsDict) -> dict:
         """
         Verify face in images
         :param source_image_path:

compreface/service/verification_service.py

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

compreface/use_cases/detect_face_from_image.py

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