API Reference
Class
OfficeDocumentStructuredExtractionResult
Bounded, schema-friendly extraction of a shared document result.
Inheritance
- Object
- OfficeDocumentStructuredExtractionResult
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method DocumentReader.ExtractStructured
- Method DocumentReader.ReadStructured
- Method DocumentReader.ReadStructured
- Method DocumentReader.ReadStructuredAsync
- Method DocumentReader.ReadStructuredAsync
- Method OfficeDocumentReader.ExtractStructured
- Method OfficeDocumentReader.ReadStructured
- Method OfficeDocumentReader.ReadStructured
- Method OfficeDocumentReader.ReadStructuredAsync
- Method OfficeDocumentReader.ReadStructuredAsync
- Method OfficeDocumentStructuredExtractor.Extract
Accepted by parameters
Constructors
public OfficeDocumentStructuredExtractionResult() #Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public String SchemaId { get; set; } #Structured extraction schema identifier.
public Int32 SchemaVersion { get; set; } #Structured extraction schema version.
public OfficeDocumentSource Source { get; set; } #Source document metadata.
public IReadOnlyList<OfficeDocumentStructuredRecord> Records { get; set; } #Scalar structured records in deterministic category/source order.
public IReadOnlyList<OfficeDocumentStructuredSection> Sections { get; set; } #Heading-based sections in source order.
public IReadOnlyList<ReaderTable> Tables { get; set; } #Named tables in source order.
public IReadOnlyList<OfficeDocumentFormField> Forms { get; set; } #Typed form fields in source order.
public IReadOnlyList<OfficeDocumentDiagnostic> Diagnostics { get; set; } #Source and extraction-limit diagnostics.
Extension Methods
public static String ToJson(OfficeDocumentStructuredExtractionResult result, Boolean indented = false) #Returns:
StringSerializes a current structured extraction result.
Parameters
- result OfficeIMO.Reader.OfficeDocumentStructuredExtractionResult
- indented System.Boolean = false