diff --git a/common.yml b/common.yml index 9e18f3e..ffacc4f 100755 --- a/common.yml +++ b/common.yml @@ -73,7 +73,7 @@ components: description: "The RGB value for the background color: the silhouette of a person is cut out and the background is filled with this color." $ref: "#/components/schemas/RGB" crop: - description: "Whether to return the Base64 of an aligned and cropped portrait in the crop field." + description: "Whether to return the Base64 of an aligned and cropped portrait in the `crop` field." $ref: "#/components/schemas/Crop" QualityRequest: @@ -88,11 +88,11 @@ components: Crop: type: object - description: "Whether to return the Base64 of an aligned and cropped portrait in the crop field." + description: "Whether to return the Base64 image of an aligned and cropped portrait in the `crop` field." properties: type: $ref: "#/components/schemas/FaceImageQualityAlignType" - description: "The dimensions ratio to the height of the required pattern." + description: "The aspect ratio according to which face alignment is performed during face detection." example: 1 padColor: $ref: "#/components/schemas/RGB" @@ -103,7 +103,7 @@ components: type: integer minItems: 2 maxItems: 2 - description: "The resize value in case type matches this value. If it doesn't, no resize is done." + description: "The resize value in case `type` matches this value. If it doesn't, no resize is performed." example: [300, 400] returnOriginalRect: type: boolean diff --git a/detect.yml b/detect.yml index 5a14914..776190d 100644 --- a/detect.yml +++ b/detect.yml @@ -39,7 +39,7 @@ components: image: $ref: "./common.yml#/components/schemas/ImageData" thumbnails: - description: "Whether to return the cropped portrains with the detected faces." + description: "Deprecated, use the `crop` field in `processParam` instead." type: boolean default: false diff --git a/index.yml b/index.yml index 890e719..ab71794 100755 --- a/index.yml +++ b/index.yml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 5.2.0 + version: 6.1.0 title: Regula FaceSDK Web API x-logo: url: 'https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg' diff --git a/matching.yml b/matching.yml index 811849e..b5fb34f 100755 --- a/matching.yml +++ b/matching.yml @@ -25,6 +25,10 @@ paths: 403: $ref: "./common.yml#/components/responses/BadLicense" +info: + title: Regula FaceSDK Web API + version: 6.1.0 + components: schemas: @@ -38,13 +42,54 @@ components: description: "Session identificator." thumbnails: type: boolean - description: "Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces." + description: "Deprecated, use the `crop` field in `outputImageParams` instead." default: false + deprecated: true images: type: array description: "The array of all images included in the comparison." items: $ref: "#/components/schemas/MatchImage" + outputImageParams: + type: object + description: "Whether to process the uploaded image according to the indicated settings." + properties: + backgroundColor: + type: array + description: "The RGB value of a color for filling background behind a person's silhouette and for aligning the image." + default: null + items: + type: integer + crop: + type: object + description: "Whether to return the Base64 of an aligned and cropped portrait in the `crop` field." + properties: + padColor: + type: array + description: "The RGB value of a color for filling background behind a person's silhouette and for aligning the image." + default: null + items: + type: integer + returnOriginalRect: + type: boolean + description: "Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop." + default: null + size: + type: array + description: "The resize value in case `type` matches this value. If it doesn't, no resize is performed." + default: null + items: + type: integer + type: + type: integer + description: "The aspect ratio according to which face alignment is performed during face detection." + default: null + enum: + - 0 + - 1 + - 2 + - 3 + - 4 MatchImageIndex: type: integer @@ -142,11 +187,15 @@ components: example: [ [ x, y ] ] rotationAngle: description: "Angle of rotation of the face from the vertical axis, degrees." - type: float + type: number roi: $ref: "./common.yml#/components/schemas/FaceRectangular" thumbnail: $ref: "./common.yml#/components/schemas/Thumbnail" + crop: + type: string + format: byte + description: "Base64 of the cropped portrait." ImageSource: description: "The type of the image, defines the way the comparison is performed. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/"