persistent class %iKnow.Matching.MatchingProfile
extends %Persistent
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 CrcTotalMultiplier
as %Numeric [ InitialExpression = 1 ];
The total score of a CRC-level match is multiplied by this number.
• property DisorderMultiplier
as %Numeric [ InitialExpression = 0.7 ];
This multiplier is applied to the aggegate match score for a CRC, path or sentence
if the matched entities appear in a different order than in the dictionary term.
• property DomainId
as %Integer [ ReadOnly ];
The domain ID this Matching Profile is associated with. When 0, this profile can be
used across the namespace.
• 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 Name
as %String [ 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 PathTotalMultiplier
as %Numeric [ InitialExpression = 1 ];
The total score of a path-level match is multiplied by this number.
• property ProfileId
as %Integer [ ReadOnly ];
The ID of this profile. This will be a negative number for namespace-wide profiles (which
have DomainId = 0).
• 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 RelationshipScoreMultiplier
as %Numeric [ InitialExpression = 0.5 ];
The entity-level score of relationship entities will be multiplied by this modifier.
• 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 SentTotalMultiplier
as %Numeric [ InitialExpression = 1 ];
The total score of a sentence-level match is multiplied by this number.
• method ApplyProperties(pOtherProfile As %iKnow.Matching.MatchingProfile)
as %Status
Copies all non-ReadOnly property values of the supplied Matching Profile object
to the current object. This excludes ProfileId,
DomainId and Name.
• classmethod GetProfile(pDomainId As %Integer = 0, pProfileId As %Integer = "", pSC As %Status = $$$OK)
as %iKnow.Matching.MatchingProfile
Utility method to instantiate a Matching Profile. If passed a negative integer for
pProfileId, it will look for a namespace-wide Matching Profile (which means
DomainId is 0), otherwise it will take look in the domain
specified through pDomainId. If pProfileId is empty, the default
profile for this domain will be returned.
This is the recommended way of instantiating a
%iKnow.Matching.MatchingProfile object.
• classmethod GetProfileByName(pDomainId As %Integer = 0, pName As %String, pSC As %Status = $$$OK)
as %iKnow.Matching.MatchingProfile
Looks up a Matching Profile by name in the domain identified by pDomainId (or
in the set of cross-domain profiles if pDomainId = 0).
pName should be a nonempty string and can be prepended with the domain ID to
look into (overriding the value of pDomainId), separated by a colon. This
allows configuration settings to refer to a particular Matching Profile with a single
string. Matching Profiles without a name cannot be looked up through this method and
should be looked up by ID using GetProfile instead.
• index (PKINDEX on DomainId,ProfileId) [IdKey,PrimaryKey,Unique];
