RecognizeIdentityDocumentOptions Class

Package:

com.azure.ai.formrecognizer.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.5

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

public final class RecognizeIdentityDocumentOptions

Options that may be passed when using recognize identity documents APIs on Form Recognizer client.

Constructor Summary

Constructor	Description
RecognizeIdentityDocumentOptions()	Create a RecognizeIdentityDocumentOptions object.

Method Summary

Modifier and Type	Method and Description
FormContentType	getContentType() Get the type of the form.
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.
RecognizeIdentityDocumentOptions	setContentType(FormContentType contentType) Set the type of the form.
RecognizeIdentityDocumentOptions	setFieldElementsIncluded(boolean includeFieldElements) Set the boolean which specifies if to include form element references in the result.
RecognizeIdentityDocumentOptions	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

RecognizeIdentityDocumentOptions

public RecognizeIdentityDocumentOptions()

Create a RecognizeIdentityDocumentOptions object.

Method Details

getContentType

public FormContentType getContentType()

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

Returns:

the contentType 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 RecognizeIdentityDocumentOptions setContentType(FormContentType contentType)

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

Parameters:

contentType - the provided form content type.

Returns:

the updated RecognizeIdentityDocumentOptions value.

setFieldElementsIncluded

public RecognizeIdentityDocumentOptions 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 RecognizeIdentityDocumentOptions value.

setPages

public RecognizeIdentityDocumentOptions 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 RecognizeIdentityDocumentOptions value.