DataLabelingClient

class oci.data_labeling_service_dataplane.DataLabelingClient(config, **kwargs)

Use Data Labeling API to create Annotations on Images, Texts & Documents, and generate snapshots.

Methods

__init__(config, **kwargs) Creates a new service client
create_annotation(create_annotation_details, …) Creates an annotation.
create_record(create_record_details, **kwargs) Creates a record.
delete_annotation(annotation_id, **kwargs) It deletes an annotation resource by identifier.
delete_record(record_id, **kwargs) Deletes a record resource by identifier.
get_annotation(annotation_id, **kwargs) Gets an annotation.
get_dataset(dataset_id, **kwargs) Gets a dataset by identifier.
get_record(record_id, **kwargs) Gets a record.
get_record_content(record_id, **kwargs) Retrieves the content of the record from the dataset source.
get_record_preview_content(record_id, **kwargs) Retrieves the preview of the record content from the dataset source.
list_annotations(compartment_id, dataset_id, …) Returns a list of annotations.
list_records(compartment_id, dataset_id, …) The list of records in the specified compartment.
summarize_annotation_analytics(…) Summarize the annotations created for a given dataset.
summarize_record_analytics(compartment_id, …) Summarize the records created for a given dataset.
update_annotation(annotation_id, …) Updates an annotation.
update_record(record_id, …) Updates a record.
__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, a dict can be passed. You can validate_config the dict using validate_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 convenience DEFAULT_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.
  • 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.
create_annotation(create_annotation_details, **kwargs)

Creates an annotation.

Parameters:
  • create_annotation_details (oci.data_labeling_service_dataplane.models.CreateAnnotationDetails) – (required) Details for the new CreateAnnotation.
  • opc_retry_token (str) – (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 (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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 Annotation

Return type:

Response

Example:

Click here to see an example of how to use create_annotation API.

create_record(create_record_details, **kwargs)

Creates a record.

Parameters:
  • create_record_details (oci.data_labeling_service_dataplane.models.CreateRecordDetails) – (required) The details for the new record.
  • opc_retry_token (str) – (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 (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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 Record

Return type:

Response

Example:

Click here to see an example of how to use create_record API.

delete_annotation(annotation_id, **kwargs)

It deletes an annotation resource by identifier.

Parameters:
  • annotation_id (str) – (required) A unique annotation identifier.
  • 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 is 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 None

Return type:

Response

Example:

Click here to see an example of how to use delete_annotation API.

delete_record(record_id, **kwargs)

Deletes a record resource by identifier.

Parameters:
  • record_id (str) – (required) The OCID of the record annotated.
  • 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 is 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 None

Return type:

Response

Example:

Click here to see an example of how to use delete_record API.

get_annotation(annotation_id, **kwargs)

Gets an annotation.

Parameters:
  • annotation_id (str) – (required) A unique annotation identifier.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 Annotation

Return type:

Response

Example:

Click here to see an example of how to use get_annotation API.

get_dataset(dataset_id, **kwargs)

Gets a dataset by identifier.

Parameters:
  • dataset_id (str) – (required) A 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 Dataset

Return type:

Response

Example:

Click here to see an example of how to use get_dataset API.

get_record(record_id, **kwargs)

Gets a record.

Parameters:
  • record_id (str) – (required) The OCID of the record annotated.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 Record

Return type:

Response

Example:

Click here to see an example of how to use get_record API.

get_record_content(record_id, **kwargs)

Retrieves the content of the record from the dataset source.

Parameters:
  • record_id (str) – (required) The OCID of the record annotated.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_none_match (str) – (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.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 stream

Return type:

Response

Example:

Click here to see an example of how to use get_record_content API.

get_record_preview_content(record_id, **kwargs)

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

Parameters:
  • record_id (str) – (required) The OCID of the record annotated.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_none_match (str) – (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.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 stream

Return type:

Response

Example:

Click here to see an example of how to use get_record_preview_content API.

list_annotations(compartment_id, dataset_id, **kwargs)

Returns a list of annotations.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • dataset_id (str) – (required) Filter the results by the OCID of the dataset.
  • lifecycle_state (str) –

    (optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.

    Allowed values are: “ACTIVE”, “INACTIVE”, “DELETED”

  • id (str) – (optional) The unique OCID identifier.
  • updated_by (str) – (optional) The OCID of the principal which updated the annotation.
  • record_id (str) – (optional) The OCID of the record annotated.
  • time_created_greater_than_or_equal_to (datetime) – (optional) The date and time the resource was created, in the timestamp format defined by RFC3339.
  • time_created_less_than_or_equal_to (datetime) – (optional) The date and time the resource was created, in the timestamp format defined by RFC3339.
  • 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. 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 (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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 AnnotationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_annotations API.

list_records(compartment_id, dataset_id, **kwargs)

The list of records in the specified compartment.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • dataset_id (str) – (required) Filter the results by the OCID of the dataset.
  • lifecycle_state (str) –

    (optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.

    Allowed values are: “ACTIVE”, “INACTIVE”, “DELETED”

  • name (str) – (optional) The name of the record.
  • id (str) – (optional) The unique OCID identifier.
  • is_labeled (bool) – (optional) Whether the record has been labeled and has associated annotations.
  • annotation_labels_contains (list[str]) – (optional) Lets the user filter records based on the related annotations.
  • 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. 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 (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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 RecordCollection

Return type:

Response

Example:

Click here to see an example of how to use list_records API.

summarize_annotation_analytics(compartment_id, dataset_id, **kwargs)

Summarize the annotations created for a given dataset.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • dataset_id (str) – (required) Filter the results by the OCID of the dataset.
  • lifecycle_state (str) –

    (optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.

    Allowed values are: “ACTIVE”, “INACTIVE”, “DELETED”

  • label (str) – (optional) It summarizes annotations with the specified label.
  • 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. The default order is descending. If no value is specified, updatedBy is used by default.

    Allowed values are: “count”, “label”, “updatedBy”

  • annotation_group_by (str) –

    (optional) The field to group by. If no value is specified, updatedBy is used by default.

    Allowed values are: “updatedBy”, “label”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 AnnotationAnalyticsAggregationCollection

Return type:

Response

Example:

Click here to see an example of how to use summarize_annotation_analytics API.

summarize_record_analytics(compartment_id, dataset_id, **kwargs)

Summarize the records created for a given dataset.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • dataset_id (str) – (required) Filter the results by the OCID of the dataset.
  • lifecycle_state (str) –

    (optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.

    Allowed values are: “ACTIVE”, “INACTIVE”, “DELETED”

  • 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”

  • record_group_by (str) –

    (optional) The field to group by. If no value is specified isLabeled is used by default.

    Allowed values are: “isLabeled”, “annotationLabelContains”

  • sort_by (str) –

    (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 (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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 RecordAnalyticsAggregationCollection

Return type:

Response

Example:

Click here to see an example of how to use summarize_record_analytics API.

update_annotation(annotation_id, update_annotation_details, **kwargs)

Updates an annotation.

Parameters:
  • annotation_id (str) – (required) A unique annotation identifier.
  • update_annotation_details (oci.data_labeling_service_dataplane.models.UpdateAnnotationDetails) – (required) The information to be updated.
  • 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 is 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 Annotation

Return type:

Response

Example:

Click here to see an example of how to use update_annotation API.

update_record(record_id, update_record_details, **kwargs)

Updates a record.

Parameters:
  • record_id (str) – (required) The OCID of the record annotated.
  • update_record_details (oci.data_labeling_service_dataplane.models.UpdateRecordDetails) – (required) Information to be updated.
  • 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 is 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 Record

Return type:

Response

Example:

Click here to see an example of how to use update_record API.