DocumentAnalysisClient Class

Reference

Definition

Namespace:: Azure.AI.FormRecognizer.DocumentAnalysis

Assembly:: Azure.AI.FormRecognizer.dll

Package:: Azure.AI.FormRecognizer v4.1.0

Source:: DocumentAnalysisClient.cs

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.

The client to use to connect to the Form Recognizer Azure Cognitive Service to analyze information from documents and images and extract it into structured data. It provides the ability to use prebuilt models to analyze receipts, business cards, invoices, to extract document content, and more. It's also possible to extract fields from custom documents with models built on custom document types.

public class DocumentAnalysisClient

type DocumentAnalysisClient = class

Public Class DocumentAnalysisClient

Inheritance: Object
DocumentAnalysisClient

Remarks

This client only supports V2022_08_31 and newer. To use an older service version, see FormRecognizerClient.

Constructors

DocumentAnalysisClient()	Initializes a new instance of the DocumentAnalysisClient class.
DocumentAnalysisClient(Uri, AzureKeyCredential)	Initializes a new instance of the DocumentAnalysisClient class.
DocumentAnalysisClient(Uri, AzureKeyCredential, DocumentAnalysisClientOptions)	Initializes a new instance of the DocumentAnalysisClient class.
DocumentAnalysisClient(Uri, TokenCredential)	Initializes a new instance of the DocumentAnalysisClient class.
DocumentAnalysisClient(Uri, TokenCredential, DocumentAnalysisClientOptions)	Initializes a new instance of the DocumentAnalysisClient class.

Methods

AnalyzeDocument(WaitUntil, String, Stream, AnalyzeDocumentOptions, CancellationToken)	Analyzes pages from one or more documents, using a model built with custom documents or one of the prebuilt models provided by the Form Recognizer service.
AnalyzeDocumentAsync(WaitUntil, String, Stream, AnalyzeDocumentOptions, CancellationToken)	Analyzes pages from one or more documents, using a model built with custom documents or one of the prebuilt models provided by the Form Recognizer service.
AnalyzeDocumentFromUri(WaitUntil, String, Uri, AnalyzeDocumentOptions, CancellationToken)	Analyzes pages from one or more documents, using a model built with custom documents or one of the prebuilt models provided by the Form Recognizer service.
AnalyzeDocumentFromUriAsync(WaitUntil, String, Uri, AnalyzeDocumentOptions, CancellationToken)	Analyzes pages from one or more documents, using a model built with custom documents or one of the prebuilt models provided by the Form Recognizer service.
ClassifyDocument(WaitUntil, String, Stream, CancellationToken)	Classifies one or more documents using a document classifier built with custom documents.
ClassifyDocumentAsync(WaitUntil, String, Stream, CancellationToken)	Classifies one or more documents using a document classifier built with custom documents.
ClassifyDocumentFromUri(WaitUntil, String, Uri, CancellationToken)	Classifies one or more documents using a document classifier built with custom documents.
ClassifyDocumentFromUriAsync(WaitUntil, String, Uri, CancellationToken)	Classifies one or more documents using a document classifier built with custom documents.

Applies to