Business Card

The .NET SDK supports the Mindee V1 Business Card API.

Product Specifications

Specification	Details
Endpoint Name	business_card
Recommended Version	v1.0
Supports Polling/Webhooks	✔️ Yes
Support Synchronous HTTP Calls	❌ No
Geography	🌐 Global

Quick-Start

Using the sample below, we are going to illustrate how to extract the data that we want using the SDK.

Sample Code

using Mindee;
using Mindee.Input;
using Mindee.Product.BusinessCard;

string apiKey = "my-api-key";
string filePath = "/path/to/the/file.ext";

// Construct a new client
MindeeClient mindeeClient = new MindeeClient(apiKey);

// Load an input source as a path string
// Other input types can be used, as mentioned in the docs
var inputSource = new LocalInputSource(filePath);

// Call the product asynchronously with auto-polling
var response = await mindeeClient
    .EnqueueAndParseAsync<BusinessCardV1>(inputSource);

// Print a summary of all the predictions
System.Console.WriteLine(response.Document.ToString());

// Print only the document-level predictions
// System.Console.WriteLine(response.Document.Inference.Prediction.ToString());

Sample Output (rST)

########
Document
########
:Mindee ID: 6f9a261f-7609-4687-9af0-46a45156566e
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/business_card v1.0
:Rotation applied: Yes

Prediction
==========
:Firstname: Andrew
:Lastname: Morin
:Job Title: Founder & CEO
:Company: RemoteGlobal
:Email: [email protected]
:Phone Number: [phone]
:Mobile Number: [phone]
:Fax Number: [phone]
:Address: 178 Main Avenue, Providence, RI 02111
:Website: www.remoteglobalconsulting.com
:Social Media: https://www.linkedin.com/in/johndoe
               https://twitter.com/johndoe

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class. A typical BaseField object will have the following attributes:

• Confidence (double?): the confidence score of the field prediction.

• BoundingBox (BoundingBox): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.

• Polygon (Polygon): contains the relative vertices coordinates (Polygon extends List<Point>) of a polygon containing the field in the image.

• PageId (int?): the ID of the page, always null when at document-level.

A Point simply refers to a List of double.

Aside from the previous attributes, all basic fields have access to a custom ToString method that can be used to print their value as a string.

StringField

The text field StringField extends BaseField, but also implements:

• Value (string): corresponds to the field value.

• RawValue (string): corresponds to the raw value as it appears on the document.

Attributes

The following fields are extracted for Business Card V1:

Address

Address: The address of the person.

System.Console.WriteLine(result.Document.Inference.Prediction.Address.Value);

Company

Company: The company the person works for.

System.Console.WriteLine(result.Document.Inference.Prediction.Company.Value);

Email

Email: The email address of the person.

System.Console.WriteLine(result.Document.Inference.Prediction.Email.Value);

Fax Number

FaxNumber: The Fax number of the person.

System.Console.WriteLine(result.Document.Inference.Prediction.FaxNumber.Value);

Firstname

Firstname: The given name of the person.

System.Console.WriteLine(result.Document.Inference.Prediction.Firstname.Value);

Job Title

JobTitle: The job title of the person.

System.Console.WriteLine(result.Document.Inference.Prediction.JobTitle.Value);

Lastname

Lastname: The lastname of the person.

System.Console.WriteLine(result.Document.Inference.Prediction.Lastname.Value);

Mobile Number

MobileNumber: The mobile number of the person.

System.Console.WriteLine(result.Document.Inference.Prediction.MobileNumber.Value);

Phone Number

PhoneNumber: The phone number of the person.

System.Console.WriteLine(result.Document.Inference.Prediction.PhoneNumber.Value);

Social Media

SocialMedia: The social media profiles of the person or company.

foreach (var SocialMediaElem in result.Document.Inference.Prediction.SocialMedia)
{
    System.Console.WriteLine(SocialMediaElem.Value);
}

Website

Website: The website of the person or company.

System.Console.WriteLine(result.Document.Inference.Prediction.Website.Value);