Package com.azure.ai.formrecognizer.documentanalysis.models

Class AnalyzeDocumentOptions

java.lang.Object
com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions
public final class AnalyzeDocumentOptions extends Object
The configurable options to be passed when using analyze document API on Document Analysis client.

  • Constructor Details

    • AnalyzeDocumentOptions

      public AnalyzeDocumentOptions()

  • Method Details

    • getPages

      public List<String> 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.

    • setPages

      public AnalyzeDocumentOptions setPages(List<String> 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.

    • 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.

    • 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.

    • getDocumentAnalysisFeatures

      public List<DocumentAnalysisFeature> getDocumentAnalysisFeatures()
      Get the list of optional analysis features.
      Returns:
      List of optional analysis features.

    • setDocumentAnalysisFeatures

      public AnalyzeDocumentOptions setDocumentAnalysisFeatures(List<DocumentAnalysisFeature> documentAnalysisFeatures)
      Set the list of optional analysis features.
      Parameters:
      documentAnalysisFeatures - List of optional analysis features.
      Returns:
      the updated AnalyzeDocumentOptions value.

    • setDocumentAnalysisFeatures

      public AnalyzeDocumentOptions setDocumentAnalysisFeatures(DocumentAnalysisFeature... documentAnalysisFeatures)
      Set optional analysis features.
      Parameters:
      documentAnalysisFeatures - List of optional analysis features.
      Returns:
      the updated AnalyzeDocumentOptions value.