Class AnalyzeDocumentDetails

The details of how to analyze a document.

Inheritance

object

AnalyzeDocumentDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.AidocumentService.Models

Assembly: OCI.DotNetSDK.Aidocument.dll

Syntax

public class AnalyzeDocumentDetails

Properties

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The compartment identifier.

Document

Declaration

[Required(ErrorMessage = "Document is required.")]
[JsonProperty(PropertyName = "document")]
public DocumentDetails Document { get; set; }

Property Value

Type	Description
DocumentDetails

Remarks

Required

DocumentType

Declaration

[JsonProperty(PropertyName = "documentType")]
[JsonConverter(typeof(StringEnumConverter))]
public DocumentType? DocumentType { get; set; }

Property Value

Type	Description
DocumentType?	The document type.

Features

Declaration

[Required(ErrorMessage = "Features is required.")]
[JsonProperty(PropertyName = "features")]
public List<DocumentFeature> Features { get; set; }

Property Value

Type	Description
List<DocumentFeature>	The types of document analysis requested.

Remarks

Required

Language

Declaration

[JsonProperty(PropertyName = "language")]
public string Language { get; set; }

Property Value

Type	Description
string	The document language, abbreviated according to the BCP 47 syntax.

OcrData

Declaration

[JsonProperty(PropertyName = "ocrData")]
public AnalyzeDocumentResult OcrData { get; set; }

Property Value

Type	Description
AnalyzeDocumentResult

OutputLocation

Declaration

[JsonProperty(PropertyName = "outputLocation")]
public OutputLocation OutputLocation { get; set; }

Property Value

Type	Description
OutputLocation