Class FaceApiSearchParams

Constructors

constructor

Properties

groupIds? limit threshold

Methods

fromJson

Constructors

constructor

  • new FaceApiSearchParams(options?): FaceApiSearchParams

  • Parameters

    • Optionaloptions: {
          groupIds?: string[];
          limit?: number;
          threshold?: number;
      }
      • OptionalgroupIds?: string[]
      • Optionallimit?: number
      • Optionalthreshold?: number

    Returns FaceApiSearchParams

Properties

Optional ReadonlygroupIds

groupIds?: string[]

The IDs of the groups in which the search is performed.

Readonlylimit

limit: number

The number of returned Persons limit.

Default

100

Readonlythreshold

threshold: number

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. If not set, the default 1.0 value is used.

Default

1

Methods

StaticfromJson

Settings

Member Visibility

On This Page

Constructors
Properties
Methods