RecognizeCustomFormsOptions クラス

パッケージ:

com.azure.ai.formrecognizer.models

Maven 成果物:

com.azure:azure-ai-formrecognizer:4.1.5

• java.lang.Object
• • com.azure.ai.formrecognizer.models.RecognizeCustomFormsOptions

public final class RecognizeCustomFormsOptions

クライアントでカスタム フォーム API の認識を使用するときに渡される可能性があるオプションForm Recognizer。

コンストラクターの概要

コンストラクター	説明
RecognizeCustomFormsOptions()	RecognizeCustomFormsOptions オブジェクトを作成します。

メソッドの概要

修飾子と型	メソッドと説明
FormContentType	getContentType() フォームの型を取得します。
List<String>	getPages() 複数ページのドキュメントのカスタム ページ番号を取得します (PDF/TIFF)。
Duration	getPollInterval() 操作の状態の各ポーリング間の期間を取得します。
boolean	isFieldElementsIncluded() 結果にフォーム要素参照を含めるかどうかを指定するブール値を取得します。
RecognizeCustomFormsOptions	setContentType(FormContentType contentType) フォームの種類を設定します。
RecognizeCustomFormsOptions	setFieldElementsIncluded(boolean includeFieldElements) 結果にフォーム要素参照を含めるかどうかを指定するブール値を設定します。
RecognizeCustomFormsOptions	setPages(List<String> pages) 複数ページのドキュメントのカスタム ページ番号を設定します (PDF/TIFF)。
RecognizeCustomFormsOptions	setPollInterval(Duration pollInterval) 操作の状態の各ポーリング間の期間を設定します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

RecognizeCustomFormsOptions

public RecognizeCustomFormsOptions()

RecognizeCustomFormsOptions オブジェクトを作成します。

メソッドの詳細

getContentType

public FormContentType getContentType()

フォームの型を取得します。 .pdf、.jpg、.png、.tiff、.bmp の種類のファイル ストリームなど、サポートされているメディアの種類。

Returns:

値。contentType

getPages

public List getPages()

複数ページのドキュメントのカスタム ページ番号を取得します (PDF/TIFF)。 認識された結果を取得するページの数を入力します。

ページの範囲には、ハイフン (例: ["1-3"]) を使用します。 各ページまたはページ範囲をコンマ (例: ["1-3", 4] で区切ります。

Returns:

マルチページ ドキュメントのカスタム ページ番号の一覧。

getPollInterval

public Duration getPollInterval()

操作の状態の各ポーリング間の期間を取得します。 何も指定しない場合は、既定値の 5 秒が使用されます。

Returns:

値。pollInterval

isFieldElementsIncluded

public boolean isFieldElementsIncluded()

結果にフォーム要素参照を含めるかどうかを指定するブール値を取得します。

Returns:

値。includeFieldElements

setContentType

public RecognizeCustomFormsOptions setContentType(FormContentType contentType)

フォームの種類を設定します。 .pdf、.jpg、.png、.tiff、.bmp の種類のファイル ストリームなど、サポートされているメディアの種類。

Parameters:

contentType - 指定されたフォーム コンテンツ タイプ。

Returns:

更新 RecognizeCustomFormsOptions された値。

setFieldElementsIncluded

public RecognizeCustomFormsOptions setFieldElementsIncluded(boolean includeFieldElements)

結果にフォーム要素参照を含めるかどうかを指定するブール値を設定します。

Parameters:

includeFieldElements - 結果にフォーム要素参照を含めるかどうかを指定するブール値。

Returns:

更新 RecognizeCustomFormsOptions された値。

setPages

public RecognizeCustomFormsOptions setPages(List pages)

複数ページのドキュメントのカスタム ページ番号を設定します (PDF/TIFF)。 認識された結果を取得するページの数を入力します。

ページの範囲には、ハイフン (例: ["1-3"]) を使用します。 各ページまたはページ範囲をコンマ (例: ["1-3", 4] で区切ります。

Parameters:

pages - 設定するカスタム ページ番号の値。

Returns:

更新 RecognizeCustomFormsOptions された値。

setPollInterval

public RecognizeCustomFormsOptions setPollInterval(Duration pollInterval)

操作の状態の各ポーリング間の期間を設定します。 何も指定しない場合は、既定値の 5 秒が使用されます。

Parameters:

pollInterval - 操作の状態の各ポーリング間で指定する期間。

Returns:

更新 RecognizeCustomFormsOptions された値。