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.3.787.dev0.tar.gz (62.9 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.3.787.dev0-py3-none-any.whl (178.3 kB view details)

Uploaded Python 3

File details

Details for the file regula_facesdk_webclient-8.3.787.dev0.tar.gz.

File metadata

File hashes

Hashes for regula_facesdk_webclient-8.3.787.dev0.tar.gz
Algorithm Hash digest
SHA256 ab1fa58dafc564d688ece89b4a175f4aebf6f6aba5a6ef5a931092d73241dad5
MD5 ee37111e7c3a34eaa481a2b36f5b284e
BLAKE2b-256 9d61b7fece8350fb4c139c8c65eea1688a20e0bc945e49055c3e8812a98b1912

See more details on using hashes here.

File details

Details for the file regula_facesdk_webclient-8.3.787.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for regula_facesdk_webclient-8.3.787.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 875d4eaeee3f07fff99e321308dab8034824609455558c91b5490a577e60c46b
MD5 827dbc4112d570e5b7b150225532fc53
BLAKE2b-256 caf889684877531f053314944089b75a005c10e3421eee8cffe8423b842f67bb

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page