DocumentContent interface
Document content. Ex. text/plain, application/pdf, image/jpeg.
- Extends
Properties
| annotations | List of annotations in the document. Only if enableAnnotations and returnDetails are true. |
| end |
End page number (1-indexed) of the content. |
| 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. |
| kind | Content kind. |
| pages | List of pages in the document. |
| paragraphs | List of paragraphs in the document. Only if enableOcr and returnDetails are true. |
| 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. |
| start |
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. |
Inherited Properties
| analyzer |
The analyzer that generated this content. |
| category | Classified content category. |
| fields | Extracted fields from the content. |
| markdown | Markdown representation of the content. |
| mime |
Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. |
| path | The path of the content in the input. |
Property Details
annotations
List of annotations in the document. Only if enableAnnotations and returnDetails are true.
annotations?: DocumentAnnotation[]Property Value
endPageNumber
End page number (1-indexed) of the content.
endPageNumber: numberProperty Value
number
figures
List of figures in the document. Only if enableLayout and returnDetails are true.
figures?: DocumentFigureUnion[]Property Value
hyperlinks
List of hyperlinks in the document. Only if returnDetails are true.
hyperlinks?: DocumentHyperlink[]Property Value
kind
Content kind.
kind: "document"Property Value
"document"
pages
paragraphs
List of paragraphs in the document. Only if enableOcr and returnDetails are true.
paragraphs?: DocumentParagraph[]Property Value
sections
List of sections in the document. Only if enableLayout and returnDetails are true.
sections?: DocumentSection[]Property Value
segments
List of detected content segments. Only if enableSegment is true.
segments?: DocumentContentSegment[]Property Value
startPageNumber
Start page number (1-indexed) of the content.
startPageNumber: numberProperty Value
number
tables
List of tables in the document. Only if enableLayout and returnDetails are true.
tables?: DocumentTable[]Property Value
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.
unit?: LengthUnitProperty Value
Inherited Property Details
analyzerId
The analyzer that generated this content.
analyzerId?: stringProperty Value
string
Inherited From AnalysisContent.analyzerId
category
Classified content category.
category?: stringProperty Value
string
Inherited From AnalysisContent.category
fields
Extracted fields from the content.
fields?: Record<string, ContentFieldUnion>Property Value
Record<string, ContentFieldUnion>
Inherited From AnalysisContent.fields
markdown
Markdown representation of the content.
markdown?: stringProperty Value
string
Inherited From AnalysisContent.markdown
mimeType
Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc.
mimeType: stringProperty Value
string
Inherited From AnalysisContent.mimeType
path
The path of the content in the input.
path?: stringProperty Value
string
Inherited From AnalysisContent.path