RecognizeBusinessCardsOptions Class

Package:

com.azure.ai.formrecognizer.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.12

• java.lang.Object
• • com.azure.ai.formrecognizer.models.RecognizeBusinessCardsOptions

public final class RecognizeBusinessCardsOptions

Options that may be passed when using recognize business card APIs on Form Recognizer client.

Constructor Summary

Constructor	Description
RecognizeBusinessCardsOptions()	Create a RecognizeBusinessCardOptions object.

Method Summary

Modifier and Type	Method and Description
FormContentType	getContentType() Get the type of the form.
FormRecognizerLocale	getLocale() Get the locale value.
List<String>	getPages() Get the custom page numbers for multi-page documents(PDF/TIFF).
boolean	isFieldElementsIncluded() Get the boolean which specifies if to include form element references in the result.
RecognizeBusinessCardsOptions	setContentType(FormContentType contentType) Set the type of the form.
RecognizeBusinessCardsOptions	setFieldElementsIncluded(boolean includeFieldElements) Set the boolean which specifies if to include form element references in the result.
RecognizeBusinessCardsOptions	setLocale(FormRecognizerLocale locale) Set the locale value.
RecognizeBusinessCardsOptions	setPages(List<String> pages) Set the custom page numbers for multi-page documents(PDF/TIFF).

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RecognizeBusinessCardsOptions

public RecognizeBusinessCardsOptions()

Create a RecognizeBusinessCardOptions object.

Method Details

getContentType

public FormContentType getContentType()

Get the type of the form. Supported Media types including .pdf, .jpg, .png or .tiff type file stream.

Returns:

the contentType value.

getLocale

public FormRecognizerLocale getLocale()

Get the locale value. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US.

Returns:

the locale value.

getPages

public List getPages()

Get the custom page numbers for multi-page documents(PDF/TIFF). Input the number of the pages you want to get the recognized result for.

For a range of pages, use a hyphen, ex - ["1-3"]. Separate each page or a page range with a comma, ex - ["1-3", 4].

Returns:

the list of custom page numbers for a multi page document.

isFieldElementsIncluded

public boolean isFieldElementsIncluded()

Get the boolean which specifies if to include form element references in the result.

Returns:

the includeFieldElements value.

setContentType

public RecognizeBusinessCardsOptions setContentType(FormContentType contentType)

Set the type of the form. Supported Media types including .pdf, .jpg, .png or .tiff type file stream.

Parameters:

contentType - the provided form content type.

Returns:

the updated RecognizeBusinessCardOptions value.

setFieldElementsIncluded

public RecognizeBusinessCardsOptions setFieldElementsIncluded(boolean includeFieldElements)

Set the boolean which specifies if to include form element references in the result.

Parameters:

includeFieldElements - the boolean to specify if to include form element references in the result.

Returns:

the updated RecognizeBusinessCardOptions value.

setLocale

public RecognizeBusinessCardsOptions setLocale(FormRecognizerLocale locale)

Set the locale value. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US.

Parameters:

locale - the locale value to set.

Returns:

the locale value.

setPages

public RecognizeBusinessCardsOptions setPages(List pages)

Set the custom page numbers for multi-page documents(PDF/TIFF). Input the number of the pages you want to get the recognized result for.

For a range of pages, use a hyphen, ex - ["1-3"]. Separate each page or a page range with a comma, ex - ["1-3", 4].

Parameters:

pages - the custom page numbers value to set.

Returns:

the updated RecognizeBusinessCardsOptions value.