regula-facesdk-webclient 8.1.454.dev0__tar.gz → 8.1.492.dev0__tar.gz

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.1.454.dev0
+Version: 8.1.492.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/add_image_to_person_response.py

@@ -24,7 +24,7 @@ class AddImageToPersonResponse(BaseModel):
     created_at: SkipValidation[Optional[str]] = Field(alias="createdAt", default=None, description="Returned image creation date.")
     path: SkipValidation[Optional[str]] = Field(alias="path", default=None, description="Returned image path.")
     url: SkipValidation[Optional[str]] = Field(alias="url", default=None, description="Returned image URL.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     __properties: ClassVar[List[str]] = ["id", "contentType", "createdAt", "path", "url", "metadata"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/crop.py

@@ -22,8 +22,8 @@ class Crop(BaseModel):
     Whether to return a Base64-encoded image of each aligned and cropped portrait in the `crop` field. Faces are aligned to a straight vertical line based on the value in the `crop.type` field, correcting any tilt present in the original image. If the image contains multiple faces, the system will detect and process each face separately, returning individual portraits. For example, if there are five people in the photo, five processed portraits will be returned. Each portrait is available for download.
     """ # noqa: E501
     type: SkipValidation[Optional[FaceImageQualityAlignType]] = Field(alias="type", default=None)
-    pad_color: SkipValidation[Optional[List[int]]] = Field(alias="padColor", default=None, description="The RGB value of a color for filling background behind a person's silhouette and for aligning the image.")
-    size: SkipValidation[Optional[List[int]]] = Field(alias="size", default=None, description="The resize value in case `type` matches this value. If it doesn't, no resize is performed.")
+    pad_color: SkipValidation[Optional[List[int]]] = Field(alias="padColor", default=None, description="The RGB value of a color for filling background behind a person's silhouette and for aligning the image.")
+    size: SkipValidation[Optional[List[int]]] = Field(alias="size", default=None, description="The resize value in case `type` matches this value. If it doesn't, no resize is performed.")
     __properties: ClassVar[List[str]] = ["type", "padColor", "size"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/detect_details_meta.py

@@ -20,7 +20,7 @@ class DetectDetailsMeta(DetailItem):
     """
     DetectDetailsMeta
     """ # noqa: E501
-    confidence: SkipValidation[Optional[float]] = Field(alias="confidence", default=None, description="The confidence in the estimated value, `1.0` is for 100% confidence.")
+    confidence: SkipValidation[Optional[float]] = Field(alias="confidence", default=None, description="The confidence in the estimated value, `1.0` is for 100% confidence.")
     value: SkipValidation[Optional[str]] = Field(alias="value", default=None, description="The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).")
     __properties: ClassVar[List[str]] = ["name", "confidence", "value"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/detect_meta_data.py

@@ -19,7 +19,7 @@ class DetectMetaData(BaseModel):
     """
     DetectMetaData
     """ # noqa: E501
-    confidence: SkipValidation[Optional[float]] = Field(alias="confidence", default=None, description="The confidence in the estimated value, `1.0` is for 100% confidence.")
+    confidence: SkipValidation[Optional[float]] = Field(alias="confidence", default=None, description="The confidence in the estimated value, `1.0` is for 100% confidence.")
     value: SkipValidation[Optional[str]] = Field(alias="value", default=None, description="The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).")
     __properties: ClassVar[List[str]] = ["confidence", "value"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/detect_result.py

@@ -23,7 +23,7 @@ class DetectResult(BaseModel):
     detections: SkipValidation[List[Detection]] = Field(alias="detections", description="The array of performed checks.")
     detector_type: SkipValidation[Optional[int]] = Field(alias="detectorType", default=None, description="Internal.")
     landmarks_type: SkipValidation[Optional[int]] = Field(alias="landmarksType", default=None, description="Internal.")
-    scenario: SkipValidation[Optional[str]] = Field(alias="scenario", default=None, description="The face detection scenario that was set in the `processParam.scenario` field of the request.")
+    scenario: SkipValidation[Optional[str]] = Field(alias="scenario", default=None, description="The face detection scenario that was set in the `processParam.scenario` field of the request.")
     elapsed_time: SkipValidation[Optional[float]] = Field(alias="elapsedTime", default=None, description="Server processing time, ms. Does not include the time taken to receive the request or deliver the response.")
     __properties: ClassVar[List[str]] = ["detections", "detectorType", "landmarksType", "scenario", "elapsedTime"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/detection_attributes.py

@@ -20,7 +20,7 @@ class DetectionAttributes(BaseModel):
     """
     The evaluated attributes, see the [Attributes List](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/) for details.
     """ # noqa: E501
-    details: SkipValidation[Optional[List[DetailItem]]] = Field(alias="details", default=None, description="Attributes assessment details. Returns `DetectDetailsMeta` or `DetectAttributesDetails`.")
+    details: SkipValidation[Optional[List[DetailItem]]] = Field(alias="details", default=None, description="Attributes assessment details. Returns `DetectDetailsMeta` or `DetectAttributesDetails`.")
     elapsed_time: SkipValidation[Optional[float]] = Field(alias="elapsedTime", default=None, description="Server processing time for attribute detection, ms.")
     __properties: ClassVar[List[str]] = ["details", "elapsedTime"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/detection_quality.py

@@ -25,7 +25,7 @@ class DetectionQuality(BaseModel):
     non_compliant: SkipValidation[Optional[List[FaceQualityConfigName]]] = Field(alias="nonCompliant", default=None, description="Non-compliant assessment characteristics.")
     details_groups: SkipValidation[Optional[List[QualityDetailsGroups]]] = Field(alias="detailsGroups", default=None, description="Assessment results for each [group of characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).")
     details: SkipValidation[Optional[List[QualityDetail]]] = Field(alias="details", default=None, description="Assessment characteristics that were set in the request.")
-    score: SkipValidation[Optional[float]] = Field(alias="score", default=None, description="Returns the estimated portrait quality assessment result, a number from `0` to `1`, where `1` is for absolute compliance.")
+    score: SkipValidation[Optional[float]] = Field(alias="score", default=None, description="Returns the estimated portrait quality assessment result, a number from `0` to `1`, where `1` is for absolute compliance.")
     elapsed_time: SkipValidation[Optional[float]] = Field(alias="elapsedTime", default=None, description="Server processing time for quality assessment, ms.")
     __properties: ClassVar[List[str]] = ["nonCompliant", "detailsGroups", "details", "score", "elapsedTime"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/filter_search_request.py

@@ -21,8 +21,8 @@ class FilterSearchRequest(BaseModel):
     Allows to filter the search results based on the Person's `name`. If enabled, only the search results that meet the filter condition will be returned.
     """ # noqa: E501
     op: SkipValidation[Optional[FilterOp]] = Field(alias="op", default=None)
-    var_field: SkipValidation[Optional[str]] = Field(alias="field", default=None, description="`name` of the Person.")
-    value: SkipValidation[Optional[List[str]]] = Field(alias="value", default=None, description="The list of `name` values against which the `field` is compared.")
+    var_field: SkipValidation[Optional[str]] = Field(alias="field", default=None, description="`name` of the Person.")
+    value: SkipValidation[Optional[List[str]]] = Field(alias="value", default=None, description="The list of `name` values against which the `field` is compared.")
     __properties: ClassVar[List[str]] = ["op", "field", "value"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/group.py

@@ -21,7 +21,7 @@ class Group(BaseModel):
     Group
     """ # noqa: E501
     name: SkipValidation[Optional[str]] = Field(alias="name", default=None, description="Group to create name.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing group's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing group's extended attributes.")
     id: SkipValidation[Optional[str]] = Field(alias="id", default=None, description="Group ID.")
     created_at: SkipValidation[Optional[str]] = Field(alias="createdAt", default=None, description="Group creation date.")
     __properties: ClassVar[List[str]] = ["name", "metadata", "id", "createdAt"]

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/group_response.py

@@ -20,7 +20,7 @@ class GroupResponse(BaseModel):
     Response group create data, includes name and metadata.
     """ # noqa: E501
     name: SkipValidation[Optional[str]] = Field(alias="name", default=None, description="Group to create name.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing group's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing group's extended attributes.")
     __properties: ClassVar[List[str]] = ["name", "metadata"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/group_to_create.py

@@ -21,7 +21,7 @@ class GroupToCreate(BaseModel):
     """ # noqa: E501
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator.")
     name: SkipValidation[str] = Field(alias="name", description="Group to create name.")
-    metadata: SkipValidation[Dict[str, object]] = Field(alias="metadata", description="A free-form object containing group's extended attributes.")
+    metadata: SkipValidation[Dict[str, object]] = Field(alias="metadata", description="A free-form object containing group's extended attributes.")
     __properties: ClassVar[List[str]] = ["tag", "name", "metadata"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/image.py

@@ -20,13 +20,13 @@ class Image(BaseModel):
     Image in the response.
     """ # noqa: E501
     id: SkipValidation[Optional[str]] = Field(alias="id", default=None, description="Response image ID. The list is sorted by decreasing ID value.")
-    content: SkipValidation[Optional[str]] = Field(alias="content", default=None, description="Base64-encoded image. Returned only if `withImages` is set to true in the request.")
+    content: SkipValidation[Optional[str]] = Field(alias="content", default=None, description="Base64-encoded image. Returned only if `withImages` is set to true in the request.")
     content_type: SkipValidation[Optional[str]] = Field(alias="contentType", default=None, description="Original media type of the returned image.")
     created_at: SkipValidation[Optional[str]] = Field(alias="createdAt", default=None, description="Returned image creation date.")
     updated_at: SkipValidation[Optional[str]] = Field(alias="updatedAt", default=None, description="Returned image update date.")
     path: SkipValidation[Optional[str]] = Field(alias="path", default=None, description="Returned image path.")
     url: SkipValidation[Optional[str]] = Field(alias="url", default=None, description="Returned image URL.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     __properties: ClassVar[List[str]] = ["id", "content", "contentType", "createdAt", "updatedAt", "path", "url", "metadata"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/image_fields.py

@@ -24,7 +24,7 @@ class ImageFields(BaseModel):
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator, should be unique for each session.")
     image: SkipValidation[Optional[ImageFieldsImage]] = Field(alias="image", default=None)
     output_image_params: SkipValidation[Optional[OutputImageParams]] = Field(alias="outputImageParams", default=None)
-    detect_all: SkipValidation[Optional[bool]] = Field(alias="detectAll", default=None, description="Whether to detect all faces in the image. If set to `false`, only the most central face is detected.")
+    detect_all: SkipValidation[Optional[bool]] = Field(alias="detectAll", default=None, description="Whether to detect all faces in the image. If set to `false`, only the most central face is detected.")
     threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="The similarity threshold.")
     limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned.")
     __properties: ClassVar[List[str]] = ["tag", "image", "outputImageParams", "detectAll", "threshold", "limit"]

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/match_and_search_response.py

@@ -25,7 +25,7 @@ class MatchAndSearchResponse(BaseModel):
     code: SkipValidation[FaceSDKResultCode] = Field(alias="code")
     results: SkipValidation[Optional[List[MatchImageResult]]] = Field(alias="results", default=None, description="The match and search results.")
     elapsed_time: SkipValidation[Optional[float]] = Field(alias="elapsedTime", default=None, description="Server processing time, ms. Does not include the time taken to receive the request or deliver the response.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     detections: SkipValidation[Optional[List[MatchAndSearchResponseDataDetectionsItem]]] = Field(alias="detections", default=None, description="The detection results.")
     __properties: ClassVar[List[str]] = ["code", "results", "elapsedTime", "metadata", "detections"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/match_and_search_response_data.py

@@ -23,7 +23,7 @@ class MatchAndSearchResponseData(BaseModel):
     """ # noqa: E501
     results: SkipValidation[Optional[List[MatchImageResult]]] = Field(alias="results", default=None, description="The match and search results.")
     elapsed_time: SkipValidation[Optional[float]] = Field(alias="elapsedTime", default=None, description="Server processing time, ms. Does not include the time taken to receive the request or deliver the response.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     detections: SkipValidation[Optional[List[MatchAndSearchResponseDataDetectionsItem]]] = Field(alias="detections", default=None, description="The detection results.")
     __properties: ClassVar[List[str]] = ["results", "elapsedTime", "metadata", "detections"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/match_and_search_response_data_detections_item.py

@@ -22,7 +22,7 @@ class MatchAndSearchResponseDataDetectionsItem(BaseModel):
     MatchAndSearchResponseDataDetectionsItem
     """ # noqa: E501
     faces: SkipValidation[Optional[List[FacesResponse]]] = Field(alias="faces", default=None, description="Detected faces.")
-    image_index: SkipValidation[Optional[int]] = Field(alias="imageIndex", default=None, description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
+    image_index: SkipValidation[Optional[int]] = Field(alias="imageIndex", default=None, description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
     status: SkipValidation[Optional[FaceSDKResultCode]] = Field(alias="status", default=None)
     __properties: ClassVar[List[str]] = ["faces", "imageIndex", "status"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/match_image.py

@@ -20,10 +20,10 @@ class MatchImage(BaseModel):
     """
     MatchImage
     """ # noqa: E501
-    index: SkipValidation[Optional[int]] = Field(alias="index", default=None, description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
+    index: SkipValidation[Optional[int]] = Field(alias="index", default=None, description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
     type: SkipValidation[Optional[ImageSource]] = Field(alias="type", default=None)
     data: SkipValidation[bytearray] = Field(alias="data", description="Base64-encoded image.")
-    detect_all: SkipValidation[Optional[bool]] = Field(alias="detectAll", default=None, description="Whether to detect all faces in the image. If set to `false`, only the most central face is detected.")
+    detect_all: SkipValidation[Optional[bool]] = Field(alias="detectAll", default=None, description="Whether to detect all faces in the image. If set to `false`, only the most central face is detected.")
     __properties: ClassVar[List[str]] = ["index", "type", "data", "detectAll"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/match_image_detection.py

@@ -22,7 +22,7 @@ class MatchImageDetection(BaseModel):
     MatchImageDetection
     """ # noqa: E501
     faces: SkipValidation[Optional[List[DetectionFace]]] = Field(alias="faces", default=None, description="Detected faces.")
-    image_index: SkipValidation[int] = Field(alias="imageIndex", description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
+    image_index: SkipValidation[int] = Field(alias="imageIndex", description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
     status: SkipValidation[FaceSDKResultCode] = Field(alias="status")
     __properties: ClassVar[List[str]] = ["faces", "imageIndex", "status"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/match_image_result.py

@@ -20,10 +20,10 @@ class MatchImageResult(BaseModel):
     """
     MatchImageResult
     """ # noqa: E501
-    first_index: SkipValidation[int] = Field(alias="firstIndex", description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
+    first_index: SkipValidation[int] = Field(alias="firstIndex", description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
     first_face_index: SkipValidation[Optional[float]] = Field(alias="firstFaceIndex", default=None, description="The detected face index number.")
     first: SkipValidation[Optional[ImageSource]] = Field(alias="first", default=None)
-    second_index: SkipValidation[int] = Field(alias="secondIndex", description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
+    second_index: SkipValidation[int] = Field(alias="secondIndex", description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
     second_face_index: SkipValidation[Optional[float]] = Field(alias="secondFaceIndex", default=None, description="The detected face index number.")
     second: SkipValidation[Optional[ImageSource]] = Field(alias="second", default=None)
     score: SkipValidation[Optional[float]] = Field(alias="score", default=None, description="A dimensionless number that shows how similar the compared faces are. 0—absolutely identical faces.")

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/match_response.py

@@ -25,7 +25,7 @@ class MatchResponse(BaseModel):
     code: SkipValidation[FaceSDKResultCode] = Field(alias="code")
     detections: SkipValidation[Optional[List[MatchImageDetection]]] = Field(alias="detections", default=None, description="The detection results.")
     results: SkipValidation[Optional[List[MatchImageResult]]] = Field(alias="results", default=None, description="The comparison results.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     __properties: ClassVar[List[str]] = ["code", "detections", "results", "metadata"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/match_response_data.py

@@ -23,7 +23,7 @@ class MatchResponseData(BaseModel):
     """ # noqa: E501
     detections: SkipValidation[Optional[List[MatchImageDetection]]] = Field(alias="detections", default=None, description="The detection results.")
     results: SkipValidation[Optional[List[MatchImageResult]]] = Field(alias="results", default=None, description="The comparison results.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     __properties: ClassVar[List[str]] = ["detections", "results", "metadata"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/operation_log.py

@@ -22,7 +22,7 @@ class OperationLog(BaseModel):
     status_code: SkipValidation[Optional[int]] = Field(alias="statusCode", default=None, description="Status code.")
     type: SkipValidation[Optional[str]] = Field(alias="type", default=None, description="Error type.")
     msg: SkipValidation[Optional[str]] = Field(alias="msg", default=None, description="Error message.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing group's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing group's extended attributes.")
     __properties: ClassVar[List[str]] = ["statusCode", "type", "msg", "metadata"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/output_image_params.py

@@ -21,7 +21,7 @@ class OutputImageParams(BaseModel):
     """
     Allows to process the uploaded image according to the indicated settings.
     """ # noqa: E501
-    background_color: SkipValidation[Optional[List[int]]] = Field(alias="backgroundColor", default=None, description="The RGB value of a color for filling background behind a person's silhouette and for aligning the image.")
+    background_color: SkipValidation[Optional[List[int]]] = Field(alias="backgroundColor", default=None, description="The RGB value of a color for filling background behind a person's silhouette and for aligning the image.")
     crop: SkipValidation[Optional[Crop]] = Field(alias="crop", default=None)
     __properties: ClassVar[List[str]] = ["backgroundColor", "crop"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/person.py

@@ -20,9 +20,9 @@ class Person(BaseModel):
     """
     Person response body: person ID, creation date, update date if any.
     """ # noqa: E501
-    name: SkipValidation[str] = Field(alias="name", description="Person's name.")
-    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    name: SkipValidation[str] = Field(alias="name", description="Person's name.")
+    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     groups: SkipValidation[Optional[List[str]]] = Field(alias="groups", default=None, description="Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.")
     expire_at: SkipValidation[Optional[str]] = Field(alias="expireAt", default=None, description="Person expiration date.")
     id: SkipValidation[Optional[str]] = Field(alias="id", default=None, description="Person ID. The list of persons is sorted by decreasing ID value.")

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/person_fields.py

@@ -20,9 +20,9 @@ class PersonFields(BaseModel):
     """
     Person Request body: name and metadata.
     """ # noqa: E501
-    name: SkipValidation[str] = Field(alias="name", description="Person's name.")
-    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    name: SkipValidation[str] = Field(alias="name", description="Person's name.")
+    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     groups: SkipValidation[Optional[List[str]]] = Field(alias="groups", default=None, description="Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.")
     expire_at: SkipValidation[Optional[str]] = Field(alias="expireAt", default=None, description="Person expiration date.")
     __properties: ClassVar[List[str]] = ["name", "externalId", "metadata", "groups", "expireAt"]

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/person_to_update_fields.py

@@ -20,9 +20,9 @@ class PersonToUpdateFields(BaseModel):
     """
     Person Request body: name and metadata.
     """ # noqa: E501
-    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
-    name: SkipValidation[Optional[str]] = Field(alias="name", default=None, description="Person's name.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
+    name: SkipValidation[Optional[str]] = Field(alias="name", default=None, description="Person's name.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     groups: SkipValidation[Optional[List[str]]] = Field(alias="groups", default=None, description="Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.")
     __properties: ClassVar[List[str]] = ["externalId", "name", "metadata", "groups"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/person_with_images.py

@@ -22,9 +22,9 @@ class PersonWithImages(BaseModel):
     PersonWithImages
     """ # noqa: E501
     images: SkipValidation[Optional[List[RecognizeImage]]] = Field(alias="images", default=None, description="Detected Persons.")
-    name: SkipValidation[str] = Field(alias="name", description="Person's name.")
-    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    name: SkipValidation[str] = Field(alias="name", description="Person's name.")
+    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     groups: SkipValidation[Optional[List[str]]] = Field(alias="groups", default=None, description="Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.")
     expire_at: SkipValidation[Optional[str]] = Field(alias="expireAt", default=None, description="Person expiration date.")
     id: SkipValidation[Optional[str]] = Field(alias="id", default=None, description="Person ID. The list of persons is sorted by decreasing ID value.")

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/process_param.py

@@ -24,7 +24,7 @@ class ProcessParam(BaseModel):
     The processing parameters.
     """ # noqa: E501
     scenario: SkipValidation[Optional[FaceQualityScenarios]] = Field(alias="scenario", default=None)
-    only_central_face: SkipValidation[Optional[bool]] = Field(alias="onlyCentralFace", default=None, description="Whether to process only the central face in the image. If set to `false`, all the faces are processed.")
+    only_central_face: SkipValidation[Optional[bool]] = Field(alias="onlyCentralFace", default=None, description="Whether to process only the central face in the image. If set to `false`, all the faces are processed.")
     output_image_params: SkipValidation[Optional[OutputImageParams]] = Field(alias="outputImageParams", default=None)
     quality: SkipValidation[Optional[QualityRequest]] = Field(alias="quality", default=None)
     attributes: SkipValidation[Optional[ProcessParamAttributes]] = Field(alias="attributes", default=None)

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/quality_request.py

@@ -21,7 +21,7 @@ class QualityRequest(BaseModel):
     """
     If set, the face image quality check is performed according to the given list of [characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/) in `quality.config`.
     """ # noqa: E501
-    background_match_color: SkipValidation[Optional[List[int]]] = Field(alias="backgroundMatchColor", default=None, description="The RGB value of a color for filling background behind a person's silhouette and for aligning the image.")
+    background_match_color: SkipValidation[Optional[List[int]]] = Field(alias="backgroundMatchColor", default=None, description="The RGB value of a color for filling background behind a person's silhouette and for aligning the image.")
     config: SkipValidation[Optional[List[QualityConfig]]] = Field(alias="config", default=None, description="The list of quality check characteristics.")
     __properties: ClassVar[List[str]] = ["backgroundMatchColor", "config"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/recognize_image.py

@@ -20,15 +20,15 @@ class RecognizeImage(BaseModel):
     RecognizeImage
     """ # noqa: E501
     id: SkipValidation[Optional[str]] = Field(alias="id", default=None, description="Response image ID. The list is sorted by decreasing ID value.")
-    content: SkipValidation[Optional[str]] = Field(alias="content", default=None, description="Base64-encoded image. Returned only if `withImages` is set to true in the request.")
+    content: SkipValidation[Optional[str]] = Field(alias="content", default=None, description="Base64-encoded image. Returned only if `withImages` is set to true in the request.")
     content_type: SkipValidation[Optional[str]] = Field(alias="contentType", default=None, description="Original media type of the returned image.")
     created_at: SkipValidation[Optional[str]] = Field(alias="createdAt", default=None, description="Returned image creation date.")
     updated_at: SkipValidation[Optional[str]] = Field(alias="updatedAt", default=None, description="Returned image update date.")
     path: SkipValidation[Optional[str]] = Field(alias="path", default=None, description="Returned image path.")
     url: SkipValidation[Optional[str]] = Field(alias="url", default=None, description="Returned image URL.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     similarity: SkipValidation[Optional[float]] = Field(alias="similarity", default=None, description="Similarity score.")
-    distance: SkipValidation[Optional[float]] = Field(alias="distance", default=None, description="Similarity distance score: the lower the distance, the higher the face's similarity.")
+    distance: SkipValidation[Optional[float]] = Field(alias="distance", default=None, description="Similarity distance score: the lower the distance, the higher the face's similarity.")
     __properties: ClassVar[List[str]] = ["id", "content", "contentType", "createdAt", "updatedAt", "path", "url", "metadata", "similarity", "distance"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/recognize_image_data.py

@@ -20,7 +20,7 @@ class RecognizeImageData(BaseModel):
     RecognizeImageData
     """ # noqa: E501
     similarity: SkipValidation[Optional[float]] = Field(alias="similarity", default=None, description="Similarity score.")
-    distance: SkipValidation[Optional[float]] = Field(alias="distance", default=None, description="Similarity distance score: the lower the distance, the higher the face's similarity.")
+    distance: SkipValidation[Optional[float]] = Field(alias="distance", default=None, description="Similarity distance score: the lower the distance, the higher the face's similarity.")
     __properties: ClassVar[List[str]] = ["similarity", "distance"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/search_parameters_create_person.py

@@ -19,9 +19,9 @@ class SearchParametersCreatePerson(BaseModel):
     """
     If a person is not found, a new person entry is created using the descriptor calculated while searching.
     """ # noqa: E501
-    name: SkipValidation[Optional[str]] = Field(alias="name", default=None, description="Person's name.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
-    ttl: SkipValidation[Optional[int]] = Field(alias="ttl", default=None, description="The lifespan of the Person's records, seconds. Optional.")
+    name: SkipValidation[Optional[str]] = Field(alias="name", default=None, description="Person's name.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    ttl: SkipValidation[Optional[int]] = Field(alias="ttl", default=None, description="The lifespan of the Person's records, seconds. Optional.")
     __properties: ClassVar[List[str]] = ["name", "metadata", "ttl"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/search_person.py

@@ -22,9 +22,9 @@ class SearchPerson(BaseModel):
     """
     SearchPerson
     """ # noqa: E501
-    name: SkipValidation[str] = Field(alias="name", description="Person's name.")
-    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    name: SkipValidation[str] = Field(alias="name", description="Person's name.")
+    external_id: SkipValidation[Optional[str]] = Field(alias="externalId", default=None, description="Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     groups: SkipValidation[Optional[List[str]]] = Field(alias="groups", default=None, description="Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.")
     expire_at: SkipValidation[Optional[str]] = Field(alias="expireAt", default=None, description="Person expiration date.")
     id: SkipValidation[Optional[str]] = Field(alias="id", default=None, description="Person ID. The list of persons is sorted by decreasing ID value.")

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/search_request.py

@@ -32,7 +32,7 @@ class SearchRequest(BaseModel):
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator, should be unique for each session.")
     image: SkipValidation[Optional[ImageFieldsImage]] = Field(alias="image", default=None)
     output_image_params: SkipValidation[Optional[OutputImageParams]] = Field(alias="outputImageParams", default=None)
-    detect_all: SkipValidation[Optional[bool]] = Field(alias="detectAll", default=None, description="Whether to detect all faces in the image. If set to `false`, only the most central face is detected.")
+    detect_all: SkipValidation[Optional[bool]] = Field(alias="detectAll", default=None, description="Whether to detect all faces in the image. If set to `false`, only the most central face is detected.")
     threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="The similarity threshold.")
     limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned.")
     __properties: ClassVar[List[str]] = ["tenant", "env", "createPerson", "groupIds", "filter", "tag", "image", "outputImageParams", "detectAll", "threshold", "limit"]

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula/facesdk/webclient/gen/models/transaction_info.py

@@ -21,13 +21,13 @@ class TransactionInfo(BaseModel):
     TransactionInfo
     """ # noqa: E501
     code: SkipValidation[Optional[int]] = Field(alias="code", default=None, description="Result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).")
-    status: SkipValidation[Optional[int]] = Field(alias="status", default=None, description="Whether the liveness detection is confirmed `0` or not `1`.")
+    status: SkipValidation[Optional[int]] = Field(alias="status", default=None, description="Whether the liveness detection is confirmed `0` or not `1`.")
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator, should be unique for each session.")
     transaction_id: SkipValidation[Optional[str]] = Field(alias="transactionId", default=None, description="Transaction ID, there can be several transactions within one session.")
     video: SkipValidation[Optional[str]] = Field(alias="video", default=None, description="Link to the session video, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)")
     age: SkipValidation[Optional[List[Dict[str, object]]]] = Field(alias="age", default=None, description="Approximate age with an accuracy of +/-3 years.")
     portrait: SkipValidation[Optional[str]] = Field(alias="portrait", default=None, description="Link to the portrait, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     type: SkipValidation[Optional[LivenessType]] = Field(alias="type", default=None)
     __properties: ClassVar[List[str]] = ["code", "status", "tag", "transactionId", "video", "age", "portrait", "metadata", "type"]
 

{regula_facesdk_webclient-8.1.454.dev0 → regula_facesdk_webclient-8.1.492.dev0}/regula_facesdk_webclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.1.454.dev0
+Version: 8.1.492.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.