Class RecognizeConfig

Image processing configuration.

Properties

data? dtc? extPortrait? image? imageInputData? images? livePortrait? oneShotIdentification onlineProcessingConfig? scenario?

Methods

withOnlineProcessingConfig withScenario

Properties

Optionaldata

data?: string

Binary for processing. Base64 string.

Optionaldtc

dtc?: string

DTC file for processing. Base64 string.

OptionalextPortrait

extPortrait?: string

Portrait photo from an external source.

Requires network connection.

Optionalimage

image?: string

Image for processing. Base64 string.

OptionalimageInputData

imageInputData?: ImageInputData[]

Images(with input data) for processing.

Optionalimages

images?: string[]

Images for processing. Array of base64 strings.

OptionallivePortrait

livePortrait?: string

Live portrait photo.

Requires network connection.

oneShotIdentification

oneShotIdentification: boolean

This parameter is for processing an image that contains a person and a document and compare the portrait photo from the document with the person's face. It works only in the single-frame processing, but not in the video frame processing. Requires network connection.

Default

false

Optional ReadonlyonlineProcessingConfig

onlineProcessingConfig?: OnlineProcessingConfig

Configuration class for online processing.

Requires network connection.

Optional Readonlyscenario

scenario?: Scenario

Documents processing scenario.

Methods

StaticwithOnlineProcessingConfig

  • withOnlineProcessingConfig(onlineProcessingConfig, options?): RecognizeConfig

  • Parameters

    • onlineProcessingConfig: OnlineProcessingConfig
    • Optionaloptions: {
          data?: string;
          dtc?: string;
          extPortrait?: string;
          image?: string;
          imageInputData?: ImageInputData[];
          images?: string[];
          livePortrait?: string;
          oneShotIdentification?: boolean;
      }
      • Optionaldata?: string
      • Optionaldtc?: string
      • OptionalextPortrait?: string
      • Optionalimage?: string
      • OptionalimageInputData?: ImageInputData[]
      • Optionalimages?: string[]
      • OptionallivePortrait?: string
      • OptionaloneShotIdentification?: boolean

    Returns RecognizeConfig

StaticwithScenario

  • withScenario(scenario, options?): RecognizeConfig

  • Parameters

    • scenario: Scenario
    • Optionaloptions: {
          data?: string;
          dtc?: string;
          extPortrait?: string;
          image?: string;
          imageInputData?: ImageInputData[];
          images?: string[];
          livePortrait?: string;
          oneShotIdentification?: boolean;
      }
      • Optionaldata?: string
      • Optionaldtc?: string
      • OptionalextPortrait?: string
      • Optionalimage?: string
      • OptionalimageInputData?: ImageInputData[]
      • Optionalimages?: string[]
      • OptionallivePortrait?: string
      • OptionaloneShotIdentification?: boolean

    Returns RecognizeConfig

Settings

Member Visibility

On This Page

Properties
Methods