Azure.AI.FormRecognizer.DocumentAnalysis Namespace
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.
Classes
AddressValue |
Address field value. |
AnalyzedDocument |
An object describing the location and semantic content of a document. |
AnalyzeDocumentOperation |
Tracks the status of a long-running operation for analyzing documents. |
AnalyzeDocumentOptions |
The set of options that can be specified when calling an Analyze Document method to configure the behavior of the request. For example, specify the locale of the document, or which pages to analyze. |
AnalyzeResult |
Represents one or more documents that have been analyzed by a trained or prebuilt model. |
BlobContentSource |
Azure Blob Storage content. |
BlobFileListContentSource |
File list in Azure Blob Storage. |
BuildDocumentClassifierOperation |
Tracks the status of a long-running operation for building a document classifier. |
BuildDocumentModelOperation |
Tracks the status of a long-running operation for building a custom model. |
BuildDocumentModelOptions |
The set of options that can be specified when calling the build document model method to configure the behavior of the request. For example, set the model tags a model description. |
ClassifierDocumentTypeDetails |
Classifier document type info. |
ClassifyDocumentOperation |
Tracks the status of a long-running operation for classifying documents. |
ComposeDocumentModelOperation |
Tracks the status of a long-running operation for composing a model. |
CopyDocumentModelToOperation |
Tracks the status of a long-running operation for copying a custom model into a target Form Recognizer resource. |
DocumentAnalysisClient |
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. |
DocumentAnalysisClientOptions |
The set of options that can be specified when creating a DocumentAnalysisClient or a DocumentModelAdministrationClient to configure its behavior. |
DocumentAnalysisModelFactory |
A factory that builds Azure.AI.FormRecognizer.DocumentAnalysis model types used for mocking. |
DocumentBarcode |
A barcode object. |
DocumentClassifierBuildOperationDetails |
Get Operation response object. |
DocumentClassifierDetails |
Document classifier info. |
DocumentContentSource |
The location containing data to train Document Models and Document Classifiers. Supported content sources are: |
DocumentField |
An object representing the content and location of a field value. |
DocumentFieldSchema |
Description of the field semantic schema using a JSON Schema style syntax. |
DocumentFieldValue |
Represents the value of a field analyzed from the input document and provides methods for converting it to the appropriate type. |
DocumentFormula |
A formula object. |
DocumentKeyValueElement |
An object representing the field key or value in a key-value pair. |
DocumentKeyValuePair |
An object representing a form field with distinct field label (key) and field value (may be empty). |
DocumentLanguage |
An object representing the detected language for a given text span. |
DocumentLine |
A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. |
DocumentModelAdministrationClient |
The client to use to connect with the Form Recognizer Azure Cognitive Service to build models from custom documents. It also supports listing, copying, and deleting models, creating composed models, and accessing account properties. |
DocumentModelBuildOperationDetails |
Get Operation response object. |
DocumentModelComposeOperationDetails |
Get Operation response object. |
DocumentModelCopyAuthorization |
Authorization to copy a document model to the specified target resource and modelId. |
DocumentModelCopyToOperationDetails |
Get Operation response object. |
DocumentModelDetails |
Document model info. |
DocumentModelSummary |
Document model summary. |
DocumentPage |
Content and layout elements extracted from a page from the input. |
DocumentParagraph |
A paragraph object consisting with contiguous lines generally with common alignment and spacing. |
DocumentSelectionMark |
A selection mark object representing check boxes, radio buttons, and other elements indicating a selection. |
DocumentStyle |
An object representing observed text styles. |
DocumentTable |
A table object consisting table cells arranged in a rectangular layout. |
DocumentTableCell |
An object representing the location and content of a table cell. |
DocumentTypeDetails |
Document type info. |
DocumentWord |
A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word. |
OperationDetails |
Get Operation response object. Please note OperationDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DocumentClassifierBuildOperationDetails, DocumentModelBuildOperationDetails, DocumentModelComposeOperationDetails and DocumentModelCopyToOperationDetails. |
OperationSummary |
Operation info. |
ResourceDetails |
General information regarding the current resource. |
ResourceQuotaDetails |
Quota used, limit, and next reset date/time. |
Structs
BoundingRegion |
Bounding polygon on a specific page of the input. |
CurrencyValue |
Currency field value. |
DocumentAnalysisAudience |
Cloud audiences available for FormRecognizer.DocumentAnalysis. |
DocumentAnalysisFeature |
The DocumentAnalysisFeature. |
DocumentBarcodeKind |
Barcode kind. |
DocumentBuildMode |
The technique to use to build a custom model. For more information see here. |
DocumentContentSourceKind |
Document content source kind. |
DocumentFontStyle |
Font style. |
DocumentFontWeight |
Font weight. |
DocumentFormulaKind |
Formula kind. |
DocumentOperationKind |
Type of operation. |
DocumentSignatureType |
Presence of signature. |
DocumentSpan |
Contiguous region of the concatenated content property, specified as an offset and length. |
DocumentTableCellKind |
Table cell kind. |
ParagraphRole |
Semantic role of the paragraph. |
Enums
DocumentAnalysisClientOptions.ServiceVersion |
The service version. |
DocumentFieldType |
The type of the value of a DocumentField. |
DocumentOperationStatus |
Operation status. |
DocumentPageLengthUnit |
The unit used by the width, height and bounding polygons of a DocumentPage. For images, the unit is pixel. For PDF, the unit is inch. |
DocumentSelectionMarkState |
State of a selection mark. i.e. Selected or Unselected. |
Azure SDK for .NET