FormRecognizerClientExtensions.AnalyzeWithCustomModelAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.CognitiveServices.FormRecognizer

Assembly:: Microsoft.Azure.CognitiveServices.FormRecognizer.dll

Package:: Microsoft.Azure.CognitiveServices.FormRecognizer v0.8.0-preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

AnalyzeWithCustomModelAsync(IFormRecognizerClient, Guid, Stream, IList<String>, CancellationToken)	Analyze Form
AnalyzeWithCustomModelAsync(IFormRecognizerClient, Guid, Stream, String, IList<String>, CancellationToken)

AnalyzeWithCustomModelAsync(IFormRecognizerClient, Guid, Stream, IList<String>, CancellationToken)

Analyze Form

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.FormRecognizer.Models.AnalyzeResult> AnalyzeWithCustomModelAsync (this Microsoft.Azure.CognitiveServices.FormRecognizer.IFormRecognizerClient operations, Guid id, System.IO.Stream formStream, System.Collections.Generic.IList<string> keys = default, System.Threading.CancellationToken cancellationToken = default);

static member AnalyzeWithCustomModelAsync : Microsoft.Azure.CognitiveServices.FormRecognizer.IFormRecognizerClient * Guid * System.IO.Stream * System.Collections.Generic.IList<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.FormRecognizer.Models.AnalyzeResult>

<Extension()>
Public Function AnalyzeWithCustomModelAsync (operations As IFormRecognizerClient, id As Guid, formStream As Stream, Optional keys As IList(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeResult)

Parameters

operations: IFormRecognizerClient

The operations group for this extension method.

id: Guid

Model Identifier to analyze the document with.

formStream: Stream

A pdf document or image (jpg,png) file to analyze.

keys: IList<String>

An optional list of known keys to extract the values for.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AnalyzeResult>

Remarks

The document to analyze must be of a supported content type - 'application/pdf', 'image/jpeg' or 'image/png'. The response contains not just the extracted information of the analyzed form but also information about content that was not extracted along with a reason.

Applies to

AnalyzeWithCustomModelAsync(IFormRecognizerClient, Guid, Stream, String, IList<String>, CancellationToken)

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.FormRecognizer.Models.AnalyzeResult> AnalyzeWithCustomModelAsync (this Microsoft.Azure.CognitiveServices.FormRecognizer.IFormRecognizerClient operations, Guid id, System.IO.Stream formStream, string contentType, System.Collections.Generic.IList<string> keys = default, System.Threading.CancellationToken cancellationToken = default);

static member AnalyzeWithCustomModelAsync : Microsoft.Azure.CognitiveServices.FormRecognizer.IFormRecognizerClient * Guid * System.IO.Stream * string * System.Collections.Generic.IList<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.FormRecognizer.Models.AnalyzeResult>

<Extension()>
Public Function AnalyzeWithCustomModelAsync (operations As IFormRecognizerClient, id As Guid, formStream As Stream, contentType As String, Optional keys As IList(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeResult)