AnalyzeBatchDocumentsOptions Class

Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.7
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.AnalyzeBatchDocumentsOptions

Implements

JsonSerializable<AnalyzeBatchDocumentsOptions>

public final class AnalyzeBatchDocumentsOptions
implements JsonSerializable<AnalyzeBatchDocumentsOptions>

Batch document analysis parameters.

Constructor Summary

Constructor Description
AnalyzeBatchDocumentsOptions(AzureBlobContentSource azureBlobSource, String resultContainerUrl)

Creates an instance of AnalyzeBatchDocumentsOptions with the specified Azure Blob source and result container URL.
AnalyzeBatchDocumentsOptions(AzureBlobFileListContentSource azureBlobFileListSource, String resultContainerUrl)

Creates an instance of AnalyzeBatchDocumentsOptions with the specified result container URL and Azure Blob file list source.

Method Summary

Modifier and Type Method and Description
static AnalyzeBatchDocumentsOptions fromJson(JsonReader jsonReader)

Reads an instance of AnalyzeBatchDocumentsOptions from the JsonReader.
AzureBlobFileListContentSource getAzureBlobFileListSource()

Get the azureBlobFileListSource property: Azure Blob Storage file list specifying the batch documents.
AzureBlobContentSource getAzureBlobSource()

Get the azureBlobSource property: Azure Blob Storage location containing the batch documents.
List<DocumentAnalysisFeature> getDocumentAnalysisFeatures()

Get the list of optional analysis features.
String getLocale()

Get the locale hint for text recognition and document analysis.
List<AnalyzeOutputFormat> getOutput()

Gets the list of output formats.
DocumentContentFormat getOutputContentFormat()

Gets the output content format.
List<String> getPages()

Get the custom page numbers for multipage documents(PDF/TIFF).
List<String> getQueryFields()

Gets the list of additional fields to include in the result.
String getResultContainerUrl()

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

Get the resultPrefix property: Blob name prefix of result files.
StringIndexType getStringIndexType()

Gets the string index type.
Boolean isOverwriteExisting()

Get the overwriteExisting property: Overwrite existing analyze result files?.
AnalyzeBatchDocumentsOptions setDocumentAnalysisFeatures(DocumentAnalysisFeature[] documentAnalysisFeatures)

Set optional analysis features.
AnalyzeBatchDocumentsOptions setDocumentAnalysisFeatures(List<DocumentAnalysisFeature> documentAnalysisFeatures)

Set the list of optional analysis features.
AnalyzeBatchDocumentsOptions setLocale(String locale)

Set the locale value.
AnalyzeBatchDocumentsOptions setOutput(List<AnalyzeOutputFormat> output)

Sets the list of output formats.
AnalyzeBatchDocumentsOptions setOutputContentFormat(DocumentContentFormat outputContentFormat)

Sets the output content format.
AnalyzeBatchDocumentsOptions setOverwriteExisting(Boolean overwriteExisting)

Set the overwriteExisting property: Overwrite existing analyze result files?.
AnalyzeBatchDocumentsOptions setPages(List<String> pages)

Set the custom page numbers for multipage documents(PDF/TIFF).
AnalyzeBatchDocumentsOptions setQueryFields(List<String> queryFields)

Sets the list of additional fields to include in the result.
AnalyzeBatchDocumentsOptions setResultPrefix(String resultPrefix)

Set the resultPrefix property: Blob name prefix of result files.
AnalyzeBatchDocumentsOptions setStringIndexType(StringIndexType stringIndexType)

Sets the string index type.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static AnalyzeBatchDocumentsOptions fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

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.

getDocumentAnalysisFeatures

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

getOutput

public List<AnalyzeOutputFormat> getOutput()

Gets the list of output formats.

Returns:

the list of output formats.

getOutputContentFormat

public DocumentContentFormat getOutputContentFormat()

Gets the output content format.

Returns:

the output content format.

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.

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.

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.

getStringIndexType

public StringIndexType getStringIndexType()

Gets the string index type.

Returns:

the string index type.

isOverwriteExisting

public Boolean isOverwriteExisting()

Get the overwriteExisting property: Overwrite existing analyze result files?.

Returns:

the overwriteExisting value.

setDocumentAnalysisFeatures

public AnalyzeBatchDocumentsOptions setDocumentAnalysisFeatures(DocumentAnalysisFeature[] documentAnalysisFeatures)

Set optional analysis features.

Parameters:

documentAnalysisFeatures - List of optional analysis features.

Returns:

the updated AnalyzeBatchDocumentsOptions value.

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.

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.

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.

setOutputContentFormat

public AnalyzeBatchDocumentsOptions setOutputContentFormat(DocumentContentFormat outputContentFormat)

Sets the output content format.

Parameters:

outputContentFormat - the output content format to set.

Returns:

the updated AnalyzeBatchDocumentsOptions 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.

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.

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.

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.

setStringIndexType

public AnalyzeBatchDocumentsOptions setStringIndexType(StringIndexType stringIndexType)

Sets the string index type.

Parameters:

stringIndexType - the string index type to set.

Returns:

the updated AnalyzeBatchDocumentsOptions value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to