Bcr

AI Business card recognition operations.

AiBcrApi module provides Business card recognition functions. Using these functions you can convert captured business card images to files in vCard format.

Business card parser recognizes:

Name.
Phone number.
Email address.
Website URL.
Job title.
Postal address.

Parse

Parse images to vCard document models. Returns ContactList model. Requires:

request

Parse method request. Type: AiBcrParseRequest.

var request = new AiBcrParseRequest
{ 
    File = new MemoryStream(File.ReadAllBytes("/path/to/image.png")),
    Countries = "us",
    Languages = "en",
    IsSingle = true
};

Java

AiBcrParseRequest request = Models.aiBcrParseRequest()
    .file(IOUtils.toByteArray(new FileInputStream("/path/to/image.png")))
    .countries("us")
    .languages("en")
    .isSingle(true)
    .build();

Python

request = models.AiBcrParseRequest(
    file='/path/to/image.png',
    countries='us',
    languages='en',
    is_single=True)

Ruby

request = AiBcrParseRequest.new(
    file: File.new('/path/to/image.png'),
    countries: 'us',
    languages: 'en',
    is_single: true)

Typescript

let request = Models.AiBcrParseRequest()
    .file(fs.readFileSync('/path/to/image.png'))
    .countries('us')
    .languages('en')
    .isSingle(true)
    .build();

PHP

$request = Models::AiBcrParseRequest()
    ->file(new SplFileObject('/path/to/image.png'))
    ->countries('us')
    ->languages('en')
    ->is_single(true)
    ->build();

var result = await api.Ai.Bcr.ParseAsync(request);

Java

ContactList result = api.ai().bcr().parse(request);

Python

result = api.ai.bcr.parse(request)

Ruby

result = api.ai.bcr.parse(request)

Typescript

let result = await api.ai.bcr.parse(request);

PHP

$result = $api->ai()->bcr()->parse($request);

ParseStorage

Parse images from storage to vCard files.

Function recognizes images from Cloud Storage. All recognized business cards will be saved as vCard *.vcf files and uploaded to Cloud Storage.

Returns StorageFileLocationList model. Requires:

request

Request with images located on storage. Type: AiBcrParseStorageRequest.

var request = new AiBcrParseStorageRequest
{
    OutFolder = new StorageFolderLocation
    {
        Storage = "First Storage",
        FolderPath = "VCard/files/produced/by/parser/will/be/placed/here"
    },
    Images = new List<AiBcrImageStorageFile>
    {
        new AiBcrImageStorageFile
        {
            File = new StorageFileLocation
            {
                FileName = "VCardScanImage.jpg",
                Storage = "First Storage",
                FolderPath = "image/location/on/storage"
            },
            IsSingle = true
        }
    }
};

Java

AiBcrParseStorageRequest request = Models.aiBcrParseStorageRequest()
    .outFolder(Models.storageFolderLocation()
        .storage("First Storage")
        .folderPath("VCard/files/produced/by/parser/will/be/placed/here")
        .build())
    .images(Arrays.<AiBcrImageStorageFile>asList(
        Models.aiBcrImageStorageFile()
            .file(Models.storageFileLocation()
                .fileName("VCardScanImage.jpg")
                .storage("First Storage")
                .folderPath("image/location/on/storage")
                .build())
            .isSingle(true)
            .build()))
    .build();

Python

request = models.AiBcrParseStorageRequest(
    out_folder=models.StorageFolderLocation(
        storage='First Storage',
        folder_path='VCard/files/produced/by/parser/will/be/placed/here'),
    images=[
        models.AiBcrImageStorageFile(
            file=models.StorageFileLocation(
                file_name='VCardScanImage.jpg',
                storage='First Storage',
                folder_path='image/location/on/storage'),
            is_single=True)])

Ruby

request = AiBcrParseStorageRequest.new(
  out_folder: StorageFolderLocation.new(
    storage: 'First Storage',
    folder_path: 'VCard/files/produced/by/parser/will/be/placed/here'),
  images: [
    AiBcrImageStorageFile.new(
      file: StorageFileLocation.new(
        file_name: 'VCardScanImage.jpg',
        storage: 'First Storage',
        folder_path: 'image/location/on/storage'),
      is_single: true)])

Typescript

let request = Models.aiBcrParseStorageRequest()
    .outFolder(Models.storageFolderLocation()
        .storage('First Storage')
        .folderPath('VCard/files/produced/by/parser/will/be/placed/here')
        .build())
    .images([
        Models.aiBcrImageStorageFile()
            .file(Models.storageFileLocation()
                .fileName('VCardScanImage.jpg')
                .storage('First Storage')
                .folderPath('image/location/on/storage')
                .build())
            .isSingle(true)
            .build()])
    .build();

PHP

$request = Models::aiBcrParseStorageRequest()
    ->outFolder(Models::storageFolderLocation()
        ->storage('First Storage')
        ->folderPath('VCard/files/produced/by/parser/will/be/placed/here')
        ->build())
    ->images(array(
        Models::aiBcrImageStorageFile()
            ->file(Models::storageFileLocation()
                ->fileName('VCardScanImage.jpg')
                ->storage('First Storage')
                ->folderPath('image/location/on/storage')
                ->build())
            ->isSingle(true)
            ->build()))
    ->build();

var result = await api.Ai.Bcr.ParseStorageAsync(request);

Java

StorageFileLocationList result = api.ai().bcr().parseStorage(request);

Python

result = api.ai.bcr.parse_storage(request)

Ruby

result = api.ai.bcr.parse_storage(request)

Typescript

let result = await api.ai.bcr.parseStorage(request);

PHP

$result = $api->ai()->bcr()->parseStorage($request);

More APIs

Bcr
Name