Share via

RecognizeInvoicesOptions Class

Package:
com.azure.ai.formrecognizer.models
Maven Artifact:
com.azure:azure-ai-formrecognizer:4.1.13
  • java.lang.Object
    • com.azure.ai.formrecognizer.models.RecognizeInvoicesOptions

public final class RecognizeInvoicesOptions

Options that may be passed when using recognize invoice APIs on Form Recognizer client.

Constructor Summary

Constructor Description
RecognizeInvoicesOptions()

Create a RecognizeInvoicesOptions object.

Method Summary

Modifier and Type Method and Description
FormContentType getContentType()

Get the type of the form.
FormRecognizerLocale getLocale()

Get the locale information for the invoice.
List<String> getPages()

Get the custom page numbers for multi-page documents(PDF/TIFF).
boolean isFieldElementsIncluded()

Get the boolean which specifies if to include form element references in the result.
RecognizeInvoicesOptions setContentType(FormContentType contentType)

Set the type of the form.
RecognizeInvoicesOptions setFieldElementsIncluded(boolean includeFieldElements)

Set the boolean which specifies if to include form element references in the result.
RecognizeInvoicesOptions setLocale(FormRecognizerLocale locale)

Set the locale information for the invoice.
RecognizeInvoicesOptions setPages(List<String> pages)

Set the custom page numbers for multi-page documents(PDF/TIFF).

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RecognizeInvoicesOptions

public RecognizeInvoicesOptions()

Create a RecognizeInvoicesOptions object.

Method Details

getContentType

public FormContentType getContentType()

Get the type of the form. Supported Media types including .pdf, .jpg, .png or .tiff type file stream.

Returns:

the contentType value.

getLocale

public FormRecognizerLocale getLocale()

Get the locale information for the invoice. Supported locales include: en-US.

Returns:

the locale value.

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.

isFieldElementsIncluded

public boolean isFieldElementsIncluded()

Get the boolean which specifies if to include form element references in the result.

Returns:

the includeFieldElements value.

setContentType

public RecognizeInvoicesOptions setContentType(FormContentType contentType)

Set the type of the form. Supported Media types including .pdf, .jpg, .png or .tiff type file stream.

Parameters:

contentType - the provided form content type.

Returns:

the updated RecognizeInvoicesOptions value.

setFieldElementsIncluded

public RecognizeInvoicesOptions setFieldElementsIncluded(boolean includeFieldElements)

Set the boolean which specifies if to include form element references in the result.

Parameters:

includeFieldElements - the boolean to specify if to include form element references in the result.

Returns:

the updated RecognizeInvoicesOptions value.

setLocale

public RecognizeInvoicesOptions setLocale(FormRecognizerLocale locale)

Set the locale information for the invoice. Supported locales include: en-US.

Parameters:

locale - the locale value to set.

Returns:

the updated RecognizeInvoicesOptions value.

setPages

public RecognizeInvoicesOptions 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 RecognizeInvoicesOptions value.

Applies to