@regulaforensics/document-reader
    Preparing search index...

    Class RecognizeConfig

    Image processing configuration.

    Index
    data? dataList? dtc? extPortrait? image? imageInputData? images? livePortrait? oneShotIdentification onlineProcessingConfig? scenario?
    withOnlineProcessingConfig withScenario
    data?: string

    Binary for processing. Base64 string.

    dataList?: string[]

    Binaries for processing. Array of base64 strings.

    dtc?: string

    DTC file for processing. Base64 string.

    extPortrait?: string

    Portrait photo from an external source.

    Requires network connection.

    image?: string

    Image for processing. Base64 string.

    imageInputData?: ImageInputData[]

    Images(with input data) for processing.

    images?: string[]

    Images for processing. Array of base64 strings.

    livePortrait?: string

    Live portrait photo.

    Requires network connection.

    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.

    false
    onlineProcessingConfig?: OnlineProcessingConfig

    Configuration class for online processing.

    Requires network connection.

    scenario?: Scenario

    Documents processing scenario.

    • Parameters

      • onlineProcessingConfig: OnlineProcessingConfig
      • Optionaloptions: {
            data?: string;
            dataList?: string[];
            dtc?: string;
            extPortrait?: string;
            image?: string;
            imageInputData?: ImageInputData[];
            images?: string[];
            livePortrait?: string;
            oneShotIdentification?: boolean;
        }

      Returns RecognizeConfig

    • Parameters

      • scenario: Scenario
      • Optionaloptions: {
            data?: string;
            dataList?: string[];
            dtc?: string;
            extPortrait?: string;
            image?: string;
            imageInputData?: ImageInputData[];
            images?: string[];
            livePortrait?: string;
            oneShotIdentification?: boolean;
        }

      Returns RecognizeConfig

    Settings
    Member Visibility

    On This Page
    Properties
    Methods