IFormRecognizerClient Interface

Definition

Namespace:

Microsoft.Azure.CognitiveServices.FormRecognizer

Assembly:

Microsoft.Azure.CognitiveServices.FormRecognizer.dll

Package:

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

Extracts information from forms and images into structured data based on a model created by a set of representative training forms.

public interface IFormRecognizerClient : IDisposable

type IFormRecognizerClient = interface
    interface IDisposable

Public Interface IFormRecognizerClient
Implements IDisposable

Derived

Microsoft.Azure.CognitiveServices.FormRecognizer.FormRecognizerClient

Implements

IDisposable

Properties

Credentials	Subscription credentials which uniquely identify client subscription.
DeserializationSettings	Gets or sets json deserialization settings.
Endpoint	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).
SerializationSettings	The base URI of the service.

Methods

AnalyzeWithCustomModelWithHttpMessagesAsync(Guid, Stream, IList<String>, Dictionary<String,List<String>>, CancellationToken)	Analyze Form
AnalyzeWithCustomModelWithHttpMessagesAsync2(Guid, Stream, IList<String>, Dictionary<String,List<String>>, CancellationToken, String)
DeleteCustomModelWithHttpMessagesAsync(Guid, Dictionary<String,List<String>>, CancellationToken)	Delete Model
GetCustomModelsWithHttpMessagesAsync(Dictionary<String,List<String>>, CancellationToken)	Get Models
GetCustomModelWithHttpMessagesAsync(Guid, Dictionary<String,List<String>>, CancellationToken)	Get Model
GetExtractedKeysWithHttpMessagesAsync(Guid, Dictionary<String,List<String>>, CancellationToken)	Get Keys
TrainCustomModelWithHttpMessagesAsync(TrainRequest, Dictionary<String,List<String>>, CancellationToken)	Train Model

Extension Methods

AnalyzeWithCustomModelAsync(IFormRecognizerClient, Guid, Stream, IList<String>, CancellationToken)	Analyze Form
AnalyzeWithCustomModelAsync(IFormRecognizerClient, Guid, Stream, String, IList<String>, CancellationToken)
DeleteCustomModelAsync(IFormRecognizerClient, Guid, CancellationToken)	Delete Model
GetCustomModelAsync(IFormRecognizerClient, Guid, CancellationToken)	Get Model
GetCustomModelsAsync(IFormRecognizerClient, CancellationToken)	Get Models
GetExtractedKeysAsync(IFormRecognizerClient, Guid, CancellationToken)	Get Keys
TrainCustomModelAsync(IFormRecognizerClient, TrainRequest, CancellationToken)	Train Model