@regulaforensics/face-sdk 6.5.63-beta → 6.5.67-beta

package/www/types/match_faces/match_faces_image.d.ts

@@ -1,34 +0,0 @@
-import { ImageType } from '../face_capture/face_capture_image'
-
-/**
- * This class represents the input image and its attributes for {@link MatchFacesRequest}.
- */
-export class MatchFacesImage {
-    /**
-     * The underlying image.
-     */
-    get image(): string
-
-    /**
-     * The image type.
-     * The imageType influences matching results, therefore this field is required.
-     */
-    get imageType(): ImageType
-
-    /**
-     * Defines whether the comparison and detection should apply for all faces found on the image. Defaults to `false`.
-     * When set to `false`, only the most centered faces are compared and detected.
-     * Otherwise, all the faces are compared and detected.
-     */
-    get detectAll(): boolean
-    
-    get identifier(): string
-
-    constructor(
-        image: string,
-        imageType: ImageType,
-        params?: {
-            detectAll?: boolean
-        }
-    )
-}

package/www/types/match_faces/match_faces_request.d.ts

@@ -1,34 +0,0 @@
-import { MatchFacesImage } from './match_faces_image'
-import { OutputImageParams } from '../image_params/output_image_params'
-
-/**
- * Compares two or more images with faces on them to find out the similarity of pairs.
- * The request is used as a parameter to {@link FaceSDK.matchFaces}.
- */
-export class MatchFacesRequest {
-    /**
-     * Images with faces to match.
-     */
-    get images(): Array<MatchFacesImage>
-
-    /**
-     * If set the uploaded image is processed according to the indicated settings.
-     */
-    get outputImageParams(): OutputImageParams | null
-
-    /**
-     * Defines tag that can be used in match faces processing. Defaults to `null`.
-     */
-    get tag(): string | null
-
-    get metadata(): Record<string, any> | null
-
-    constructor(
-        images: Array<MatchFacesImage>,
-        params?: {
-            outputImageParams?: OutputImageParams
-            tag?: string
-            metadata?: Record<string, any>
-        }
-    )
-}

package/www/types/match_faces/match_faces_response.d.ts

@@ -1,27 +0,0 @@
-import { ComparedFacesPair } from './compared_faces_pair'
-import { MatchFacesDetection } from './match_faces_detection'
-import { MatchFacesException } from './match_faces_exception'
-
-/**
- * The response from the {@link MatchFacesRequest}.
- */
-export class MatchFacesResponse {
-    /**
-     * Face comparison results with score and similarity values.
-     */
-    get results(): Array<ComparedFacesPair>
-
-    /**
-     * Face detection results for each given image.
-     */
-    get detections(): Array<MatchFacesDetection>
-
-    get tag(): string | null
-
-    /**
-     * The error describes a failed match faces request and contains {@link MatchFacesErrorCode} codes.
-     */
-    get error(): MatchFacesException | null
-
-    private constructor()
-}

package/www/types/person_database/edit_group_persons_request.d.ts

@@ -1,8 +0,0 @@
-export class EditGroupPersonsRequest {
-    constructor(
-        params: {
-            personIdsToAdd?: string[],
-            personIdsToRemove?: string[],
-        }
-    )
-}

package/www/types/person_database/image_upload.d.ts

@@ -1,20 +0,0 @@
-/**
- * An object that represents uploaded image with its settings.
- */
-export class ImageUpload {
-    /**
-     * Creates an object of {@link ImageUpload} using an image.
-     * 
-     * @param imageData - Image base64.
-     */
-    static withImageData(imageData: string): ImageUpload
-
-    /**
-     * Creates an object of {@link ImageUpload} using an image url.
-     * 
-     * @param imageUrl - Image url.
-     */
-    static withImageUrl(imageUrl: string): ImageUpload
-
-    private constructor()
-}

package/www/types/person_database/pageable_item_list.d.ts

@@ -1,7 +0,0 @@
-export class PageableItemList<T> {
-    get items(): T[] | null
-    get page(): number
-    get totalPages(): number
-
-    private constructor()
-}

package/www/types/person_database/person.d.ts

@@ -1,33 +0,0 @@
-
-/**
- * A Person Database object that represents Person.
- */
-export class Person {
-    /**
-     * Person name.
-     * Updatable field.
-     */
-    name: string
-
-    /**
-     * Person update date.
-     */
-    get updatedAt(): Date
-
-    /**
-     * Array if Group IDs Person belongs to.
-     */
-    get groups(): string[]
-
-    get id(): string
-
-    /**
-     * A free-form object containing Person extended attributes.
-     * Updatable field.
-     */
-    metadata: any
-
-    get createdAt(): Date
-
-    private constructor()
-}

package/www/types/person_database/person_database.d.ts

@@ -1,95 +0,0 @@
-import { Person } from './person'
-import { PersonImage } from './person_image'
-import { ImageUpload } from './image_upload'
-import { PageableItemList } from './pageable_item_list'
-import { PersonGroup } from './person_group'
-import { EditGroupPersonsRequest } from './edit_group_persons_request'
-import { SearchPersonRequest } from './search_person_request'
-import { SearchPerson } from './search_person'
-
-/**
- * Represents Regula Database layer and is the entry point for Person Database operations.
- */
-export class PersonDatabase {
-    createPerson(
-        name: string,
-        params?: {
-            groupIds?: string[],
-            metadata?: any,
-        }
-    ): Promise<[Person | null, string | null]>
-
-    updatePerson(person: Person): Promise<[boolean, string | null]>
-
-    deletePerson(personId: string): Promise<[boolean, string | null]>
-
-    getPerson(personId: string): Promise<[Person | null, string | null]>
-
-    addPersonImage(
-        personId: string,
-        image: ImageUpload
-    ): Promise<[PersonImage | null, string | null]>
-
-    deletePersonImage(
-        personId: string,
-        imageId: string
-    ): Promise<[boolean, string | null]>
-
-    getPersonImage(
-        personId: string,
-        imageId: string
-    ): Promise<[PersonImage | null, string | null]>
-
-    getPersonImages(personId: string): Promise<[PageableItemList<PersonImage>, string | null]>
-
-    getPersonImagesForPage(
-        personId: string,
-        page: number,
-        size: number
-    ): Promise<[PageableItemList<PersonImage>, string | null]>
-
-    createGroup(
-        name: string,
-        params?: {
-            metadata?: any,
-        }
-    ): Promise<[PersonGroup | null, string | null]>
-
-    updateGroup(group: PersonGroup): Promise<[boolean, string | null]>
-
-    editPersonsInGroup(
-        groupId: string,
-        request: EditGroupPersonsRequest
-    ): Promise<[boolean, string | null]>
-
-    deleteGroup(groupId: string): Promise<[boolean, string | null]>
-
-    getGroup(groupId: string): Promise<[PersonGroup | null, string | null]>
-
-    getGroups(): Promise<[PageableItemList<PersonGroup>, string | null]>
-
-    getGroupsForPage(
-        page: number,
-        size: number
-    ): Promise<[PageableItemList<PersonGroup>, string | null]>
-
-    getPersonGroups(personId: string): Promise<[PageableItemList<PersonGroup>, string | null]>
-
-    getPersonGroupsForPage(
-        personId: string,
-        page: number,
-        size: number
-    ): Promise<[PageableItemList<PersonGroup>, string | null]>
-
-    getPersonsInGroup(groupId: string): Promise<[PageableItemList<Person>, string | null]>
-
-    getPersonsInGroupForPage(
-        groupId: string,
-        page: number,
-        size: number
-    ): Promise<[PageableItemList<Person>, string | null]>
-
-    searchPerson(request: SearchPersonRequest): Promise<[SearchPerson[] | null, string | null]>
-
-    private constructor()
-}

package/www/types/person_database/person_group.d.ts

@@ -1,22 +0,0 @@
-/**
- * Person Database object that represents Group of {@link Person}.
- */
-export class PersonGroup {
-    /**
-     * PersonGroup name.
-     * Updatable field.
-     */
-    name: string
-
-    get id(): string
-
-    /**
-     * A free-form object containing Group extended attributes.
-     * Updatable field.
-     */
-    metadata: any
-
-    get createdAt(): Date
-
-    private constructor()
-}

package/www/types/person_database/person_image.d.ts

@@ -1,10 +0,0 @@
-export class PersonImage {
-    get path(): string
-    get url(): string
-    get contentType(): string | null
-    get id(): string
-    get metadata(): any
-    get createdAt(): Date
-
-    private constructor()
-}

package/www/types/person_database/search_person.d.ts

@@ -1,31 +0,0 @@
-import { SearchPersonImage } from './search_person_image'
-import { SearchPersonDetection } from './search_person_detection'
-
-/**
- * A Person Database object that represents th result of Person search.
- */
-export class SearchPerson {
-    /**
-     * Array of images where the Person is found.
-     */
-    get images(): SearchPersonImage[]
-
-    /**
-     * Detection data relative to the search input image.
-     */
-    get detection(): SearchPersonDetection | null
-
-    name: string
-
-    get updatedAt(): Date
-
-    get groups(): string[]
-
-    get id(): string
-
-    metadata: any
-    
-    get createdAt(): Date
-
-    private constructor()
-}

package/www/types/person_database/search_person_detection.d.ts

@@ -1,11 +0,0 @@
-import { Point } from '../image_params/point'
-import { Rect } from '../image_params/rect'
-
-export class SearchPersonDetection {
-    get landmarks(): Point[]
-    get rect(): Rect
-    get crop(): string | null
-    get rotationAngle(): number | null
-
-    private constructor()
-}

package/www/types/person_database/search_person_image.d.ts

@@ -1,25 +0,0 @@
-/**
- * A Person Database object that represents Image result of Person Search.
- */
-export class SearchPersonImage {
-    /**
-     * The similarity score.
-     * From 0.0 to 1.0.
-     */
-    get similarity(): number
-
-    /**
-     * The similarity distance score.
-     * The lower the distance, the higher the face's similarity.
-     * From 0.0 to 2.0.
-     */
-    get distance(): number
-    get path(): string
-    get url(): string
-    get contentType(): string | null
-    get id(): string
-    get metadata(): any
-    get createdAt(): Date
-
-    private constructor()
-}

package/www/types/person_database/search_person_request.d.ts

@@ -1,39 +0,0 @@
-import { ImageUpload } from './image_upload'
-import { OutputImageParams } from '../image_params/output_image_params'
-
-/**
- * Request object that configures Search settings.
- */
-export class SearchPersonRequest {
-    /**
-     * Create {@link SearchPersonRequest} object.
-     * 
-     * @param image - Image Upload object to apply search with.
-     * 
-     * @param params.groupIdsForSearch - The Group IDs of the groups in which the search is performed.
-     * 
-     * @param params.threshold - The similarity distance threshold, should be between 0.0 and 2.0, 
-     * where 0.0 is for returning results for only the most similar persons and 2.0 
-     * is for all the persons, even the dissimilar ones.
-     * Default: 1.
-     * 
-     * @param params.limit - The number of returned Persons limit. 
-     * Default: 100.
-     * 
-     * @param params.detectAll - Whether to process only the one face on the image or all the faces. 
-     * Default: `false`.
-     * 
-     * @param params.outputImageParams - If set the uploaded image is processed according to the indicated settings.
-     */
-
-    constructor(
-        image: ImageUpload,
-        params?: {
-            groupIdsForSearch?: string[],
-            threshold?: number,
-            limit?: number,
-            detectAll?: boolean,
-            outputImageParams?: OutputImageParams
-        }
-    )
-}