Home > Class Reference > ENSLIB namespace > %iKnow.Matching.MatchingProfile

%iKnow.Matching.MatchingProfile

persistent class %iKnow.Matching.MatchingProfile extends %Library.Persistent

SQL Table Name: %iKnow_Matching.MatchingProfile

This class represents the parameters controlling the match score calculation resulting from the iKnow Smart Matching process driven from the %iKnow.Matching.MatchingAPI.

A Matching Profile can be linked to a domain, or just exist "namespace-wide", when setting the DomainId property to 0. In the latter case, the profile is typically referred to with a negative value for its ProfileId.

Use GetProfile() to retrieve or instantiate a profile object.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property CrcTotalMultiplier as %Numeric [ InitialExpression = 1 ];
The total score of a CRC-level match is multiplied by this number.
Property methods: CrcTotalMultiplierDisplayToLogical(), CrcTotalMultiplierGet(), CrcTotalMultiplierIsValid(), CrcTotalMultiplierLogicalToDisplay(), CrcTotalMultiplierNormalize(), CrcTotalMultiplierSet()
property DisorderMultiplier as %Numeric [ InitialExpression = 0.7 ];
This multiplier is applied to the aggregate match score for a CRC, path or sentence if the matched entities appear in a different order than in the dictionary term.
Property methods: DisorderMultiplierDisplayToLogical(), DisorderMultiplierGet(), DisorderMultiplierIsValid(), DisorderMultiplierLogicalToDisplay(), DisorderMultiplierNormalize(), DisorderMultiplierSet()
property DomainId as %Integer [ Required , ReadOnly ];
The domain ID this Matching Profile is associated with. When 0, this profile can be used across the namespace.
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize()
property MinMatchedConceptFraction as %Numeric [ InitialExpression = 0 ];
Use this parameter to add an additional requirement on the number of concepts from the Dictionary Term that should be matched for an aggregate match to be considered. A value of 1 (100%) implies all concepts should be matched. A value of at least 0.51 for example means both concepts in a CRC should match. A value of 0 (default) does not impose additional restrictions.
Property methods: MinMatchedConceptFractionDisplayToLogical(), MinMatchedConceptFractionGet(), MinMatchedConceptFractionIsValid(), MinMatchedConceptFractionLogicalToDisplay(), MinMatchedConceptFractionNormalize(), MinMatchedConceptFractionSet()
property MinimalMatchScore as %Numeric [ InitialExpression = 0.33 ];
This is the lower threshold for match scores. Matches having a total score less than MinimalMatchScore will not be stored or returned.
Property methods: MinimalMatchScoreDisplayToLogical(), MinimalMatchScoreGet(), MinimalMatchScoreIsValid(), MinimalMatchScoreLogicalToDisplay(), MinimalMatchScoreNormalize(), MinimalMatchScoreSet()
property Name as %String (MAXLEN = 150) [ ReadOnly ];
A name for this profile. This name should be unique within the domain (case-insensitive) and cannot contain colons. For backwards compatibility, empty names are permitted, but these profiles cannot be retrieved with GetProfileByName()
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize()
property NegationMultiplier as %Numeric [ InitialExpression = 1 ];
Use this parameter to modify the score of matched entities which are part of a negation. Typically, this value will be either 1, ignoring the fact an entity is part of a negation, or 0, which will make the algorithm skip these entities. Other positive numeric values are also accepted and just modify the entity-level score for the affected entities, causing them to be considered partial matches.
Property methods: NegationMultiplierDisplayToLogical(), NegationMultiplierGet(), NegationMultiplierIsValid(), NegationMultiplierLogicalToDisplay(), NegationMultiplierNormalize(), NegationMultiplierSet()
property PathRelevantScoreMultiplier as %Numeric [ InitialExpression = 0.33 ];
The entity-level score of path-relevant entities will be multiplied by this modifier.
Property methods: PathRelevantScoreMultiplierDisplayToLogical(), PathRelevantScoreMultiplierGet(), PathRelevantScoreMultiplierIsValid(), PathRelevantScoreMultiplierLogicalToDisplay(), PathRelevantScoreMultiplierNormalize(), PathRelevantScoreMultiplierSet()
property PathTotalMultiplier as %Numeric [ InitialExpression = 1 ];
The total score of a path-level match is multiplied by this number.
Property methods: PathTotalMultiplierDisplayToLogical(), PathTotalMultiplierGet(), PathTotalMultiplierIsValid(), PathTotalMultiplierLogicalToDisplay(), PathTotalMultiplierNormalize(), PathTotalMultiplierSet()
property ProfileId as %Integer [ Required , ReadOnly ];
The ID of this profile. This will be a negative number for namespace-wide profiles (which have DomainId = 0).
Property methods: ProfileIdDisplayToLogical(), ProfileIdGet(), ProfileIdIsValid(), ProfileIdLogicalToDisplay(), ProfileIdNormalize()
property RelationshipLengthMultiplier as %Numeric [ InitialExpression = 0.2 ];
When calculating an aggregate match score for a CRC, path or sentence, the "length" of the matched section is compared to the total "length" of the CRC, path or sentence. This "length" is calculated taking a value of 1 for each concept and a value of RelationshipLengthMultiplier for each relationship. Therefore, setting this property to a lower value will decrease the weight of relationship entities in calculating this ratio.
Property methods: RelationshipLengthMultiplierDisplayToLogical(), RelationshipLengthMultiplierGet(), RelationshipLengthMultiplierIsValid(), RelationshipLengthMultiplierLogicalToDisplay(), RelationshipLengthMultiplierNormalize(), RelationshipLengthMultiplierSet()
property RelationshipScoreMultiplier as %Numeric [ InitialExpression = 0.5 ];
The entity-level score of relationship entities will be multiplied by this modifier.
Property methods: RelationshipScoreMultiplierDisplayToLogical(), RelationshipScoreMultiplierGet(), RelationshipScoreMultiplierIsValid(), RelationshipScoreMultiplierLogicalToDisplay(), RelationshipScoreMultiplierNormalize(), RelationshipScoreMultiplierSet()
property ScatteredMatchMultiplier as %Numeric [ InitialExpression = 0.75 ];
The entity-level score of scattered entity matches will be multiplied by this modifier. For example when matching the entity "blue big car" against the term "big blue car", The initial score of 1 (as all words in the entity are matched) will be multiplied with ScatteredMatchMultiplier
Property methods: ScatteredMatchMultiplierDisplayToLogical(), ScatteredMatchMultiplierGet(), ScatteredMatchMultiplierIsValid(), ScatteredMatchMultiplierLogicalToDisplay(), ScatteredMatchMultiplierNormalize(), ScatteredMatchMultiplierSet()
property SentTotalMultiplier as %Numeric [ InitialExpression = 1 ];
The total score of a sentence-level match is multiplied by this number.
Property methods: SentTotalMultiplierDisplayToLogical(), SentTotalMultiplierGet(), SentTotalMultiplierIsValid(), SentTotalMultiplierLogicalToDisplay(), SentTotalMultiplierNormalize(), SentTotalMultiplierSet()

Methods (Including Private)

private method %OnBeforeSave(insert As %Boolean) as %Status
Inherited description: This callback method is invoked by the %Save() method to provide notification that the object is being saved. It is called before any data is written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save() will fail.