Skip to content

datalabelingservicedataplane.oracle.com/v1beta1

Back to API Reference

APIVersion: datalabelingservicedataplane.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes datalabelingservicedataplane.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
Annotation Namespaced Sample -
Record Namespaced Sample -

Annotation

Annotation is the Schema for the annotations API.

  • Plural: annotations
  • Scope: Namespaced
  • APIVersion: datalabelingservicedataplane.oracle.com/v1beta1
  • Sample: Sample (config/samples/datalabelingservicedataplane_v1beta1_annotation.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

AnnotationSpec defines the desired state of Annotation.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment for the annotation. string Yes - -
definedTags The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
entities The entity types are validated against the dataset to ensure consistency. list[object] Yes - -
freeformTags A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"} map[string, string] No - -
recordId The OCID of the record annotated. string Yes - -

Spec.entities[]

Back to Annotation spec

AnnotationEntity defines nested fields for Annotation.Entity.

Field Description Type Required Default Enum
boundingPolygon AnnotationEntityBoundingPolygon defines nested fields for Annotation.Entity.BoundingPolygon. object No - -
confidence float value, score from OCR. number No - -
documentEntityMetadata AnnotationEntityDocumentEntityMetadata defines nested fields for Annotation.Entity.DocumentEntityMetadata. object No - -
entityType - string No - -
extendedMetadata A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"} map[string, string] No - -
jsonData - string No - -
labels A collection of label entities. list[object] No - -
pageNumber Integer value. number No - -
rotation Integer value. number No - -
text Entity Name. string No - -
textSpan AnnotationEntityTextSpan defines nested fields for Annotation.Entity.TextSpan. object No - -

Spec.entities[].boundingPolygon

Back to Annotation spec

AnnotationEntityBoundingPolygon defines nested fields for Annotation.Entity.BoundingPolygon.

Field Description Type Required Default Enum
normalizedVertices The normalized vertices that make up the polygon. They are in the order of the segments they connect. list[object] Yes - -

Spec.entities[].boundingPolygon.normalizedVertices[]

Back to Annotation spec

AnnotationEntityBoundingPolygonNormalizedVertice defines nested fields for Annotation.Entity.BoundingPolygon.NormalizedVertice.

Field Description Type Required Default Enum
x The X axis coordinate. number Yes - -
y The Y axis coordinate. number Yes - -

Spec.entities[].documentEntityMetadata

Back to Annotation spec

AnnotationEntityDocumentEntityMetadata defines nested fields for Annotation.Entity.DocumentEntityMetadata.

Field Description Type Required Default Enum
pageNumber This stores page number of document. number Yes - -

Spec.entities[].labels[]

Back to Annotation spec

AnnotationEntityLabel defines nested fields for Annotation.Entity.Label.

Field Description Type Required Default Enum
label The label provided by the annotator. string Yes - -

Spec.entities[].textSpan

Back to Annotation spec

AnnotationEntityTextSpan defines nested fields for Annotation.Entity.TextSpan.

Field Description Type Required Default Enum
length The length of the selected text. number No - -
offset The offset of the selected text within the entire text. number No - -

Status

AnnotationStatus defines the observed state of Annotation.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment for the annotation. This is tied to the dataset. It is not changeable on the record itself. string No - -
createdBy The OCID of the principal which created the annotation. string No - -
definedTags The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
entities The entity types are validated against the dataset to ensure consistency. list[object] No - -
freeformTags A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"} map[string, string] No - -
id The OCID of the annotation. string No - -
lifecycleState The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for labeling. INACTIVE - The annotation has been marked as inactive and should not be used for labeling. DELETED - Tha annotation been deleted and no longer available for labeling. string No - -
recordId The OCID of the record annotated. string No - -
status - object Yes - -
timeCreated The date and time the annotation was created, in the timestamp format defined by RFC3339. string No - -
timeUpdated The date and time the resource was updated, in the timestamp format defined by RFC3339. string No - -
updatedBy The OCID of the principal which updated the annotation. string No - -

Status.entities[]

Back to Annotation status

AnnotationEntity defines nested fields for Annotation.Entity.

Field Description Type Required Default Enum
boundingPolygon AnnotationEntityBoundingPolygon defines nested fields for Annotation.Entity.BoundingPolygon. object No - -
confidence float value, score from OCR. number No - -
documentEntityMetadata AnnotationEntityDocumentEntityMetadata defines nested fields for Annotation.Entity.DocumentEntityMetadata. object No - -
entityType - string No - -
extendedMetadata A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"} map[string, string] No - -
jsonData - string No - -
labels A collection of label entities. list[object] No - -
pageNumber Integer value. number No - -
rotation Integer value. number No - -
text Entity Name. string No - -
textSpan AnnotationEntityTextSpan defines nested fields for Annotation.Entity.TextSpan. object No - -

Status.entities[].boundingPolygon

Back to Annotation status

AnnotationEntityBoundingPolygon defines nested fields for Annotation.Entity.BoundingPolygon.

Field Description Type Required Default Enum
normalizedVertices The normalized vertices that make up the polygon. They are in the order of the segments they connect. list[object] Yes - -

Status.entities[].boundingPolygon.normalizedVertices[]

Back to Annotation status

AnnotationEntityBoundingPolygonNormalizedVertice defines nested fields for Annotation.Entity.BoundingPolygon.NormalizedVertice.

Field Description Type Required Default Enum
x The X axis coordinate. number Yes - -
y The Y axis coordinate. number Yes - -

Status.entities[].documentEntityMetadata

Back to Annotation status

AnnotationEntityDocumentEntityMetadata defines nested fields for Annotation.Entity.DocumentEntityMetadata.

Field Description Type Required Default Enum
pageNumber This stores page number of document. number Yes - -

Status.entities[].labels[]

Back to Annotation status

AnnotationEntityLabel defines nested fields for Annotation.Entity.Label.

Field Description Type Required Default Enum
label The label provided by the annotator. string Yes - -

Status.entities[].textSpan

Back to Annotation status

AnnotationEntityTextSpan defines nested fields for Annotation.Entity.TextSpan.

Field Description Type Required Default Enum
length The length of the selected text. number No - -
offset The offset of the selected text within the entire text. number No - -

Status.status

Back to Annotation status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Annotation status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Annotation status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Annotation status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Record

Record is the Schema for the records API.

  • Plural: records
  • Scope: Namespaced
  • APIVersion: datalabelingservicedataplane.oracle.com/v1beta1
  • Sample: Sample (config/samples/datalabelingservicedataplane_v1beta1_record.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

RecordSpec defines the desired state of Record.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment for the record. This is tied to the dataset. It is not changeable on the record itself. string Yes - -
datasetId The OCID of the dataset to associate the record with. string Yes - -
definedTags The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
freeformTags A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"} map[string, string] No - -
name The name is automatically assigned by the service. It is unique and immutable. string Yes - -
recordMetadata RecordMetadata defines nested fields for Record.RecordMetadata. object No - -
sourceDetails RecordSourceDetails defines nested fields for Record.SourceDetails. object Yes - -

Spec.recordMetadata

Back to Record spec

RecordMetadata defines nested fields for Record.RecordMetadata.

Field Description Type Required Default Enum
depth Depth of the image record. integer No - -
height Height of the image record. integer No - -
jobId Job id ocid of OCR batch call. string No - -
jsonData - string No - -
recordType - string No - -
width Width of the image record. integer No - -

Spec.sourceDetails

Back to Record spec

RecordSourceDetails defines nested fields for Record.SourceDetails.

Field Description Type Required Default Enum
jsonData - string No - -
length The length from offset into the file containing the content. number No - -
offset The offset into the file containing the content. number No - -
relativePath The path relative to the prefix specified in the dataset source details (file name). string No - -
sourceType - string No - -

Status

RecordStatus defines the observed state of Record.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment for the task. string No - -
datasetId The OCID of the dataset to associate the record with. string No - -
definedTags The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
freeformTags A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"} map[string, string] No - -
id The OCID of the record. string No - -
isLabeled Whether or not the record has been labeled and has associated annotations. boolean No - -
lifecycleState The lifecycle state of the record. ACTIVE - The record is active and ready for labeling. INACTIVE - The record has been marked as inactive and should not be used for labeling. DELETED - The record has been deleted and is no longer available for labeling. string No - -
name The name is created by the user. It is unique and immutable. string No - -
recordMetadata RecordMetadata defines nested fields for Record.RecordMetadata. object No - -
sourceDetails RecordSourceDetails defines nested fields for Record.SourceDetails. object No - -
status - object Yes - -
timeCreated The date and time the resource was created, in the timestamp format defined by RFC3339. string No - -
timeUpdated The date and time the resource was updated, in the timestamp format defined by RFC3339. string No - -

Status.recordMetadata

Back to Record status

RecordMetadata defines nested fields for Record.RecordMetadata.

Field Description Type Required Default Enum
depth Depth of the image record. integer No - -
height Height of the image record. integer No - -
jobId Job id ocid of OCR batch call. string No - -
jsonData - string No - -
recordType - string No - -
width Width of the image record. integer No - -

Status.sourceDetails

Back to Record status

RecordSourceDetails defines nested fields for Record.SourceDetails.

Field Description Type Required Default Enum
jsonData - string No - -
length The length from offset into the file containing the content. number No - -
offset The offset into the file containing the content. number No - -
relativePath The path relative to the prefix specified in the dataset source details (file name). string No - -
sourceType - string No - -

Status.status

Back to Record status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Record status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Record status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Record status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -