FormRecognizerClient Class

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 class FormRecognizerClient : Microsoft.Rest.ServiceClient<Microsoft.Azure.CognitiveServices.FormRecognizer.FormRecognizerClient>, IDisposable, Microsoft.Azure.CognitiveServices.FormRecognizer.IFormRecognizerClient

type FormRecognizerClient = class
    inherit ServiceClient<FormRecognizerClient>
    interface IFormRecognizerClient
    interface IDisposable

Public Class FormRecognizerClient
Inherits ServiceClient(Of FormRecognizerClient)
Implements IDisposable, IFormRecognizerClient

Inheritance

Object

ServiceClient<FormRecognizerClient>

FormRecognizerClient

Implements

IFormRecognizerClient IDisposable

Constructors

FormRecognizerClient(DelegatingHandler[])	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(HttpClient, Boolean)	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(ServiceClientCredentials, DelegatingHandler[])	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(ServiceClientCredentials, HttpClient, Boolean)	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the FormRecognizerClient class.

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).
FirstMessageHandler	(Inherited from ServiceClient<T>)
HttpClient	(Inherited from ServiceClient<T>)
HttpClientHandler	(Inherited from ServiceClient<T>)
HttpMessageHandlers	(Inherited from ServiceClient<T>)
SerializationSettings	Gets or sets json serialization settings.
UserAgent	(Inherited from ServiceClient<T>)

Methods

AnalyzeWithCustomModelWithHttpMessagesAsync(Guid, Stream, IList<String>, Dictionary<String,List<String>>, CancellationToken)	Analyze Form
AnalyzeWithCustomModelWithHttpMessagesAsync2(Guid, Stream, IList<String>, Dictionary<String,List<String>>, CancellationToken, String)
CreateHttpHandlerPipeline(HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
DeleteCustomModelWithHttpMessagesAsync(Guid, Dictionary<String,List<String>>, CancellationToken)	Delete Model
Dispose()	(Inherited from ServiceClient<T>)
Dispose(Boolean)	(Inherited from ServiceClient<T>)
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
InitializeHttpClient(HttpClient, HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
InitializeHttpClient(HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
SetRetryPolicy(RetryPolicy)	(Inherited from ServiceClient<T>)
SetUserAgent(String, String)	(Inherited from ServiceClient<T>)
SetUserAgent(String)	(Inherited from ServiceClient<T>)
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