AnalyzeDocumentOptions interface
ドキュメント分析操作のオプション。
- Extends
プロパティ
| features | モデルで有効にする機能の一覧。 機能を有効にすると追加のコストが発生する可能性があるため、サービスのドキュメントを参照して、機能の性質と、それらの使用に関連する追加コストを理解してください。 Form Recognizerで使用できる機能の詳細については、サービスのドキュメントを参照してください。https://aka.ms/azsdk/formrecognizer/features |
| locale | テキスト認識とドキュメント分析のためのロケール ヒント。 値には、言語と地域の両方を示す 2 文字の言語コードまたは BCP-47 言語タグのみを指定できます。 例 :
|
| pages | 分析する入力ドキュメント内のページ範囲 (1 インデックス付き) の一覧 (コンマ区切り) 例: "1"、"3-5"、"1,3-5" |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
ポーリングの状態が更新されたときに呼び出される、省略可能な初期進行状況ハンドラー。 このハンドラーは、ポーリングの状態が初期化された直後に 1 回呼び出されます。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| resume |
シリアル化されたポーリングの状態。 指定した場合、ポーリング操作は、新しい操作のように開始されるのではなく、指定された状態から再開されます。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
| update |
同じ操作に関連する後続の要求間の待機時間 (ミリ秒単位)。 |
プロパティの詳細
features
モデルで有効にする機能の一覧。 機能を有効にすると追加のコストが発生する可能性があるため、サービスのドキュメントを参照して、機能の性質と、それらの使用に関連する追加コストを理解してください。
Form Recognizerで使用できる機能の詳細については、サービスのドキュメントを参照してください。https://aka.ms/azsdk/formrecognizer/features
features?: FormRecognizerFeature[]プロパティ値
FormRecognizerFeature[]
locale
テキスト認識とドキュメント分析のためのロケール ヒント。
値には、言語と地域の両方を示す 2 文字の言語コードまたは BCP-47 言語タグのみを指定できます。
例 :
- "en-US" (米国英語)
- "fr" (フランス語 - リージョンなし)
locale?: stringプロパティ値
string
pages
分析する入力ドキュメント内のページ範囲 (1 インデックス付き) の一覧 (コンマ区切り)
例: "1"、"3-5"、"1,3-5"
pages?: stringプロパティ値
string
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
onProgress
ポーリングの状態が更新されたときに呼び出される、省略可能な初期進行状況ハンドラー。 このハンドラーは、ポーリングの状態が初期化された直後に 1 回呼び出されます。
onProgress?: (state: DocumentAnalysisPollOperationState<Result>) => voidプロパティ値
(state: DocumentAnalysisPollOperationState<Result>) => void
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
resumeFrom
シリアル化されたポーリングの状態。 指定した場合、ポーリング操作は、新しい操作のように開始されるのではなく、指定された状態から再開されます。
resumeFrom?: stringプロパティ値
string
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptionsプロパティ値
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
updateIntervalInMs
同じ操作に関連する後続の要求間の待機時間 (ミリ秒単位)。
updateIntervalInMs?: numberプロパティ値
number