RecognizeContentOptions Class
- java.
lang. Object - com.
azure. ai. formrecognizer. models. RecognizeContentOptions
- com.
public final class RecognizeContentOptions
Options that may be passed when using recognize content APIs on Form Recognizer client.
Constructor Summary
Constructor | Description |
---|---|
RecognizeContentOptions() |
Create a |
Method Summary
Modifier and Type | Method and Description |
---|---|
Form |
getContentType()
Get the type of the form. |
Form |
getLanguage()
Get the BCP-47 language code of the text in the document. |
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. |
Form |
getReadingOrder()
Get the order in which recognized text lines are returned. |
Recognize |
setContentType(FormContentType contentType)
Set the type of the form. |
Recognize |
setLanguage(FormRecognizerLanguage language)
Set the BCP-47 language code of the text in the document. |
Recognize |
setPages(List<String> pages)
Set the custom page numbers for multi-page documents(PDF/TIFF). |
Recognize |
setPollInterval(Duration pollInterval)
Set the duration between each poll for the operation status. |
Recognize |
setReadingOrder(FormReadingOrder readingOrder)
Specifies the order in which recognized text lines are returned. |
Methods inherited from java.lang.Object
Constructor Details
RecognizeContentOptions
public RecognizeContentOptions()
Create a RecognizeContentOptions
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:
contentType
value.getLanguage
public FormRecognizerLanguage getLanguage()
Get the BCP-47 language code of the text in the document. See supported language codes here.
Returns:
getPages
public List
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:
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:
pollInterval
value.getReadingOrder
public FormReadingOrder getReadingOrder()
Get the order in which recognized text lines are returned.
Returns:
setContentType
public RecognizeContentOptions setContentType(FormContentType contentType)
Set the type of the form. Supported Media types including .pdf, .jpg, .png or .tiff type file stream.
Parameters:
Returns:
RecognizeContentOptions
value.setLanguage
public RecognizeContentOptions setLanguage(FormRecognizerLanguage language)
Set the BCP-47 language code of the text in the document. See supported language codes here.
Parameters:
Returns:
RecognizeContentOptions
value.setPages
public RecognizeContentOptions setPages(List
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:
Returns:
RecognizeContentOptions
value.setPollInterval
public RecognizeContentOptions 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:
Returns:
RecognizeContentOptions
value.setReadingOrder
public RecognizeContentOptions setReadingOrder(FormReadingOrder readingOrder)
Specifies the order in which recognized text lines are returned. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order.
Parameters:
Returns:
RecognizeContentOptions
value.Applies to
Azure SDK for Java
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기