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

class tamr_toolbox.models.validation_check.ValidationCheck(passed, details)[source]

A dataclass for exchanging the results of validation checks.

Parameters

  • passed (bool) – A boolean indicating True if the validation check passed

  • details (Dict[str, Any]) – A JSON object containing more information about the results of the validation check

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

Parameters

  • UNIFIED_ATTRIBUTES (str) – artifact name for a schema mapping project

  • TRANSFORMATIONS (str) – artifact name for a schema mapping project

  • SMR_MODEL (str) – artifact name for a schema mapping project

  • RECORD_COMMENTS (str) – artifact name for a schema mapping project

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 project

  • TRANSFORMATIONS (str) – artifact name for a Mastering project

  • SMR_MODEL (str) – artifact name for a Mastering project

  • RECORD_COMMENTS (str) – artifact name for a Mastering project

  • MASTERING_CONFIGURATION (str) – artifact name for a Mastering project

  • USER_DEFINED_SIGNALS (str) – artifact name for a Mastering project

  • MASTERING_FUNCTIONS (str) – artifact name for a Mastering project

  • RECORD_PAIR_COMMENTS (str) – artifact name for a Mastering project

  • RECORD_PAIR_VERIFIED_LABELS (str) – artifact name for a Mastering project

  • RECORD_PAIR_UNVERIFIED_LABELS (str) – artifact name for a Mastering project

  • RECORD_PAIR_ASSIGNMENTS (str) – artifact name for a Mastering project

  • CLUSTERING_MODEL (str) – artifact name for a Mastering project

  • PUBLISHED_CLUSTERS (str) – artifact name for a Mastering project

  • CLUSTER_RECORD_VERIFICATIONS (str) – artifact name for a Mastering project

  • CLUSTER_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 project

  • TRANSFORMATIONS (str) – artifact name for a Categorization project

  • SMR_MODEL (str) – artifact name for a Categorization project

  • RECORD_COMMENTS (str) – artifact name for a Categorization project

  • CATEGORIZATION_CONFIGURATION (str) – artifact name for a Categorization project

  • CATEGORIZATION_FUNCTIONS (str) – artifact name for a Categorization project

  • CATEGORIZATION_VERIFIED_LABELS (str) – artifact name for a Categorization project

  • CATEGORIZATION_TAXONOMIES (str) – artifact name for a Categorization project

  • CATEGORIZATION_MODEL (str) – artifact name for a Categorization project

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

class tamr_toolbox.models.project_steps.MasteringSteps(value)[source]

Enum class for the steps of a mastering project

class tamr_toolbox.models.project_steps.GoldenRecordsSteps(value)[source]

Enum class for the steps of a golden records 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:

tamr_toolbox.models.attribute_type.from_json(data)[source]

Make an attribute type from JSON data (deserialize) :type data: Dict[str, Any] :param data: JSON data from Tamr server

Return type

Union[PrimitiveType, Array, Map, Record]

tamr_toolbox.models.attribute_type.to_json(attr_type)[source]

Serialize attribute type to JSON :type attr_type: Union[PrimitiveType, Array, Map, Record] :param attr_type: Attribute type to serialize

Return type

Dict[str, Any]