Show / Hide Table of Contents

Namespace Oci.AidocumentService.Models

Classes

AddModelLockDetails

Request payload to add lock to the resource.

AddProjectLockDetails

Request payload to add lock to the resource.

AnalyzeDocumentDetails

The details of how to analyze a document.

AnalyzeDocumentResult

The document analysis results.

BoundingPolygon

The object-bounding polygon box.

Cell

A single cell in a table.

ChangeModelCompartmentDetails

The compartment the model should be moved to.

ChangeProjectCompartmentDetails

Which compartment the project should be moved to.

ComponentModel

The custom model selected for Composition.

CreateModelDetails

The information needed to create a new model.

CreateProcessorJobDetails

The details used to create a processor job.

CreateProjectDetails

The information needed to create a new project.

DataScienceLabelingDataset

The dataset created by the Data Labeling Service.

Dataset

The base entity which is the input for creating and training a model.

DatasetModelConverter

DatasetSummary

Summary of count of samples used during model training.

DetectedDocumentType

The detected document type.

DetectedLanguage

The language detected in a document.

Dimensions

The width and height of a page.

DocumentClassificationConfidenceEntry

Confidence Entry.

DocumentClassificationFeature

Identifying the document type.

DocumentClassificationLabelMetricsReport

Label Metrics report for Document Classification Model.

DocumentClassificationModelMetrics

Metrics for Document Classification Model.

DocumentClassificationOverallMetricsReport

Overall Metrics report for Document Classification Model.

DocumentDetails

The details of a document to analyze.

DocumentDetailsModelConverter

DocumentFeature

The type of document analysis.

DocumentFeatureModelConverter

DocumentField

Form field.

DocumentKeyValueExtractionFeature

Extracting form fields.

DocumentLanguageClassificationFeature

Detecting the language of the document.

DocumentMetadata

The document information.

DocumentTableExtractionFeature

Detecting and extracting data in tables.

DocumentTextExtractionFeature

Text recognition

FieldLabel

The label in a field.

FieldName

The name of a form field.

FieldValue

The value of a form field.

FieldValueModelConverter

GeneralProcessorConfig

The configuration of a general processor.

InlineDocumentContent

The content of an inline document.

InlineDocumentDetails

The document incorporated in the request payload.

InputLocation

The location of the inputs.

InputLocationModelConverter

KeyValueDetectionConfidenceEntry

Key Value Detection Confidence Entry.

KeyValueDetectionLabelMetricsReport

Label Metrics report for Key Value Detection Model.

KeyValueDetectionModelMetrics

Metrics for Document Key Value Detection Model.

KeyValueDetectionOverallMetricsReport

Overall Metrics report for Key Value Detection Model.

Line

The line of text.

Model

Machine-learned Model.

ModelCollection

The results of a model search.

ModelMetrics

Trained Model Metrics.

ModelMetricsModelConverter

ModelSummary

The metadata about the model.

NormalizedVertex

An (x, y) coordinate in the image with dimensions normalized from zero to one. The origin is at top left, with the positive x-axis pointing right and the positive y-axis pointing down. The bottom right corner is at (1, 1).

ObjectLocation

A location in Object Storage that is uniquely identified by namespace name, bucket name and object name.

ObjectStorageDataset

The dataset that resides in Object Storage.

ObjectStorageDocumentDetails

A document in OCI Object Storage.

ObjectStorageLocations

A list of object locations in Object Storage.

OutputLocation

The Object Storage Location.

Page

One page document analysis result.

PatchModelDetails

The model parameters to be updated using patch operation.

PatchModelOperation

The metadata which can be edited after model creation.

PatchResponseMessage

The response containing the details of the patch operation status.

ProcessingError

The error in document processing.

ProcessorConfig

The configuration of a processor.

ProcessorConfigModelConverter

ProcessorJob

Details of a processor job.

Project

A Document Project containing models.

ProjectCollection

The results of a project search.

ProjectSummary

the metadata about the project.

RemoveModelLockDetails

Request payload to remove lock to the resource.

RemoveProjectLockDetails

Request payload to remove lock to the resource.

ResourceLock

Resource locks prevent certain APIs from being called for the resource. A full lock prevents both updating and deleting the resource. A lock delete prevents deleting the resource.

Table

The table extracted from a document.

TableRow

A single row in a table.

UpdateModelDetails

The metadata which can be edited after model creation.

UpdateProjectDetails

The metadata that can be edited after project creation.

ValueArray

The array of field values.

ValueDate

The date field value.

ValueInteger

The integer field value.

ValueNumber

The floating point number field value.

ValuePhoneNumber

The phone number field value.

ValueString

The string field value.

ValueTime

The time field value.

Word

A single word.

WorkRequest

The workrequest status details.

WorkRequestError

An error encountered while executing a work request.

WorkRequestErrorCollection

The results of a workRequestError search.

WorkRequestLogEntry

A log message from the execution of a work request.

WorkRequestLogEntryCollection

The results of a workRequestLog search.

WorkRequestResource

A resource created, or operated on, by a work request.

WorkRequestSummary

A summary of the status of a work request.

WorkRequestSummaryCollection

The results of a workRequest search.

Enums

ActionType

Possible types of actions.

AddModelLockDetails.TypeEnum

AddProjectLockDetails.TypeEnum

Dataset.DatasetTypeEnum

Dimensions.UnitEnum

DocumentDetails.SourceEnum

DocumentFeature.FeatureTypeEnum

DocumentField.FieldTypeEnum

DocumentType

The type of document.

FieldValue.ValueTypeEnum

InputLocation.SourceTypeEnum

Model.LifecycleStateEnum

Model.ModelTypeEnum

ModelMetrics.ModelTypeEnum

OperationStatus

Possible operation statuses.

OperationType

Possible operation types.

PatchModelOperation.OperationEnum

ProcessorJob.LifecycleDetailsEnum

ProcessorJob.LifecycleStateEnum

ProcessorType

The type of a processor.

Project.LifecycleStateEnum

RemoveModelLockDetails.TypeEnum

RemoveProjectLockDetails.TypeEnum

ResourceLock.TypeEnum

SortOrder

Sort order.

WorkRequestResourceMetadataKey

Possible Metadata keys for workRequest resource metadata

In this article
Back to top