DocumentContent Class

Definition

Document content. Ex. text/plain, application/pdf, image/jpeg.

public class DocumentContent : Azure.AI.ContentUnderstanding.AnalysisContent, System.ClientModel.Primitives.IJsonModel<Azure.AI.ContentUnderstanding.DocumentContent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.ContentUnderstanding.DocumentContent>
type DocumentContent = class
    inherit AnalysisContent
    interface IJsonModel<DocumentContent>
    interface IPersistableModel<DocumentContent>
Public Class DocumentContent
Inherits AnalysisContent
Implements IJsonModel(Of DocumentContent), IPersistableModel(Of DocumentContent)
Inheritance
DocumentContent
Implements

Properties

Name Description
AnalyzerId

The analyzer that generated this content.

(Inherited from AnalysisContent)
Annotations

List of annotations in the document. Only if enableAnnotations and returnDetails are true.

Category

Classified content category.

(Inherited from AnalysisContent)
EndPageNumber

End page number (1-indexed) of the content.

Fields

Extracted fields from the content.

(Inherited from AnalysisContent)
Figures

List of figures in the document. Only if enableLayout and returnDetails are true.

Hyperlinks

List of hyperlinks in the document. Only if returnDetails are true.

Markdown

Markdown representation of the content.

(Inherited from AnalysisContent)
MimeType

Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc.

(Inherited from AnalysisContent)
Pages

List of pages in the document.

Paragraphs

List of paragraphs in the document. Only if enableOcr and returnDetails are true.

Path

The path of the content in the input.

(Inherited from AnalysisContent)
Sections

List of sections in the document. Only if enableLayout and returnDetails are true.

Segments

List of detected content segments. Only if enableSegment is true.

StartPageNumber

Start page number (1-indexed) of the content.

Tables

List of tables in the document. Only if enableLayout and returnDetails are true.

Unit

Length unit used by the width, height, and source properties. For images/tiff, the default unit is pixel. For PDF, the default unit is inch.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<AnalysisContent>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from AnalysisContent)
IJsonModel<AnalysisContent>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from AnalysisContent)
IJsonModel<DocumentContent>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<DocumentContent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AnalysisContent>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from AnalysisContent)
IPersistableModel<AnalysisContent>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from AnalysisContent)
IPersistableModel<AnalysisContent>.Write(ModelReaderWriterOptions) (Inherited from AnalysisContent)
IPersistableModel<DocumentContent>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<DocumentContent>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<DocumentContent>.Write(ModelReaderWriterOptions)

Applies to