HomeTamr Core GuidesTamr Core API Reference
Tamr Core GuidesTamr Core API ReferenceTamr Core TutorialsEnrichment API ReferenceSupport Help CenterLog In

Retrieve Bulk Match Results

Fetch match query record results for an operation ID

When given a operationId, and assuming the operation has finished running, this endpoint will return the results of a bulk match query (as suggestedLabel), with additional data about the records ingested, the records to match against, similarity scores for each attribute, and whether the resulting pair is considered high impact.

🚧

If the bulk match operation is not yet completed, you will recieve a 404 error with a message that the operation is still running.

Response Fields

A list of all results will be returned, and the fields contained in the results will depend on whether the match was against records or clusters. For records, all pairs containing the new record and their results are returned. For clusters, all clusters the pair matched against are returned.

For records:

Field

Description

datasetName1

The name of the dataset with the bulk records to match

transactionId1

ID of the first record in Tamr, in the project

datasetName2

The name of the dataset in Tamr that you matched against

transactionId2

ID of the second record in Tamr, in the project

originDatasetName1

Which source dataset the first record came from

originTransactionId1

ID of the first record in its origin dataset

originDatasetName2

Which source dataset the second record came from

originTransactionId2

ID of the second record in its origin dataset

suggestedLabel

The result that Tamr suggests

suggestedLabelConfidence

Tamr's confidence in the suggested Label, from [0,1] inclusive

attributeSimilarityScores

A list of similarity scores of each of the unified attributes included in machine learning in the project

highImpact

Whether the transaction is considered high impact by Tamr, true or false

For clusters:

Field

Description

sourceId

The name of the source the new record belongs to. Default matchSource

entityId

The ID of the new record

clusterId

The ID of the cluster the record matched with

avgMatchProb

The average of each of the pairwise matches across the cluster with the new record. A measure of how confident the match is

Language