Data Labeling Service Functions
Package: DBMS_CLOUD_OCI_DLS_DATA_LABELING_MANAGEMENT
ADD_DATASET_LABELS Function
Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.
Syntax
FUNCTION add_dataset_labels (
dataset_id varchar2,
add_dataset_labels_details dbms_cloud_oci_data_labeling_service_add_dataset_labels_details_t,
opc_retry_token varchar2 DEFAULT NULL,
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_dls_data_labeling_management_add_dataset_labels_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(required) Details for adding Labels to the LabelSet of the Dataset. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to 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. |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_DATASET_COMPARTMENT Function
Moves a Dataset resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_dataset_compartment (
dataset_id varchar2,
change_dataset_compartment_details dbms_cloud_oci_data_labeling_service_change_dataset_compartment_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_dls_data_labeling_management_change_dataset_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(required) Details for changing the compartment of a Dataset |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_DATASET Function
Creates a new Dataset.
Syntax
FUNCTION create_dataset (
create_dataset_details dbms_cloud_oci_data_labeling_service_create_dataset_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_dls_data_labeling_management_create_dataset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new Dataset. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to 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. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_DATASET Function
Deletes a Dataset resource by identifier
Syntax
FUNCTION delete_dataset (
dataset_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_dls_data_labeling_management_delete_dataset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GENERATE_DATASET_RECORDS Function
Generates Record resources from the Dataset's data source
Syntax
FUNCTION generate_dataset_records (
dataset_id varchar2,
generate_dataset_records_details dbms_cloud_oci_data_labeling_service_generate_dataset_records_details_t,
opc_retry_token varchar2 DEFAULT NULL,
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_dls_data_labeling_management_generate_dataset_records_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(required) Details for generating Dataset records. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to 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. |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(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_dls_data_labeling_management_get_dataset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_WORK_REQUEST Function
Gets the status of the work request with the given ID.
Syntax
FUNCTION get_work_request (
work_request_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_dls_data_labeling_management_get_work_request_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
IMPORT_PRE_ANNOTATED_DATA Function
Imports records and annotations from dataset files into existing Dataset.
Syntax
FUNCTION import_pre_annotated_data (
dataset_id varchar2,
import_pre_annotated_data_details dbms_cloud_oci_data_labeling_service_import_pre_annotated_data_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dls_data_labeling_management_import_pre_annotated_data_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(required) Details for importing Dataset |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to 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. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_ANNOTATION_FORMATS Function
These are a static list in a given region.
Syntax
FUNCTION list_annotation_formats (
compartment_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order 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_dls_data_labeling_management_list_annotation_formats_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_DATASETS Function
Returns a list of Datasets.
Syntax
FUNCTION list_datasets (
compartment_id varchar2,
id varchar2 DEFAULT NULL,
annotation_format varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 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_dls_data_labeling_management_list_datasets_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) Unique Dataset OCID |
|
(optional) A filter to return only resources that match the entire annotation format given. |
|
(optional) A filter to return only resources whose lifecycleState matches this query param. |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUEST_ERRORS Function
Return a (paginated) list of errors for a given work request.
Syntax
FUNCTION list_work_request_errors (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dls_data_labeling_management_list_work_request_errors_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUEST_LOGS Function
Return a (paginated) list of logs for a given work request.
Syntax
FUNCTION list_work_request_logs (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dls_data_labeling_management_list_work_request_logs_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUESTS Function
Lists the work requests in a compartment.
Syntax
FUNCTION list_work_requests (
compartment_id varchar2,
work_request_id varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dls_data_labeling_management_list_work_requests_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The ID of the asynchronous work request. |
|
(optional) The client request ID for tracing. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
REMOVE_DATASET_LABELS Function
Removes the labels from the Dataset Labelset. Labels can only be removed if there are no Annotations associated with the Dataset that reference the Label names.
Syntax
FUNCTION remove_dataset_labels (
dataset_id varchar2,
remove_dataset_labels_details dbms_cloud_oci_data_labeling_service_remove_dataset_labels_details_t,
opc_retry_token varchar2 DEFAULT NULL,
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_dls_data_labeling_management_remove_dataset_labels_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(required) Details for removing Labels from the LabelSet of the Dataset. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to 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. |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
RENAME_DATASET_LABELS Function
Renames the labels from the Dataset Labelset. Labels that are renamed will be reflected in Annotations associated with the Dataset that reference the Label names.
Syntax
FUNCTION rename_dataset_labels (
dataset_id varchar2,
rename_dataset_labels_details dbms_cloud_oci_data_labeling_service_rename_dataset_labels_details_t,
opc_retry_token varchar2 DEFAULT NULL,
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_dls_data_labeling_management_rename_dataset_labels_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(required) Details for renaming Labels in the LabelSet of the Dataset. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to 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. |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SNAPSHOT_DATASET Function
Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption. While the snapshot takes place, there may be a time while records and annotations cannot be created to ensure the snapshot is a point in time.
Syntax
FUNCTION snapshot_dataset (
dataset_id varchar2,
snapshot_dataset_details dbms_cloud_oci_data_labeling_service_snapshot_dataset_details_t,
opc_retry_token varchar2 DEFAULT NULL,
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_dls_data_labeling_management_snapshot_dataset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(required) Details of creating a snapshot of the Dataset's Records and Annotations |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to 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. |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_DATASET Function
Updates the Dataset
Syntax
FUNCTION update_dataset (
dataset_id varchar2,
update_dataset_details dbms_cloud_oci_data_labeling_service_update_dataset_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_dls_data_labeling_management_update_dataset_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Dataset OCID |
|
(required) Details for updating a Dataset. |
|
(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 will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://datalabeling-cp.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |