Models¶
Operation State¶
Enum representing operation states in Tamr
-
class
tamr_toolbox.models.operation_state.
OperationState
(value)[source]¶ A dataclass representing job state codes in Tamr
- Parameters
SUCCEEDED – Status when a job has completed successfully
FAILED – Status when a job has been terminated due to an error
CANCELED – Status when a job been terminated due to cancelation by a user or the job service
PENDING – Status when a job has been submitted and is waiting to begin running
RUNNING – Status when a job is active
Data Type¶
Custom types hints for Tamr
Project Type¶
Enum representing project types in Tamr
-
class
tamr_toolbox.models.project_type.
ProjectType
(value)[source]¶ A dataclass representing the project type codes in Tamr
- Parameters
SCHEMA_MAPPING_RECOMMENDATIONS – Schema Mapping Project Type
DEDUP – Mastering Project Type
GOLDEN_RECORDS – Golden Record Project Type
CATEGORIZATION – Categorization Project Type
Validation Check¶
Dataclass for validation check information
Project Artifacts¶
Project artifacts data classes
-
class
tamr_toolbox.models.project_artifacts.
SchemaMappingArtifacts
(UNIFIED_ATTRIBUTES='UNIFIED_ATTRIBUTES', TRANSFORMATIONS='TRANSFORMATIONS', SMR_MODEL='SMR_MODEL', RECORD_COMMENTS='RECORD_COMMENTS')[source]¶ A dataclass representing artifact codes for Schema Mapping projects in Tamr
-
class
tamr_toolbox.models.project_artifacts.
MasteringArtifacts
(UNIFIED_ATTRIBUTES='UNIFIED_ATTRIBUTES', TRANSFORMATIONS='TRANSFORMATIONS', SMR_MODEL='SMR_MODEL', RECORD_COMMENTS='RECORD_COMMENTS', MASTERING_CONFIGURATION='MASTERING_CONFIGURATION', USER_DEFINED_SIGNALS='USER_DEFINED_SIGNALS', MASTERING_FUNCTIONS='MASTERING_FUNCTIONS', RECORD_PAIR_COMMENTS='RECORD_PAIR_COMMENTS', RECORD_PAIR_VERIFIED_LABELS='RECORD_PAIR_VERIFIED_LABELS', RECORD_PAIR_UNVERIFIED_LABELS='RECORD_PAIR_UNVERIFIED_LABELS', RECORD_PAIR_ASSIGNMENTS='RECORD_PAIR_ASSIGNMENTS', CLUSTERING_MODEL='CLUSTERING_MODEL', PUBLISHED_CLUSTERS='PUBLISHED_CLUSTERS', CLUSTER_RECORD_VERIFICATIONS='CLUSTER_RECORD_VERIFICATIONS', CLUSTER_ASSIGNMENTS='CLUSTER_ASSIGNMENTS')[source]¶ A dataclass representing artifact codes for Mastering projects in Tamr
- Parameters
UNIFIED_ATTRIBUTES (
str
) – artifact name for a Mastering projectTRANSFORMATIONS (
str
) – artifact name for a Mastering projectSMR_MODEL (
str
) – artifact name for a Mastering projectRECORD_COMMENTS (
str
) – artifact name for a Mastering projectMASTERING_CONFIGURATION (
str
) – artifact name for a Mastering projectUSER_DEFINED_SIGNALS (
str
) – artifact name for a Mastering projectMASTERING_FUNCTIONS (
str
) – artifact name for a Mastering projectRECORD_PAIR_COMMENTS (
str
) – artifact name for a Mastering projectRECORD_PAIR_VERIFIED_LABELS (
str
) – artifact name for a Mastering projectRECORD_PAIR_UNVERIFIED_LABELS (
str
) – artifact name for a Mastering projectRECORD_PAIR_ASSIGNMENTS (
str
) – artifact name for a Mastering projectCLUSTERING_MODEL (
str
) – artifact name for a Mastering projectPUBLISHED_CLUSTERS (
str
) – artifact name for a Mastering projectCLUSTER_RECORD_VERIFICATIONS (
str
) – artifact name for a Mastering projectCLUSTER_ASSIGNMENTS (
str
) – artifact name for a Mastering project
-
class
tamr_toolbox.models.project_artifacts.
CategorizationArtifacts
(UNIFIED_ATTRIBUTES='UNIFIED_ATTRIBUTES', TRANSFORMATIONS='TRANSFORMATIONS', SMR_MODEL='SMR_MODEL', RECORD_COMMENTS='RECORD_COMMENTS', CATEGORIZATION_CONFIGURATION='CATEGORIZATION_CONFIGURATION', CATEGORIZATION_FUNCTIONS='CATEGORIZATION_FUNCTIONS', CATEGORIZATION_VERIFIED_LABELS='CATEGORIZATION_VERIFIED_LABELS', CATEGORIZATION_TAXONOMIES='CATEGORIZATION_TAXONOMIES', CATEGORIZATION_MODEL='CATEGORIZATION_MODEL', CATEGORIZATION_FEEDBACK='CATEGORIZATION_FEEDBACK')[source]¶ A dataclass representing artifact codes for Categorization projects in Tamr
- Parameters
UNIFIED_ATTRIBUTES (
str
) – artifact name for a Categorization projectTRANSFORMATIONS (
str
) – artifact name for a Categorization projectSMR_MODEL (
str
) – artifact name for a Categorization projectRECORD_COMMENTS (
str
) – artifact name for a Categorization projectCATEGORIZATION_CONFIGURATION (
str
) – artifact name for a Categorization projectCATEGORIZATION_FUNCTIONS (
str
) – artifact name for a Categorization projectCATEGORIZATION_VERIFIED_LABELS (
str
) – artifact name for a Categorization projectCATEGORIZATION_TAXONOMIES (
str
) – artifact name for a Categorization projectCATEGORIZATION_MODEL (
str
) – artifact name for a Categorization projectCATEGORIZATION_FEEDBACK (
str
) – artifact name for a Categorization project
-
class
tamr_toolbox.models.project_artifacts.
GoldenRecordsArtifacts
(GR_CONFIGURATION='GR_CONFIGURATION', GR_RULES='GR_RULES', GR_OVERRIDES='GR_OVERRIDES')[source]¶ A dataclass representing artifact codes for Golden Records projects in Tamr
GR_CONFIGURATION: artifact name for a Golden Records project GR_RULES: artifact name for a Golden Records project GR_OVERRIDES: artifact name for a Golden Records project
-
class
tamr_toolbox.models.project_artifacts.
ProjectArtifacts
[source]¶ A dataclass representing the project artifact codes in Tamr
- Parameters
SCHEMA_MAPPING – SchemaMappingArtifacts dataclass instance
MASTERING – MasteringArtifacts dataclass instance
CATEGORIZATION – MasteringArtifacts dataclass instance
GOLDEN_RECORDS – MasteringArtifacts dataclass instance
Project Steps¶
-
class
tamr_toolbox.models.project_steps.
CategorizationSteps
(value)[source]¶ Enum class for the steps of a classification project
-
class
tamr_toolbox.models.project_steps.
SchemaMappingSteps
(value)[source]¶ Enum class for the steps of a schema mapping project
Attribute Types¶
See https://docs.tamr.com/reference#attribute-types
-
tamr_toolbox.models.attribute_type.
BOOLEAN
= <PrimitiveType.BOOLEAN: 1>¶ An enumeration.
-
tamr_toolbox.models.attribute_type.
DOUBLE
= <PrimitiveType.DOUBLE: 2>¶ An enumeration.
-
tamr_toolbox.models.attribute_type.
INT
= <PrimitiveType.INT: 3>¶ An enumeration.
-
tamr_toolbox.models.attribute_type.
LONG
= <PrimitiveType.LONG: 4>¶ An enumeration.
-
tamr_toolbox.models.attribute_type.
STRING
= <PrimitiveType.STRING: 5>¶ An enumeration.
-
tamr_toolbox.models.attribute_type.
DEFAULT
: Union[tamr_toolbox.models.attribute_type.PrimitiveType, tamr_toolbox.models.attribute_type.Array, tamr_toolbox.models.attribute_type.Map, tamr_toolbox.models.attribute_type.Record] = Array(inner_type=<PrimitiveType.STRING: 5>)¶ //docs.tamr.com/reference#attribute-types .. note:
`sphinx_autodoc_typehints` cannot handle forward reference to `AttributeType`, so reference docs are written manually for this type
- Parameters
inner_type –
- Type
See https
-
tamr_toolbox.models.attribute_type.
GEOSPATIAL
: Union[tamr_toolbox.models.attribute_type.PrimitiveType, tamr_toolbox.models.attribute_type.Array, tamr_toolbox.models.attribute_type.Map, tamr_toolbox.models.attribute_type.Record] = Record(attributes=(SubAttribute(name='point', type=Array(inner_type=<PrimitiveType.DOUBLE: 2>), is_nullable=True), SubAttribute(name='multiPoint', type=Array(inner_type=Array(inner_type=<PrimitiveType.DOUBLE: 2>)), is_nullable=True), SubAttribute(name='lineString', type=Array(inner_type=Array(inner_type=<PrimitiveType.DOUBLE: 2>)), is_nullable=True), SubAttribute(name='multiLineString', type=Array(inner_type=Array(inner_type=Array(inner_type=<PrimitiveType.DOUBLE: 2>))), is_nullable=True), SubAttribute(name='polygon', type=Array(inner_type=Array(inner_type=Array(inner_type=<PrimitiveType.DOUBLE: 2>))), is_nullable=True), SubAttribute(name='multiPolygon', type=Array(inner_type=Array(inner_type=Array(inner_type=Array(inner_type=<PrimitiveType.DOUBLE: 2>)))), is_nullable=True)))¶ //docs.tamr.com/reference#attribute-types :param attributes:
- Type
See https
-
class
tamr_toolbox.models.attribute_type.
Array
(inner_type)¶ - Parameters
inner_type (
AttrType
) –
-
class
tamr_toolbox.models.attribute_type.
Map
(inner_type)¶ - Parameters
inner_type (
AttrType
) –
-
class
tamr_toolbox.models.attribute_type.
Record
(attributes)[source]¶ See https://docs.tamr.com/reference#attribute-types :type attributes:
Tuple
[SubAttribute
, …] :param attributes: