Skip to main content

Regula Face Recognition web API Python 3.5+ client

OpenAPI documentation live

Face recognition as easy as reading two bytes.

If you have any problems with or questions about this client, please contact us through a GitHub issue. You are invited to contribute new features, fixes, or updates, large or small; We are always thrilled to receive pull requests, and do our best to process them as fast as we can. See dev guide

Install package

regula.facerecognition.webclient is on the Python Package Index (PyPI):

pip install regula.facerecognition.webclient

Or using pipenv

pipenv install regula.facerecognition.webclient

Example

Performing request:

from regula.facerecognition.webclient import *

with open("face1.jpg", "rb") as f:
    face_1_bytes = f.read()

with open("face2.jpg", "rb") as f:
    face_2_bytes = f.read()


with MatchingApi(host="http://0.0.0.0:41101/api") as api:
    images = [
        CompareImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),
        CompareImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),
        CompareImage(index=3, data=face_2_bytes)
    ]
    compare_request = CompareRequest(images=images)
    compare_response = api.compare(compare_request)

    detect_request = DetectRequest(face_1_bytes)
    detect_response = api.detect(detect_request)

You can find more detailed guide and run this sample in example folder.

Metadata

Release files for regula.facerecognition.webclient 2.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for regula.facerecognition.webclient 2.1.0
File Size Uploaded
regula.facerecognition.webclient-2.1.0.tar.gz 26.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for regula.facerecognition.webclient 2.1.0
File Interpreter ABI Platform
regula.facerecognition.webclient-2.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 76.7 kB

Release files / regula.facerecognition.webclient-2.1.0.tar.gz

Download URL regula.facerecognition.webclient-2.1.0.tar.gz
Size 26.5 kB
Tags Source
SHA-256 checksum
How to use checksums
6a0755bbafb6f0a3ef7542e7c4fc74c053caf821b41d0e2d8ccdfb61015a57b2
BLAKE2b-256 checksum
How to use checksums
fa15691630c2dc39955b6d3f410a8eeafc1cd85cbb6fb1b8e0a7d2ed67fe1b6e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.7

Release files / regula.facerecognition.webclient-2.1.0-py3-none-any.whl

Download URL regula.facerecognition.webclient-2.1.0-py3-none-any.whl
Size 50.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3a334024aa532ef64c561f73a9dc638271361aa8629c21a74102eacff2c5d11d
BLAKE2b-256 checksum
How to use checksums
db12679fe58a9a32bd920e1269c4464b348a70f94b6514d9e8684ea14d359f58
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.7

Release history Release notifications | RSS feed

This release

2.1.0 This release

2 release files

2.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page