Package com.azure.ai.documentintelligence.models

Class AnalyzeBatchDocumentsOptions

java.lang.Object
com.azure.ai.documentintelligence.models.AnalyzeBatchDocumentsOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<AnalyzeBatchDocumentsOptions>
public final class AnalyzeBatchDocumentsOptions extends Object implements com.azure.json.JsonSerializable<AnalyzeBatchDocumentsOptions>
Batch document analysis parameters.

  • Constructor Details

    • AnalyzeBatchDocumentsOptions

      public AnalyzeBatchDocumentsOptions(AzureBlobContentSource azureBlobSource, String resultContainerUrl)
      Creates an instance of AnalyzeBatchDocumentsOptions with the specified Azure Blob source and result container URL.
      Parameters:
      azureBlobSource - the Azure Blob Storage location containing the batch documents. Cannot be null.
      resultContainerUrl - the Azure Blob Storage container URL where analyze result files will be stored. Cannot be null.

    • AnalyzeBatchDocumentsOptions

      public AnalyzeBatchDocumentsOptions(AzureBlobFileListContentSource azureBlobFileListSource, String resultContainerUrl)
      Creates an instance of AnalyzeBatchDocumentsOptions with the specified result container URL and Azure Blob file list source.
      Parameters:
      azureBlobFileListSource - the Azure Blob Storage file list specifying the batch documents. Cannot be null.
      resultContainerUrl - the Azure Blob Storage container URL where analyze result files will be stored. Cannot be null.

  • Method Details

    • getAzureBlobSource

      public AzureBlobContentSource getAzureBlobSource()
      Get the azureBlobSource property: Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
      Returns:
      the azureBlobSource value.

    • getAzureBlobFileListSource

      public AzureBlobFileListContentSource getAzureBlobFileListSource()
      Get the azureBlobFileListSource property: Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
      Returns:
      the azureBlobFileListSource value.

    • getResultContainerUrl

      public String getResultContainerUrl()
      Get the resultContainerUrl property: Azure Blob Storage container URL where analyze result files will be stored.
      Returns:
      the resultContainerUrl value.

    • getResultPrefix

      public String getResultPrefix()
      Get the resultPrefix property: Blob name prefix of result files.
      Returns:
      the resultPrefix value.

    • setResultPrefix

      public AnalyzeBatchDocumentsOptions setResultPrefix(String resultPrefix)
      Set the resultPrefix property: Blob name prefix of result files.
      Parameters:
      resultPrefix - the resultPrefix value to set.
      Returns:
      the AnalyzeBatchDocumentsOptions object itself.

    • isOverwriteExisting

      public Boolean isOverwriteExisting()
      Get the overwriteExisting property: Overwrite existing analyze result files?.
      Returns:
      the overwriteExisting value.

    • setOverwriteExisting

      public AnalyzeBatchDocumentsOptions setOverwriteExisting(Boolean overwriteExisting)
      Set the overwriteExisting property: Overwrite existing analyze result files?.
      Parameters:
      overwriteExisting - the overwriteExisting value to set.
      Returns:
      the AnalyzeBatchDocumentsOptions object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AnalyzeBatchDocumentsOptions>
      Throws:
      IOException

    • fromJson

      public static AnalyzeBatchDocumentsOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AnalyzeBatchDocumentsOptions from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AnalyzeBatchDocumentsOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AnalyzeBatchDocumentsOptions.

    • getQueryFields

      public List<String> getQueryFields()
      Gets the list of additional fields to include in the result.
      Returns:
      the list of additional fields to include in the result.

    • setQueryFields

      public AnalyzeBatchDocumentsOptions setQueryFields(List<String> queryFields)
      Sets the list of additional fields to include in the result.
      Parameters:
      queryFields - the list of additional fields to include in the result.
      Returns:
      the updated AnalyzeBatchDocumentsOptions value.

    • getOutputContentFormat

      public DocumentContentFormat getOutputContentFormat()
      Gets the output content format.
      Returns:
      the output content format.

    • setOutputContentFormat

      public AnalyzeBatchDocumentsOptions setOutputContentFormat(DocumentContentFormat outputContentFormat)
      Sets the output content format.
      Parameters:
      outputContentFormat - the output content format to set.
      Returns:
      the updated AnalyzeBatchDocumentsOptions value.

    • getOutput

      public List<AnalyzeOutputFormat> getOutput()
      Gets the list of output formats.
      Returns:
      the list of output formats.

    • setOutput

      public AnalyzeBatchDocumentsOptions setOutput(List<AnalyzeOutputFormat> output)
      Sets the list of output formats.
      Parameters:
      output - the list of output formats to set.
      Returns:
      the updated AnalyzeBatchDocumentsOptions value.

    • getStringIndexType

      public StringIndexType getStringIndexType()
      Gets the string index type.
      Returns:
      the string index type.

    • setStringIndexType

      public AnalyzeBatchDocumentsOptions setStringIndexType(StringIndexType stringIndexType)
      Sets the string index type.
      Parameters:
      stringIndexType - the string index type to set.
      Returns:
      the updated AnalyzeBatchDocumentsOptions value.

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

    • getDocumentAnalysisFeatures

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

    • setDocumentAnalysisFeatures

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

    • setDocumentAnalysisFeatures

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