Class AnalyzeDocumentOptions
- java.lang.Object
-
- com.azure.ai.formrecognizer.models.AnalyzeDocumentOptions
-
public final class AnalyzeDocumentOptions extends Object
Options that may be passed when using analyze document API on Document Analysis client.
-
-
Constructor Summary
Constructors Constructor Description AnalyzeDocumentOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getLocale()
Get the locale value.List<String>
getPages()
Get the custom page numbers for multi-page documents(PDF/TIFF).AnalyzeDocumentOptions
setLocale(String locale)
Set the locale value.AnalyzeDocumentOptions
setPages(List<String> pages)
Set the custom page numbers for multi-page documents(PDF/TIFF).
-
-
-
Method Detail
-
getPages
public List<String> 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.
-
setPages
public AnalyzeDocumentOptions setPages(List<String> 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
RecognizeContentOptions
value.
-
getLocale
public String getLocale()
Get the locale value.- Returns:
- the locale 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 locale value.
-
-