AnalyzeDocumentOptions Class

Package:

com.azure.ai.formrecognizer.documentanalysis.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.12

• java.lang.Object
• • com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions

public final class AnalyzeDocumentOptions

The configurable options to be passed when using analyze document API on Document Analysis client.

Constructor Summary

Constructor	Description
AnalyzeDocumentOptions()	Creates a new instance of AnalyzeDocumentOptions.

Method Summary

Modifier and Type	Method and Description
List<DocumentAnalysisFeature>	getDocumentAnalysisFeatures() Get the list of optional analysis features.
String	getLocale() Get the locale hint for text recognition and document analysis.
List<String>	getPages() Get the custom page numbers for multipage documents(PDF/TIFF).
AnalyzeDocumentOptions	setDocumentAnalysisFeatures(DocumentAnalysisFeature[] documentAnalysisFeatures) Set optional analysis features.
AnalyzeDocumentOptions	setDocumentAnalysisFeatures(List<DocumentAnalysisFeature> documentAnalysisFeatures) Set the list of optional analysis features.
AnalyzeDocumentOptions	setLocale(String locale) Set the locale value.
AnalyzeDocumentOptions	setPages(List<String> pages) Set the custom page numbers for multipage documents(PDF/TIFF).

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AnalyzeDocumentOptions

public AnalyzeDocumentOptions()

Creates a new instance of AnalyzeDocumentOptions.

Method Details

getDocumentAnalysisFeatures

public List getDocumentAnalysisFeatures()

Get the list of optional analysis features.

Returns:

List of optional analysis features.

getLocale

public String getLocale()

Get the locale hint for text recognition and document analysis. Value may contain only the language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"en-US\").

Returns:

the locale value.

getPages

public List getPages()

Get the custom page numbers for multipage 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 multipage document.

setDocumentAnalysisFeatures

public AnalyzeDocumentOptions setDocumentAnalysisFeatures(DocumentAnalysisFeature[] documentAnalysisFeatures)

Set optional analysis features.

Parameters:

documentAnalysisFeatures - List of optional analysis features.

Returns:

the updated AnalyzeDocumentOptions value.

setDocumentAnalysisFeatures

public AnalyzeDocumentOptions setDocumentAnalysisFeatures(List documentAnalysisFeatures)

Set the list of optional analysis features.

Parameters:

documentAnalysisFeatures - List of optional analysis features.

Returns:

the updated AnalyzeDocumentOptions value.

setLocale

public AnalyzeDocumentOptions setLocale(String 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 updated AnalyzeDocumentOptions value.

setPages

public AnalyzeDocumentOptions setPages(List pages)

Set the custom page numbers for multipage 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 AnalyzeDocumentOptions value.