Class CreateDocumentJobDetails
The batch document analysis details.
Inherited Members
Namespace: Oci.AivisionService.Models
Assembly: OCI.DotNetSDK.Aivision.dll
Syntax
public class CreateDocumentJobDetails
Properties
CompartmentId
Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The compartment identifier from the requester. |
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The document job display name. |
DocumentType
Declaration
[JsonProperty(PropertyName = "documentType")]
[JsonConverter(typeof(StringEnumConverter))]
public DocumentType? DocumentType { get; set; }
Property Value
Type | Description |
---|---|
DocumentType? | The type of documents. |
Features
Declaration
[Required(ErrorMessage = "Features is required.")]
[JsonProperty(PropertyName = "features")]
public List<DocumentFeature> Features { get; set; }
Property Value
Type | Description |
---|---|
List<DocumentFeature> | The list of requested document analysis types. |
Remarks
Required
InputLocation
Declaration
[Required(ErrorMessage = "InputLocation is required.")]
[JsonProperty(PropertyName = "inputLocation")]
public InputLocation InputLocation { get; set; }
Property Value
Type | Description |
---|---|
InputLocation |
Remarks
Required
IsZipOutputEnabled
Declaration
[JsonProperty(PropertyName = "isZipOutputEnabled")]
public bool? IsZipOutputEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Whether or not to generate a ZIP file containing the results. |
Language
Declaration
[JsonProperty(PropertyName = "language")]
[JsonConverter(typeof(StringEnumConverter))]
public DocumentLanguage? Language { get; set; }
Property Value
Type | Description |
---|---|
DocumentLanguage? | The language of the document, abbreviated according to ISO 639-2. |
OutputLocation
Declaration
[Required(ErrorMessage = "OutputLocation is required.")]
[JsonProperty(PropertyName = "outputLocation")]
public OutputLocation OutputLocation { get; set; }
Property Value
Type | Description |
---|---|
OutputLocation |
Remarks
Required