MatchMetadata

alignment.MatchMetadata()

Provenance information for a match claim.

A match claim records who authored it and how confident that author is.

Attributes

Name	Type	Description
agent	Agent	The human or software :class:Agent that created this match.
certainty	float	Confidence level in [0, 1]. 1.0 = certain.

Examples

>>> meta = MatchMetadata(
...     agent=Agent(
...         name="analyst_jh",
...         type=AgentType.human,
...         identifier="https://orcid.org/0000-0001",
...     ),
...     certainty=1.0,
... )

>>> meta = MatchMetadata(
...     agent=Agent(name="dtw", type=AgentType.software, identifier="v2"),
...     certainty=0.85,
... )

Methods

Name	Description
from_dict	Deserialize from dictionary (agent rebuilt via Agent).
to_dict	Serialize to dictionary for storage.

from_dict

alignment.MatchMetadata.from_dict(data)

Deserialize from dictionary (agent rebuilt via Agent).

to_dict

alignment.MatchMetadata.to_dict()

Serialize to dictionary for storage.