Namespace Oci.DatalabelingservicedataplaneService.Models

Classes

Annotation

An annotation represents a user- or machine-generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails.

AnnotationAggregationDimensions

The dimensions to summarize annotations for a given dataset.

AnnotationAnalyticsAggregation

Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation.

AnnotationAnalyticsAggregationCollection

AnnotationCollection

The results of an annotations search. It contains AnnotationSummary items and other information, such as metadata.

AnnotationSummary

An annotation summary is the representation returned in list views. It is usually a subset of the full annotation entity and should not contain any potentially sensitive information.

BoundingPolygon

A polygon used to describe the location of an object.

CreateAnnotationDetails

This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an annotation for a record.

CreateObjectStorageSourceDetails

Object Storage Source Details.

CreateRecordDetails

A record represents an entry in a dataset that needs labeling.

CreateSourceDetails

The source information is a polymorphic entity. It captures the details of how to access the data for record creation. The discriminator type must match the dataset's source type. The convention will be enforced by the API. It should only provide the difference in data necessary to access the content, i.e. the object storage path, or the database record id.

CreateSourceDetailsModelConverter

Dataset

A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record's source, format, the type of annotations allowed for the record, and the labels allowed on annotations.

DatasetFormatDetails

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

DatasetFormatDetailsModelConverter

DatasetSourceDetails

This allows the customer to specify the source of the dataset.

DatasetSourceDetailsModelConverter

DelimitedFileTypeMetadata

Metadata of delimited files.

DocumentDatasetFormatDetails

It indicates the dataset is comprised of document files. It is open for further configurability.

DocumentEntityMetadata

This is dedicated Entity to store Document related info.

DocumentMetadata

Collection of metadata related to document record.

Entity

An entity allows the labeler to identify an object in the record to label. This can be, for example, a snippet of text, an entire image, or a bounding box within an image. All entity types have an array of labels that are indexed. If more than one label is provided, but the annotationType on the corresponding dataset is for a single class, the API rejects the create annotation request.

EntityModelConverter

GenericEntity

This is an extensible entity type for users, and the base entity type for some annotation formats.

ImageDatasetFormatDetails

It indicates the dataset is comprised of images.

ImageMetadata

Collection of metadata related to image record.

ImageObjectSelectionEntity

This lets the labeler specify a series of coordinates in the image to represent an object and apply labels to it. The coordinates are connected in the order that they are provided. The last coordinate in the array is connected to the first coordinate.

ImportFormat

File format details used for importing dataset

ImportMetadataPath

Object storage path for the metadata file

ImportMetadataPathModelConverter

InitialImportDatasetConfiguration

Initial import dataset configuration. Allows user to create dataset from existing dataset files.

InitialRecordGenerationConfiguration

The initial generate records configuration. It generates records from the dataset's source.

KeyValueSelectionEntity

This allows the labeler to apply label the highlighted text from OCR, this includes labelled and unlabelled data.

Label

A label is a string value. The API validates that it's one of the dataset's pre-defined labels.

LabelName

It represents a label.

LabelSet

An ordered collection of labels that are unique by name.

NormalizedVertex

A NormalizedVertex is a cartesian coordinate that represents a corner between two segments of a polygon.

ObjectStorageDatasetSourceDetails

Specifies the dataset location in object storage. This requires that all records are in this bucket, and under this prefix. We do not support a dataset with objects in arbitrary locations across buckets or prefixes.

ObjectStorageImportMetadataPath

Object Storage details for import metadata path.

ObjectStorageSourceDetails

Object Storage Source Details.

Record

A record represents an entry in a dataset that needs labeling.

RecordAggregationDimensions

The dimensions to summarize record information for a given dataset.

RecordAnalyticsAggregation

Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize record information for a given dataset and are used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation.

Namespace Oci.DatalabelingservicedataplaneService.Models

Classes

Enums