DataLabelingManagementClient¶
-
class
oci.data_labeling_service.
DataLabelingManagementClient
(config, **kwargs)¶ Use Data Labeling Management API to create, list, edit & delete datasets.
Methods
__init__
(config, **kwargs)Creates a new service client add_dataset_labels
(dataset_id, …)Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached. change_dataset_compartment
(dataset_id, …)Moves a Dataset resource from one compartment identifier to another. create_dataset
(create_dataset_details, **kwargs)Creates a new Dataset. delete_dataset
(dataset_id, **kwargs)Deletes a Dataset resource by identifier generate_dataset_records
(dataset_id, …)Generates Record resources from the Dataset’s data source get_dataset
(dataset_id, **kwargs)Gets a Dataset by identifier get_work_request
(work_request_id, **kwargs)Gets the status of the work request with the given ID. import_pre_annotated_data
(dataset_id, …)Imports records and annotations from dataset files into existing Dataset. list_annotation_formats
(compartment_id, **kwargs)These are a static list in a given region. list_datasets
(compartment_id, **kwargs)Returns a list of Datasets. list_work_request_errors
(work_request_id, …)Return a (paginated) list of errors for a given work request. list_work_request_logs
(work_request_id, **kwargs)Return a (paginated) list of logs for a given work request. list_work_requests
(compartment_id, **kwargs)Lists the work requests in a compartment. remove_dataset_labels
(dataset_id, …)Removes the labels from the Dataset Labelset. rename_dataset_labels
(dataset_id, …)Renames the labels from the Dataset Labelset. snapshot_dataset
(dataset_id, …)Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption. update_dataset
(dataset_id, …)Updates the Dataset -
__init__
(config, **kwargs)¶ Creates a new service client
Parameters: - config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
from_file()
method can be used to load configuration from a file. Alternatively, adict
can be passed. You can validate_config the dict usingvalidate_config()
- service_endpoint (str) – (optional)
The endpoint of the service to call using this client. For example
https://iaas.us-ashburn-1.oraclecloud.com
. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint. - timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
- signer (
AbstractBaseSigner
) –(optional) The signer to use when signing requests made by the service client. The default is to use a
Signer
based on the values provided in the config parameter.One use case for this parameter is for Instance Principals authentication by passing an instance of
InstancePrincipalsSecurityTokenSigner
as the value for this keyword argument - retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a
retry_strategy
keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.This should be one of the strategies available in the
retry
module. A convenienceDEFAULT_RETRY_STRATEGY
is also available. The specifics of the default retry strategy are described here. - circuit_breaker_strategy (obj) – (optional)
A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level).
This client uses
DEFAULT_CIRCUIT_BREAKER_STRATEGY
as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here. - circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
- client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
- allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
- config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
-
add_dataset_labels
(dataset_id, add_dataset_labels_details, **kwargs)¶ Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- add_dataset_labels_details (oci.data_labeling_service.models.AddDatasetLabelsDetails) – (required) Details for adding Labels to the LabelSet of the Dataset.
- opc_retry_token (str) – (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.
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use add_dataset_labels API.
-
change_dataset_compartment
(dataset_id, change_dataset_compartment_details, **kwargs)¶ Moves a Dataset resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- change_dataset_compartment_details (oci.data_labeling_service.models.ChangeDatasetCompartmentDetails) – (required) Details for changing the compartment of a Dataset
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_dataset_compartment API.
-
create_dataset
(create_dataset_details, **kwargs)¶ Creates a new Dataset.
Parameters: - create_dataset_details (oci.data_labeling_service.models.CreateDatasetDetails) – (required) Details for the new Dataset.
- opc_retry_token (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_dataset API.
-
delete_dataset
(dataset_id, **kwargs)¶ Deletes a Dataset resource by identifier
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_dataset API.
-
generate_dataset_records
(dataset_id, generate_dataset_records_details, **kwargs)¶ Generates Record resources from the Dataset’s data source
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- generate_dataset_records_details (oci.data_labeling_service.models.GenerateDatasetRecordsDetails) – (required) Details for generating Dataset records.
- opc_retry_token (str) – (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.
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use generate_dataset_records API.
-
get_dataset
(dataset_id, **kwargs)¶ Gets a Dataset by identifier
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use get_dataset API.
-
get_work_request
(work_request_id, **kwargs)¶ Gets the status of the work request with the given ID.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeWorkRequest
Return type: Example: Click here to see an example of how to use get_work_request API.
-
import_pre_annotated_data
(dataset_id, import_pre_annotated_data_details, **kwargs)¶ Imports records and annotations from dataset files into existing Dataset.
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- import_pre_annotated_data_details (oci.data_labeling_service.models.ImportPreAnnotatedDataDetails) – (required) Details for importing Dataset
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- opc_retry_token (str) – (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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use import_pre_annotated_data API.
-
list_annotation_formats
(compartment_id, **kwargs)¶ These are a static list in a given region.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- sort_order (str) –
(optional) The sort order to use, either ‘asc’ or ‘desc’.
Allowed values are: “ASC”, “DESC”
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAnnotationFormatCollection
Return type: Example: Click here to see an example of how to use list_annotation_formats API.
-
list_datasets
(compartment_id, **kwargs)¶ Returns a list of Datasets.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- id (str) – (optional) Unique Dataset OCID
- annotation_format (str) – (optional) A filter to return only resources that match the entire annotation format given.
- lifecycle_state (str) –
(optional) A filter to return only resources whose lifecycleState matches this query param.
Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, “FAILED”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- sort_order (str) –
(optional) The sort order to use, either ‘asc’ or ‘desc’.
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(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”
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDatasetCollection
Return type: Example: Click here to see an example of how to use list_datasets API.
-
list_work_request_errors
(work_request_id, **kwargs)¶ Return a (paginated) list of errors for a given work request.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- limit (int) – (optional) The maximum number of items to return.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeWorkRequestErrorCollection
Return type: Example: Click here to see an example of how to use list_work_request_errors API.
-
list_work_request_logs
(work_request_id, **kwargs)¶ Return a (paginated) list of logs for a given work request.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- limit (int) – (optional) The maximum number of items to return.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeWorkRequestLogEntryCollection
Return type: Example: Click here to see an example of how to use list_work_request_logs API.
-
list_work_requests
(compartment_id, **kwargs)¶ Lists the work requests in a compartment.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- work_request_id (str) – (optional) The ID of the asynchronous work request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- limit (int) – (optional) The maximum number of items to return.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeWorkRequestSummaryCollection
Return type: Example: Click here to see an example of how to use list_work_requests API.
-
remove_dataset_labels
(dataset_id, remove_dataset_labels_details, **kwargs)¶ 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.
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- remove_dataset_labels_details (oci.data_labeling_service.models.RemoveDatasetLabelsDetails) – (required) Details for removing Labels from the LabelSet of the Dataset.
- opc_retry_token (str) – (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.
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use remove_dataset_labels API.
-
rename_dataset_labels
(dataset_id, rename_dataset_labels_details, **kwargs)¶ 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.
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- rename_dataset_labels_details (oci.data_labeling_service.models.RenameDatasetLabelsDetails) – (required) Details for renaming Labels in the LabelSet of the Dataset.
- opc_retry_token (str) – (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.
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use rename_dataset_labels API.
-
snapshot_dataset
(dataset_id, snapshot_dataset_details, **kwargs)¶ 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.
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- snapshot_dataset_details (oci.data_labeling_service.models.SnapshotDatasetDetails) – (required) Details of creating a snapshot of the Dataset’s Records and Annotations
- opc_retry_token (str) – (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.
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use snapshot_dataset API.
-
update_dataset
(dataset_id, update_dataset_details, **kwargs)¶ Updates the Dataset
Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- update_dataset_details (oci.data_labeling_service.models.UpdateDatasetDetails) – (required) Details for updating a Dataset.
- if_match (str) – (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.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use update_dataset API.
-