Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Regula Face SDK web API Python 3.9+ client

OpenAPI documentation live

⚠️ Warning: Package Name Changed

Package name has been changed from regula.facesdk.webclient to regula_facesdk_webclient

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_facesdk_webclient is on the Python Package Index (PyPI):

pip install regula_facesdk_webclient

Or using pipenv

pipenv install regula_facesdk_webclient

Example

Performing request:

from regula.facesdk.webclient import MatchImage, MatchRequest
from regula.facesdk.webclient.ext import FaceSdk, DetectRequest
from regula.facesdk.webclient.gen.model.image_source import ImageSource

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 FaceSdk(host="http://0.0.0.0:41101") as sdk:
    images = [
        MatchImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),
        MatchImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),
        MatchImage(index=3, data=face_2_bytes)
    ]
    match_request = MatchRequest(images=images)
    match_response = sdk.match_api.match(match_request)

    detect_request = DetectRequest(image=face_1_bytes)
    detect_response = sdk.match_api.detect(detect_request)

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

regula_facesdk_webclient-8.4.820rc0.tar.gz (62.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

regula_facesdk_webclient-8.4.820rc0-py3-none-any.whl (178.3 kB view details)

Uploaded Python 3

File details

Details for the file regula_facesdk_webclient-8.4.820rc0.tar.gz.

File metadata

File hashes

Hashes for regula_facesdk_webclient-8.4.820rc0.tar.gz
Algorithm Hash digest
SHA256 1331dfd3d71c7125612f590dfa1730019021a14db4f0aa95b507699bba6a0491
MD5 0ab47c9a0653d3a03d3585c2f67cb074
BLAKE2b-256 e0cbedbd479ddd27f5e19706d7b743f0043a0427465d6e8560942f3c5a59f80c

See more details on using hashes here.

File details

Details for the file regula_facesdk_webclient-8.4.820rc0-py3-none-any.whl.

File metadata

File hashes

Hashes for regula_facesdk_webclient-8.4.820rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf8827ea9746198348f3098ffce9b5b6679eb1542e6176afc0e35389a72aae1c
MD5 7507c6c17958c5e712d2f0bee0b16f60
BLAKE2b-256 1e9d379008552792fb98422fd6d6ee7abc42114f3afc97cf567e9235201cf9d2

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

8.4.820rc0 This release

2 files

8.3.783

2 files

8.3.782

2 files

8.2.631

2 files

8.1.542

2 files

7.2.389

2 files

7.1.318

2 files

7.1.283

2 files

6.4.107

2 files

6.3.32

2 files

6.1.0

2 files

5.2.4

2 files

5.2.3

2 files

5.2.2

2 files

5.2.1

2 files

5.2.0

2 files

5.1.1

2 files

5.1.0

2 files

4.1.8

2 files

4.1.7

2 files

4.1.6

2 files

4.1.5

2 files

4.1.4

2 files

4.1.3

2 files

4.1.2

2 files

4.1.1

2 files

4.1.0

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 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