FormRecognizerClient Class

Reference

Definition

Namespace:: Azure.AI.FormRecognizer

Assembly:: Azure.AI.FormRecognizer.dll

Package:: Azure.AI.FormRecognizer v4.1.0

Source:: FormRecognizerClient.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 recognize information from forms and images and extract it into structured data. It provides the ability to analyze receipts, business cards, and invoices, to recognize form content, and to extract fields from custom forms with models trained on custom form types. Note that this client can only be used with service version V2_1 or lower. In order to use later versions and their new features, see DocumentAnalysisClient.

public class FormRecognizerClient

type FormRecognizerClient = class

Public Class FormRecognizerClient

Inheritance: Object
FormRecognizerClient

Remarks

This client only supports V2_1 and older. To use a newer service version, see DocumentAnalysisClient.

Constructors

FormRecognizerClient()	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(Uri, AzureKeyCredential, FormRecognizerClientOptions)	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(Uri, AzureKeyCredential)	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(Uri, TokenCredential, FormRecognizerClientOptions)	Initializes a new instance of the FormRecognizerClient class.
FormRecognizerClient(Uri, TokenCredential)	Initializes a new instance of the FormRecognizerClient class.

Methods

StartRecognizeBusinessCards(Stream, RecognizeBusinessCardsOptions, CancellationToken)	Recognizes values from one or more business cards. See business card fields for a list of available fields on a business card.
StartRecognizeBusinessCardsAsync(Stream, RecognizeBusinessCardsOptions, CancellationToken)	Recognizes values from one or more business cards. See business card fields for a list of available fields on a business card.
StartRecognizeBusinessCardsFromUri(Uri, RecognizeBusinessCardsOptions, CancellationToken)	Recognizes values from one or more business cards. See business card fields for a list of available fields on a business card.
StartRecognizeBusinessCardsFromUriAsync(Uri, RecognizeBusinessCardsOptions, CancellationToken)	Recognizes values from one or more business cards. See business card fields for a list of available fields on a business card.
StartRecognizeContent(Stream, RecognizeContentOptions, CancellationToken)	Recognizes layout elements from one or more passed-in forms.
StartRecognizeContentAsync(Stream, RecognizeContentOptions, CancellationToken)	Recognizes layout elements from one or more passed-in forms.
StartRecognizeContentFromUri(Uri, RecognizeContentOptions, CancellationToken)	Recognizes layout elements from one or more passed-in forms.
StartRecognizeContentFromUriAsync(Uri, RecognizeContentOptions, CancellationToken)	Recognizes layout elements from one or more passed-in forms.
StartRecognizeCustomForms(String, Stream, RecognizeCustomFormsOptions, CancellationToken)	Recognizes pages from one or more forms, using a model trained with custom forms.
StartRecognizeCustomFormsAsync(String, Stream, RecognizeCustomFormsOptions, CancellationToken)	Recognizes pages from one or more forms, using a model trained with custom forms.
StartRecognizeCustomFormsFromUri(String, Uri, RecognizeCustomFormsOptions, CancellationToken)	Recognizes pages from one or more forms, using a model trained with custom forms.
StartRecognizeCustomFormsFromUriAsync(String, Uri, RecognizeCustomFormsOptions, CancellationToken)	Recognizes pages from one or more forms, using a model trained with custom forms.
StartRecognizeIdentityDocuments(Stream, RecognizeIdentityDocumentsOptions, CancellationToken)	Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents to extract key information from passports and US driver licenses. See identity document fields for a list of available fields on an identity document.
StartRecognizeIdentityDocumentsAsync(Stream, RecognizeIdentityDocumentsOptions, CancellationToken)	Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents to extract key information from passports and US driver licenses. See identity document fields for a list of available fields on an identity document.
StartRecognizeIdentityDocumentsFromUri(Uri, RecognizeIdentityDocumentsOptions, CancellationToken)	Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents to extract key information from passports and US driver licenses. See identity document fields for a list of available fields on an identity document.
StartRecognizeIdentityDocumentsFromUriAsync(Uri, RecognizeIdentityDocumentsOptions, CancellationToken)	Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents to extract key information from passports and US driver licenses. See identity document fields for a list of available fields on an identity document.
StartRecognizeInvoices(Stream, RecognizeInvoicesOptions, CancellationToken)	Recognizes values from one or more invoices. See invoice fields for a list of available fields on an invoice.
StartRecognizeInvoicesAsync(Stream, RecognizeInvoicesOptions, CancellationToken)	Recognizes values from one or more invoices. See invoice fields for a list of available fields on an invoice.
StartRecognizeInvoicesFromUri(Uri, RecognizeInvoicesOptions, CancellationToken)	Recognizes values from one or more invoices. See invoice fields for a list of available fields on an invoice.
StartRecognizeInvoicesFromUriAsync(Uri, RecognizeInvoicesOptions, CancellationToken)	Recognizes values from one or more invoices. See invoice fields for a list of available fields on an invoice.
StartRecognizeReceipts(Stream, RecognizeReceiptsOptions, CancellationToken)	Recognizes values from one or more receipts. See receipt fields for a list of available fields on a receipt.
StartRecognizeReceiptsAsync(Stream, RecognizeReceiptsOptions, CancellationToken)	Recognizes values from one or more receipts. See receipt fields for a list of available fields on a receipt.
StartRecognizeReceiptsFromUri(Uri, RecognizeReceiptsOptions, CancellationToken)	Recognizes values from one or more receipts. See receipt fields for a list of available fields on a receipt.
StartRecognizeReceiptsFromUriAsync(Uri, RecognizeReceiptsOptions, CancellationToken)	Recognizes values from one or more receipts. See receipt fields for a list of available fields on a receipt.

Applies to

共用方式為