Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%iKnow] >  [Model] >  [matchingProfile]
Private  Storage   

class %iKnow.Model.matchingProfile extends %iKnow.Model.node

Model representation of a Matching Profile to use for matching sources against dictionaries. See also %iKnow.Matching.MatchingProfile.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 14 1


Summary

Properties
crcTotalMultiplier disabled disorderMultiplier matching
minMatchedConceptFraction minimalMatchScore name negationMultiplier
pathRelevantScoreMultiplier pathTotalMultiplier relationshipLengthMultiplier relationshipScoreMultiplier
scatteredMatchMultiplier sentTotalMultiplier

Methods
%AddToSaveSet %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %QuoteList %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %SerializeObject %SetModified %Validate
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Parameters

• parameter XMLNAME = "profile";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

• property crcTotalMultiplier as %Numeric(XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 1 ];
The total score of a CRC-level match is multiplied by this number.
• property disabled as %Boolean(XMLPROJECTION="attribute");
If set to 1, this element is ignored when compiling, validating and building the domain
• property disorderMultiplier as %Numeric(XMLPROJECTION="ATTRIBUTE") [ 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.
• relationship matching as %iKnow.Model.matching(XMLPROJECTION="none") [ Inverse = profiles,Cardinality = one ];
Link to the <matching> element this profile belongs to.
• property minMatchedConceptFraction as %Numeric(XMLPROJECTION="ATTRIBUTE") [ 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 minimalMatchScore as %Numeric(XMLPROJECTION="ATTRIBUTE") [ 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(MAXLEN=50,XMLPROJECTION="ATTRIBUTE");
• property negationMultiplier as %Numeric(XMLPROJECTION="ATTRIBUTE") [ 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 pathRelevantScoreMultiplier as %Numeric(XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 0.33 ];
The entity-level score of path-relevant entities will be multiplied by this modifier.
• property pathTotalMultiplier as %Numeric(XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 1 ];
The total score of a path-level match is multiplied by this number.
• property relationshipLengthMultiplier as %Numeric(XMLPROJECTION="ATTRIBUTE") [ 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(XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 0.5 ];
The entity-level score of relationship entities will be multiplied by this modifier.
• property scatteredMatchMultiplier as %Numeric(XMLPROJECTION="ATTRIBUTE") [ 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(XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 1 ];
The total score of a sentence-level match is multiplied by this number.

Methods

• method %Validate(pDomainId As %Integer, pDomainDefinition As %iKnow.Model.domain) as %Status


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.