Skip to content

Result Models

These data models carry the output of collision inspection and broader similarity scans.

grawiki.similarity.models

Models for entity similarity and duplicate inspection.

EntitySimilarityResult dataclass

Similarity result set for one source entity.

Parameters:

Name Type Description Default
source Node

Entity node that was used as the similarity query.

required
hits list[NodeHit]

Ranked candidate matches for the source entity.

required

SemanticKeyCollisionCandidates dataclass

Similarity candidates generated for a duplicated semantic key group.

Parameters:

Name Type Description Default
semantic_key str

Semantic key shared by more than one persisted entity.

required
results list[EntitySimilarityResult]

Per-entity similarity results restricted to the collision group.

required

EntityDuplicateCandidates dataclass

Two-stage duplicate-candidate report for persisted entities.

Parameters:

Name Type Description Default
semantic_key_collisions dict[str, list[Node]]

Exact collision groups keyed by semantic key.

required
semantic_key_collision_candidates list[SemanticKeyCollisionCandidates]

Matcher-ranked candidates restricted to exact semantic-key collision groups.

required
similarity_candidates list[EntitySimilarityResult]

Matcher-ranked candidates found by the broader similarity scan.

required