Class FaceApiParams

Constructors

constructor

Properties

mode proxy? proxyPassword? proxyType? searchParams? serviceTimeout threshold url

Methods

fromJson

Constructors

constructor

  • new FaceApiParams(options?): FaceApiParams

  • Parameters

    • Optionaloptions: {
          mode?: string;
          proxy?: string;
          proxyPassword?: string;
          proxyType?: number;
          searchParams?: FaceApiSearchParams;
          serviceTimeout?: number;
          threshold?: number;
          url?: string;
      }
      • Optionalmode?: string
      • Optionalproxy?: string
      • OptionalproxyPassword?: string
      • OptionalproxyType?: number
      • OptionalsearchParams?: FaceApiSearchParams
      • OptionalserviceTimeout?: number
      • Optionalthreshold?: number
      • Optionalurl?: string

    Returns FaceApiParams

Properties

Readonlymode

mode: string

The processing mode: "match" or "match+search".

Default

"match"

Optional Readonlyproxy

proxy?: string

Proxy to use, should be set according to the cURL standart.

Optional ReadonlyproxyPassword

proxyPassword?: string

Username and password to use for proxy authentication, should be set according to the cURL standart.

Optional ReadonlyproxyType

proxyType?: number

Proxy protocol type, should be set according to the cURL standart.

Optional ReadonlysearchParams

searchParams?: FaceApiSearchParams

A search filter that can be applied if the "match+search" mode is enabled.

ReadonlyserviceTimeout

serviceTimeout: number

The service request timeout, ms.

Default

3000

Readonlythreshold

threshold: number

The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not.

Default

75

Readonlyurl

url: string

The URL of the Regula Face SDK service instance to be used.

Default

"https://faceapi.regulaforensics.com"

Methods

StaticfromJson

  • fromJson(jsonObject): FaceApiParams

  • Allows you to deserialize object.

    Parameters

    • jsonObject: any

    Returns FaceApiParams

Settings

Member Visibility

On This Page

Constructors
Properties
Methods