com.azure.ai.formrecognizer.models

Class RecognizeReceiptsOptions

java.lang.Object

com.azure.ai.formrecognizer.models.RecognizeReceiptsOptions

public final class RecognizeReceiptsOptions
extends Object

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

Constructor Summary

Constructors

Constructor and Description
RecognizeReceiptsOptions()

Method Summary

Modifier and Type	Method and Description
FormContentType	getContentType() Get the type of the form.
FormRecognizerLocale	getLocale() Get the locale information for the receipt.
List<String>	getPages() Get the custom page numbers for multi-page documents(PDF/TIFF).
Duration	getPollInterval() Get the duration between each poll for the operation status.
boolean	isFieldElementsIncluded() Get the boolean which specifies if to include form element references in the result.
RecognizeReceiptsOptions	setContentType(FormContentType contentType) Set the type of the form.
RecognizeReceiptsOptions	setFieldElementsIncluded(boolean includeFieldElements) Set the boolean which specifies if to include form element references in the result.
RecognizeReceiptsOptions	setLocale(FormRecognizerLocale locale) Set the locale information for the receipt.
RecognizeReceiptsOptions	setPages(List<String> pages) Set the custom page numbers for multi-page documents(PDF/TIFF).
RecognizeReceiptsOptions	setPollInterval(Duration pollInterval) Set the duration between each poll for the operation status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecognizeReceiptsOptions

public RecognizeReceiptsOptions()

Method Detail

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.

isFieldElementsIncluded

public boolean isFieldElementsIncluded()

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

Returns:

the includeFieldElements value.

getPollInterval

public Duration getPollInterval()

Get the duration between each poll for the operation status. If none is specified, a default of 5 seconds is used.

Returns:

the pollInterval value.

setContentType

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

setFieldElementsIncluded

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

setPollInterval

public RecognizeReceiptsOptions setPollInterval(Duration pollInterval)

Set the duration between each poll for the operation status. If none is specified, a default of 5 seconds is used.

Parameters:

pollInterval - the duration to specify between each poll for the operation status.

Returns:

the updated RecognizeReceiptsOptions value.

getLocale

public FormRecognizerLocale getLocale()

Get the locale information for the receipt. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US.

Returns:

the locale value.

setLocale

public RecognizeReceiptsOptions setLocale(FormRecognizerLocale locale)

Set the locale information for the receipt. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US.

Parameters:

locale - the locale value to set.

Returns:

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

setPages

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