DocumentAnalysisClient.AnalyzeDocumentAsync メソッド

定義

名前空間:

Azure.AI.FormRecognizer.DocumentAnalysis

アセンブリ:

Azure.AI.FormRecognizer.dll

パッケージ:

Azure.AI.FormRecognizer v4.1.0

Source:

DocumentAnalysisClient.cs

カスタム ドキュメントで構築されたモデル、または Form Recognizer サービスによって提供される事前構築済みモデルのいずれかを使用して、1 つ以上のドキュメントのページを分析します。

public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation> AnalyzeDocumentAsync (Azure.WaitUntil waitUntil, string modelId, System.IO.Stream document, Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member AnalyzeDocumentAsync : Azure.WaitUntil * string * System.IO.Stream * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation>
override this.AnalyzeDocumentAsync : Azure.WaitUntil * string * System.IO.Stream * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation>

Public Overridable Function AnalyzeDocumentAsync (waitUntil As WaitUntil, modelId As String, document As Stream, Optional options As AnalyzeDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeDocumentOperation)

パラメーター

waitUntil

WaitUntil

Completed メソッドがサービスで実行時間の長い操作が完了するまで戻るのを待機する必要がある場合。 Started 操作を開始した後に が返される場合は 。

modelId

String

入力ドキュメントの分析に使用するモデルの ID。 カスタム構築モデルを分析に使用する場合、このパラメーターは作成時にモデルに属性付けされた ID である必要があります。 サービスの事前構築済みモデルのいずれかを使用する場合は、サポートされている事前構築済みモデル ID の 1 つを渡す必要があります。 事前構築済みのモデル ID は、 にあります https://aka.ms/azsdk/formrecognizer/models。

document

Stream

分析する 1 つ以上のドキュメントを含むストリーム。

options

AnalyzeDocumentOptions

分析要求を構成するために使用できる一連のオプション。 たとえば、ドキュメントのロケール、または分析するページを指定します。

cancellationToken

CancellationToken

CancellationToken要求の有効期間を制御する 。

戻り値

Task<AnalyzeDocumentOperation>

AnalyzeDocumentOperationこの実行時間の長い操作を待機する 。 Value正常に完了すると、入力ドキュメントの分析されたページが含まれます。