Azure.AI.DocumentIntelligence Namespace

Classes

AddressValue

Address field value.

AnalyzeBatchDocumentsContent

Batch document analysis parameters.

AnalyzeBatchOperationDetail

Operation detail for a document in a batch analysis.

AnalyzeBatchResult

Batch document analysis result.

AnalyzedDocument

An object describing the location and semantic content of a document.

AnalyzeDocumentContent

Document analysis parameters.

AnalyzeResult

Document analysis result.

AuthorizeClassifierCopyContent

Request body to authorize document classifier copy.

AuthorizeCopyContent

Request body to authorize document model copy.

AzureBlobContentSource

Azure Blob Storage content.

AzureBlobFileListContentSource

File list in Azure Blob Storage.

BoundingRegion

Bounding polygon on a specific page of the input.

BuildDocumentClassifierContent

Request body to build a new custom document classifier.

BuildDocumentModelContent

Request body to build a new custom document model.

ClassifierCopyAuthorization

Authorization to copy a document classifier to the specified target resource and classifierId.

ClassifierDocumentTypeDetails

Classifier document type info.

ClassifyDocumentContent

Document classification parameters.

ComposeDocumentModelContent

Request body to create a composed document model from component document models.

CopyAuthorization

Authorization to copy a document model to the specified target resource and modelId.

CurrencyValue

Currency field value.

CustomDocumentModelsDetails

Details regarding custom document models.

DocumentBarcode

A barcode object.

DocumentCaption

A caption object describing a table or figure.

DocumentClassifierBuildOperationDetails

Get Operation response object.

DocumentClassifierCopyToOperationDetails

Get Operation response object.

DocumentClassifierDetails

Document classifier info.

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.

DocumentFigure

An object representing a figure in the document.

DocumentFootnote

A footnote object describing a table or figure.

DocumentFormula

A formula object.

DocumentIntelligenceAdministrationClient

The DocumentIntelligenceAdministration service client.

DocumentIntelligenceClient

The DocumentIntelligence service client.

DocumentIntelligenceClientOptions

Client options for Azure.AI.DocumentIntelligence library clients.

DocumentIntelligenceError

The error object.

DocumentIntelligenceModelFactory

Model factory for models.

DocumentIntelligenceWarning

The error 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.

DocumentModelBuildOperationDetails

Get Operation response object.

DocumentModelComposeOperationDetails

Get Operation response object.

DocumentModelCopyToOperationDetails

Get Operation response object.

DocumentModelDetails

Document model info.

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.

DocumentSection

An object representing a section in the document.

DocumentSelectionMark

A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.

DocumentSpan

Contiguous region of the concatenated content property, specified as an offset and length.

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.

InnerError

An object containing more specific information about the error.

OperationDetails

Operation info. 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, DocumentClassifierCopyToOperationDetails, DocumentModelBuildOperationDetails, DocumentModelComposeOperationDetails and DocumentModelCopyToOperationDetails.

ResourceDetails

General information regarding the current resource.

Structs

AnalyzeOutputOption

Additional output to generate during analysis.

ContentFormat

Format of the content in analyzed result.

ContentSourceKind

Type of content source.

DocumentAnalysisFeature

Document analysis features to enable.

DocumentBarcodeKind

Barcode kind.

DocumentBuildMode

Custom document model build mode.

DocumentFieldType

Semantic data type of the field value.

DocumentFontStyle

Font style.

DocumentFontWeight

Font weight.

DocumentFormulaKind

Formula kind.

DocumentSelectionMarkState

State of the selection mark.

DocumentSignatureType

Presence of signature.

DocumentTableCellKind

Table cell kind.

LengthUnit

The unit used by the width, height, and polygon properties. For images, the unit is "pixel". For PDF, the unit is "inch".

OperationStatus

Operation status.

ParagraphRole

Semantic role of the paragraph.

SplitMode

Document splitting mode.

StringIndexType

Method used to compute string offset and length.

Enums

DocumentIntelligenceClientOptions.ServiceVersion

The version of the service to use.