Data Labeling Service Dataplane Functions

Package: DBMS_CLOUD_OCI_DLSD_DATA_LABELING

CREATE_ANNOTATION Function

Creates an annotation.

Syntax

FUNCTION create_annotation (
  create_annotation_details dbms_cloud_oci_data_labeling_service_dataplane_create_annotation_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_create_annotation_response_t;

Parameters

Parameter	Description
`create_annotation_details`	(required) Details for the new CreateAnnotation.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried, without risk of executing that same action again, if there is a timeout or server error. Retry tokens expire after 24 hours, but can be invalidated before then if there are conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_RECORD Function

Creates a record.

Syntax

FUNCTION create_record (
  create_record_details dbms_cloud_oci_data_labeling_service_dataplane_create_record_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_create_record_response_t;

Parameters

Parameter	Description
`create_record_details`	(required) The details for the new record.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried, without risk of executing that same action again, if there is a timeout or server error. Retry tokens expire after 24 hours, but can be invalidated before then if there are conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ANNOTATION Function

It deletes an annotation resource by identifier.

Syntax

FUNCTION delete_annotation (
  annotation_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_delete_annotation_response_t;

Parameters

Parameter	Description
`annotation_id`	(required) A unique annotation identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_RECORD Function

Deletes a record resource by identifier.

Syntax

FUNCTION delete_record (
  record_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_delete_record_response_t;

Parameters

Parameter	Description
`record_id`	(required) The OCID of the record annotated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ANNOTATION Function

Gets an annotation.

Syntax

FUNCTION get_annotation (
  annotation_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_get_annotation_response_t;

Parameters

Parameter	Description
`annotation_id`	(required) A unique annotation identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATASET Function

Gets a dataset by identifier.

Syntax

FUNCTION get_dataset (
  dataset_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_get_dataset_response_t;

Parameters

Parameter	Description
`dataset_id`	(required) A unique dataset OCID.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RECORD Function

Gets a record.

Syntax

FUNCTION get_record (
  record_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_get_record_response_t;

Parameters

Parameter	Description
`record_id`	(required) The OCID of the record annotated.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RECORD_CONTENT Function

Retrieves the content of the record from the dataset source.

Syntax

FUNCTION get_record_content (
  record_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_get_record_content_response_t;

Parameters

Parameter	Description
`record_id`	(required) The OCID of the record annotated.
`opc_request_id`	(optional) The client request ID for tracing.
`if_none_match`	(optional) For optimistic concurrency control. In the GET call for a resource, set the `if-none-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be fetched only if the etag you provide does not match the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RECORD_PREVIEW_CONTENT Function

Retrieves the preview of the record content from the dataset source.

Syntax

FUNCTION get_record_preview_content (
  record_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_get_record_preview_content_response_t;

Parameters

Parameter	Description
`record_id`	(required) The OCID of the record annotated.
`opc_request_id`	(optional) The client request ID for tracing.
`if_none_match`	(optional) For optimistic concurrency control. In the GET call for a resource, set the `if-none-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be fetched only if the etag you provide does not match the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ANNOTATIONS Function

Returns a list of annotations.

Syntax

FUNCTION list_annotations (
  compartment_id varchar2,
  dataset_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  updated_by varchar2 DEFAULT NULL,
  record_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_list_annotations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`dataset_id`	(required) Filter the results by the OCID of the dataset.
`lifecycle_state`	(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.
`id`	(optional) The unique OCID identifier.
`updated_by`	(optional) The OCID of the principal which updated the annotation.
`record_id`	(optional) The OCID of the record annotated.
`time_created_greater_than_or_equal_to`	(optional) The date and time the resource was created, in the timestamp format defined by RFC3339.
`time_created_less_than_or_equal_to`	(optional) The date and time the resource was created, in the timestamp format defined by RFC3339.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. If no value is specified timeCreated is used by default. Allowed values are: 'timeCreated', 'label'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_RECORDS Function

The list of records in the specified compartment.

Syntax

FUNCTION list_records (
  compartment_id varchar2,
  dataset_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  is_labeled number DEFAULT NULL,
  annotation_labels_contains dbms_cloud_oci_data_labeling_service_dataplane_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_list_records_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`dataset_id`	(required) Filter the results by the OCID of the dataset.
`lifecycle_state`	(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.
`name`	(optional) The name of the record.
`id`	(optional) The unique OCID identifier.
`is_labeled`	(optional) Whether the record has been labeled and has associated annotations.
`annotation_labels_contains`	(optional) Lets the user filter records based on the related annotations.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for name is ascending. If no value is specified, timeCreated is used by default. Allowed values are: 'timeCreated', 'name'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_ANNOTATION_ANALYTICS Function

Summarize the annotations created for a given dataset.

Syntax

FUNCTION summarize_annotation_analytics (
  compartment_id varchar2,
  dataset_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  label varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  annotation_group_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_summarize_annotation_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`dataset_id`	(required) Filter the results by the OCID of the dataset.
`lifecycle_state`	(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.
`label`	(optional) It summarizes annotations with the specified label.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order is descending. If no value is specified, updatedBy is used by default. Allowed values are: 'count', 'label', 'updatedBy'
`annotation_group_by`	(optional) The field to group by. If no value is specified, updatedBy is used by default. Allowed values are: 'updatedBy', 'label'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_RECORD_ANALYTICS Function

Summarize the records created for a given dataset.

Syntax

FUNCTION summarize_record_analytics (
  compartment_id varchar2,
  dataset_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  record_group_by varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_summarize_record_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`dataset_id`	(required) Filter the results by the OCID of the dataset.
`lifecycle_state`	(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`record_group_by`	(optional) The field to group by. If no value is specified isLabeled is used by default. Allowed values are: 'isLabeled', 'annotationLabelContains'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order is descending. If no value is specified, count is used by default. Allowed values are: 'count', 'isLabeled'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ANNOTATION Function

Updates an annotation.

Syntax

FUNCTION update_annotation (
  annotation_id varchar2,
  update_annotation_details dbms_cloud_oci_data_labeling_service_dataplane_update_annotation_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_update_annotation_response_t;

Parameters

Parameter	Description
`annotation_id`	(required) A unique annotation identifier.
`update_annotation_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_RECORD Function

Updates a record.

Syntax

FUNCTION update_record (
  record_id varchar2,
  update_record_details dbms_cloud_oci_data_labeling_service_dataplane_update_record_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dlsd_data_labeling_update_record_response_t;

Parameters

Parameter	Description
`record_id`	(required) The OCID of the record annotated.
`update_record_details`	(required) Information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datalabeling-dp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

CREATE_ANNOTATION Function

CREATE_RECORD Function

DELETE_ANNOTATION Function

DELETE_RECORD Function

GET_ANNOTATION Function

GET_DATASET Function

GET_RECORD Function

GET_RECORD_CONTENT Function

GET_RECORD_PREVIEW_CONTENT Function

LIST_ANNOTATIONS Function

LIST_RECORDS Function

SUMMARIZE_ANNOTATION_ANALYTICS Function

SUMMARIZE_RECORD_ANALYTICS Function

UPDATE_ANNOTATION Function

UPDATE_RECORD Function