DocumentMetadata¶
-
class
oci.data_labeling_service_dataplane.models.
DocumentMetadata
(**kwargs)¶ Bases:
oci.data_labeling_service_dataplane.models.record_metadata.RecordMetadata
Collection of metadata related to document record.
Attributes
RECORD_TYPE_DOCUMENT_METADATA
str(object=’’) -> str RECORD_TYPE_IMAGE_METADATA
str(object=’’) -> str RECORD_TYPE_TEXT_METADATA
str(object=’’) -> str job_id
Gets the job_id of this DocumentMetadata. record_type
Gets the record_type of this RecordMetadata. Methods
__init__
(**kwargs)Initializes a new DocumentMetadata object with values from keyword arguments. get_subtype
(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype. -
RECORD_TYPE_DOCUMENT_METADATA
= 'DOCUMENT_METADATA'¶
-
RECORD_TYPE_IMAGE_METADATA
= 'IMAGE_METADATA'¶
-
RECORD_TYPE_TEXT_METADATA
= 'TEXT_METADATA'¶
-
__init__
(**kwargs)¶ Initializes a new DocumentMetadata object with values from keyword arguments. The default value of the
record_type
attribute of this class isDOCUMENT_METADATA
and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):Parameters: - record_type (str) – The value to assign to the record_type property of this DocumentMetadata. Allowed values for this property are: “IMAGE_METADATA”, “TEXT_METADATA”, “DOCUMENT_METADATA”
- job_id (str) – The value to assign to the job_id property of this DocumentMetadata.
-
static
get_subtype
(object_dictionary)¶ Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
job_id
¶ Gets the job_id of this DocumentMetadata. Job id ocid of OCR batch call.
Returns: The job_id of this DocumentMetadata. Return type: str
-
record_type
¶ Gets the record_type of this RecordMetadata. The record type based on dataset format details. IMAGE_METADATA - Collection of metadata related to image record. TEXT_METADATA - Collection of metadata related to text record. DOCUMENT_METADATA - Collection of metadata related to document record.
Allowed values for this property are: “IMAGE_METADATA”, “TEXT_METADATA”, “DOCUMENT_METADATA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The record_type of this RecordMetadata. Return type: str
-