MatchingAPI Class Reference

Inheritance diagram for MatchingAPI:

Collaboration diagram for MatchingAPI:

Static Public Member Functions
_.Library.Status	ClearLogs (_.Library.Integer domainId)
	Clears any matching-related logfiles for the specified domain.
_.Library.Status	GetDictionaryMatches (_.Library.Integer result, _.Library.Integer domainId, _.Library.String string, _.Library.List dictIds, _.Library.Integer page, _.Library.Integer pageSize, _.Library.Integer fullMatchOnly, _.iKnow.Matching.MatchingProfile profile, _.Library.String language, _.Library.Integer nGramMatches)
_.Library.Status	GetDictionaryMatchesById (_.Library.Integer result, _.Library.Integer domainId, _.Library.Integer entUniId, _.Library.List dictIds, _.Library.Integer page, _.Library.Integer pageSize, _.Library.Integer fullMatchOnly, _.iKnow.Matching.MatchingProfile profile, _.Library.String language)
_.Library.Status	GetErrors (result, _.Library.Integer domainId, _.Library.Date since)
	Returns any errors registered during the Matching process.
_.Library.Status	GetMatchElements (result, _.Library.Integer domainId, _.Library.Integer matchId, _.Library.Integer vSrcId)
_.Library.Status	GetMatchesByCrcOcc (result, _.Library.Integer domainId, _.Library.Integer crcOccId, _.Library.List dictIds, _.Library.Integer page, _.Library.Integer pageSize, _.Library.Boolean includeEntityMatches, _.Library.Boolean includePathMatches, _.Library.Boolean includeSentenceMatches)
_.Library.Status	GetMatchesByDictionaryItemId (result, _.Library.Integer domainId, _.Library.Integer dictItemId, _.Library.Integer page, _.Library.Integer pageSize, _.iKnow.Filters.Filter filter, _.Library.List targetTypes, _.Library.Boolean ensureMatched)
_.Library.Status	GetMatchesByDictionaryItemURI (result, _.Library.Integer domainId, _.Library.String dictItemURI, _.Library.Integer page, _.Library.Integer pageSize, _.iKnow.Filters.Filter filter, _.Library.List targetTypes, _.Library.Boolean xDomDicts)
_.Library.Status	GetMatchesByDictionaryTermId (pResult, _.Library.Integer pDomainId, _.Library.Integer pDictTermId, _.Library.Integer pPage, _.Library.Integer pPageSize, _.iKnow.Filters.Filter pFilter, _.Library.List pTargetTypes, _.Library.Boolean pEnsureMatched)
_.Library.Status	GetMatchesByEntOcc (result, _.Library.Integer domainId, _.Library.Integer entOccId, _.Library.List dictIds, _.Library.Integer page, _.Library.Integer pageSize, _.Library.Boolean includeCrcMatches, _.Library.Boolean includePathMatches, _.Library.Boolean includeSentenceMatches, _.Library.Integer vSrcId)
_.Library.Status	GetMatchesByPath (result, _.Library.Integer domainId, _.Library.Integer pathId, _.Library.List dictIds, _.Library.Integer page, _.Library.Integer pageSize, _.Library.Boolean includeEntityMatches, _.Library.Boolean includeCrcMatches, _.Library.Boolean includeSentenceMatches)
_.Library.Status	GetMatchesBySentence (result, _.Library.Integer domainId, _.Library.Integer sentenceId, _.Library.List dictIds, _.Library.Integer page, _.Library.Integer pageSize, _.Library.Boolean includeEntityMatches, _.Library.Boolean includeCrcMatches, _.Library.Boolean includePathMatches)
_.Library.Status	GetMatchesBySource (result, _.Library.Integer domainId, _.Library.String externalId, _.Library.List dictIds, _.Library.Integer page, _.Library.Integer pageSize)
_.Library.Status	GetMatchesBySourceId (result, _.Library.Integer domainId, _.Library.Integer srcId, _.Library.List dictIds, _.Library.Integer page, _.Library.Integer pageSize)
_.Library.Integer	GetSentenceIdForMatchTarget (_.Library.Integer domainId, _.Library.Integer targetType, _.Library.Integer targetId, _.Library.Integer vSrcId)
	Utility method to retrieve the Sentence ID for a given match target, as specified by its target type. More...
_.Library.Integer	GetSourceIdForMatchTarget (_.Library.Integer domainId, _.Library.Integer targetType, _.Library.Integer targetId)
	Utility method to retrieve the Source ID for a given match target, as specified by its target type. More...
_.Library.Status	GetTopItems (result, _.Library.Integer domainId, _.Library.Integer page, _.Library.Integer pageSize, _.iKnow.Filters.Filter filter, _.Library.List dictIds, _.Library.Integer sortType, _.Library.Integer vSrcId)
_.Library.Status	GetTopMatchesByDictionaryItemId (result, _.Library.Integer domainId, _.Library.Integer dictItemId, _.Library.Integer page, _.Library.Integer pageSize, _.iKnow.Filters.Filter filter, _.Library.List targetTypes, _.Library.Integer sortType)
_.Library.Status	GetTopMatchesByDictionaryItemURI (result, _.Library.Integer domainId, _.Library.String dictItemURI, _.Library.Integer page, _.Library.Integer pageSize, _.iKnow.Filters.Filter filter, _.Library.List targetTypes, _.Library.Integer sortType, _.Library.Boolean xDomDicts)
_.Library.Status	GetTopSourcesByDictionary (pResult, _.Library.Integer pDomainId, _.Library.List pDictIds, _.Library.Integer pPage, _.Library.Integer pPageSize, _.iKnow.Filters.Filter pFilter, _.Library.Integer pSortType, _.Library.Numeric pNormalizeLength)
_.Library.Status	GetTopTermsByItemId (pResult, _.Library.Integer pDomainId, _.Library.List pDictItemIds, _.iKnow.Filters.Filter pFilter, _.Library.Integer pSortType, _.Library.Integer vSrcId)
_.Library.Status	GetTotalDictionaryScoresBySource (result, _.Library.Integer domainId, _.Library.String externalId, _.Library.Integer sortType)
	Returns summary information for all matches in a given source (identified by External ID), organized per Dictionary.
_.Library.Status	GetTotalDictionaryScoresBySourceId (result, _.Library.Integer domainId, _.Library.Integer srcId, _.Library.Integer sortType)
	Returns summary information for all matches in a given source (identified by Source ID), organized per Dictionary.
_.Library.Status	GetTotalItemScoresBySource (result, _.Library.Integer domainId, _.Library.String externalId, _.Library.List dictIds, _.Library.Integer sortType)
_.Library.Status	GetTotalItemScoresBySourceId (result, _.Library.Integer domainId, _.Library.Integer srcId, _.Library.List dictIds, _.Library.Integer sortType)
_.Library.Status	InvalidateMatchingResults (_.Library.Integer domainId, _.Library.List dictIds, _.Library.Integer pMode)
_.Library.Status	MatchEntityUniques (_.Library.Integer domainId, _.Library.List dictIds, _.Library.Integer vSrcId)
_.Library.Status	MatchSource (_.Library.Integer domainId, _.Library.Integer srcId, _.Library.List dictIds, _.iKnow.Matching.MatchingProfile overrideProfile)
_.Library.Status	MatchSources (_.Library.Integer domainId, _.iKnow.Filters.Filter filter, _.Library.List dictIds, _.iKnow.Matching.MatchingProfile overrideProfile)

Static Public Attributes
	GetDictionaryMatchesByIdRT = None

Detailed Description

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

This is the main entry point for driving the iKnow Smart Matching mechanisms

Member Function Documentation

GetDictionaryMatches()

_.Library.Status GetDictionaryMatches ( _.Library.Integer  result, _.Library.Integer  domainId, _.Library.String  string, _.Library.List  dictIds, _.Library.Integer  page, _.Library.Integer  pageSize, _.Library.Integer  fullMatchOnly, _.iKnow.Matching.MatchingProfile  profile, _.Library.String  language, _.Library.Integer  nGramMatches  )

static

Returns all potential matches for a given string. This string is treated as if it

were a single entity and matched against single-entity Dictionary Terms. To find the matches for a full sentence, first index it and then call <method>GetMatchesBySource</method> using the source ID corresponding to the indexed sentence.

A Matching Profile to be used when calculating match scores can be specified either by passing in an <class>iKnow.Matching.MatchingProfile</class> object, or a Matching Profile ID. When passing in the ID, a negative number is treated as a namespace-wide profile, whereas a positive ID will be looked up within the context of the domain. If no profile is specified, the default profile for this domain will be used.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetDictionaryMatchesById()

_.Library.Status GetDictionaryMatchesById ( _.Library.Integer  result, _.Library.Integer  domainId, _.Library.Integer  entUniId, _.Library.List  dictIds, _.Library.Integer  page, _.Library.Integer  pageSize, _.Library.Integer  fullMatchOnly, _.iKnow.Matching.MatchingProfile  profile, _.Library.String  language  )

static

Returns all potential matches for the given entity ID.

A Matching Profile to be used when calculating match scores can be specified either by passing in an <class>iKnow.Matching.MatchingProfile</class> object, or a Matching Profile ID. When passing in the ID, a negative number is treated as a namespace-wide profile, whereas a positive ID will be looked up within the context of the domain. If no profile is specified, the default profile for this domain will be used.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetMatchElements()

_.Library.Status GetMatchElements (   result, _.Library.Integer  domainId, _.Library.Integer  matchId, _.Library.Integer  vSrcId  )

static

Returns a detailed overview of all the elements in the match target, be it an entity-level,

CRC-level or path-level match. The elements that are matched get annotated with the matched elements ID, value and eventually the output from a <class>iKnow.Matching.Formats.Format</class> class if it was responsible for the match.

If a Virtual Source ID is supplied, the query runs in the context of that virtual source.

GetMatchesByCrcOcc()

_.Library.Status GetMatchesByCrcOcc (   result, _.Library.Integer  domainId, _.Library.Integer  crcOccId, _.Library.List  dictIds, _.Library.Integer  page, _.Library.Integer  pageSize, _.Library.Boolean  includeEntityMatches, _.Library.Boolean  includePathMatches, _.Library.Boolean  includeSentenceMatches  )

static

Returns all the matches for the given CRC Occurrence. Use includeEntityMatches,

includePathMatches and includeSentenceMatches to also include any matches for the Entities this CRC is composed of and the Paths these Entities participate in.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetMatchesByDictionaryItemId()

_.Library.Status GetMatchesByDictionaryItemId (   result, _.Library.Integer  domainId, _.Library.Integer  dictItemId, _.Library.Integer  page, _.Library.Integer  pageSize, _.iKnow.Filters.Filter  filter, _.Library.List  targetTypes, _.Library.Boolean  ensureMatched  )

static

This query returns all the match occurrences for the Dictionary Item

specified through dictItemId.

Specifying a <class>iKnow.Filters.Filter</class> object as filter will restrict the search space to only those sources satisfying the filters criteria. Through targetTypes, the desired target types can be specified in a List (defaults to all types).

GetMatchesByDictionaryItemURI()

_.Library.Status GetMatchesByDictionaryItemURI (   result, _.Library.Integer  domainId, _.Library.String  dictItemURI, _.Library.Integer  page, _.Library.Integer  pageSize, _.iKnow.Filters.Filter  filter, _.Library.List  targetTypes, _.Library.Boolean  xDomDicts  )

static

This query returns all the match occurrences for the Dictionary Item

specified through dictItemURI.

Specifying a <class>iKnow.Filters.Filter</class> object as filter will restrict the search space to only those sources satisfying the filters criteria. Through targetTypes, the desired target types can be specified in a List (defaults to all types).

GetMatchesByDictionaryTermId()

_.Library.Status GetMatchesByDictionaryTermId (   pResult, _.Library.Integer  pDomainId, _.Library.Integer  pDictTermId, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.iKnow.Filters.Filter  pFilter, _.Library.List  pTargetTypes, _.Library.Boolean  pEnsureMatched  )

static

This query returns all the match occurrences for the Dictionary Term

specified through pDictTermId.

Specifying a <class>iKnow.Filters.Filter</class> object as pFilter will restrict the search space to only those sources satisfying the filters criteria. Through pTargetTypes, the desired target types can be specified in a List (defaults to all types).

GetMatchesByEntOcc()

_.Library.Status GetMatchesByEntOcc (   result, _.Library.Integer  domainId, _.Library.Integer  entOccId, _.Library.List  dictIds, _.Library.Integer  page, _.Library.Integer  pageSize, _.Library.Boolean  includeCrcMatches, _.Library.Boolean  includePathMatches, _.Library.Boolean  includeSentenceMatches, _.Library.Integer  vSrcId  )

static

Returns all the matches for the given Entity Occurrence. Use includeCrcMatches,

includePathMatches and includeSentenceMatches to also include any matches for the CRC, Path or Sentence in which this Entity Occurrences participates.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetMatchesByPath()

_.Library.Status GetMatchesByPath (   result, _.Library.Integer  domainId, _.Library.Integer  pathId, _.Library.List  dictIds, _.Library.Integer  page, _.Library.Integer  pageSize, _.Library.Boolean  includeEntityMatches, _.Library.Boolean  includeCrcMatches, _.Library.Boolean  includeSentenceMatches  )

static

Returns all the matches for the given Path. Use includeEntityMatches,

includeCRCMatches and includeSentenceMatches to also include any matches for the Entities this path is composed of and the CRCs or Sentences these Entities participate in.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetMatchesBySentence()

_.Library.Status GetMatchesBySentence (   result, _.Library.Integer  domainId, _.Library.Integer  sentenceId, _.Library.List  dictIds, _.Library.Integer  page, _.Library.Integer  pageSize, _.Library.Boolean  includeEntityMatches, _.Library.Boolean  includeCrcMatches, _.Library.Boolean  includePathMatches  )

static

Returns all the matches for the given Sentence. Use includeEntityMatches,

includeCrcMatches and includePathMatches to control which (target) types of matches should be included in the result.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetMatchesBySource()

_.Library.Status GetMatchesBySource (   result, _.Library.Integer  domainId, _.Library.String  externalId, _.Library.List  dictIds, _.Library.Integer  page, _.Library.Integer  pageSize  )

static

Returns all the matches for the given Source, as identified by its external ID.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetMatchesBySourceId()

_.Library.Status GetMatchesBySourceId (   result, _.Library.Integer  domainId, _.Library.Integer  srcId, _.Library.List  dictIds, _.Library.Integer  page, _.Library.Integer  pageSize  )

static

Returns all the matches for the given Source, as identified by its Source ID (interpreted as a Virtual Source if a negative

value is supplied).

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetSentenceIdForMatchTarget()

_.Library.Integer GetSentenceIdForMatchTarget ( _.Library.Integer  domainId, _.Library.Integer  targetType, _.Library.Integer  targetId, _.Library.Integer  vSrcId  )

static

Utility method to retrieve the Sentence ID for a given match target, as specified by its target type.

(either of $$$DMTARGETENTITY, $$$DMTARGETCRC, $$$DMTARGETPATH or $$$DMTARGETSENT) and ID.

GetSourceIdForMatchTarget()

_.Library.Integer GetSourceIdForMatchTarget ( _.Library.Integer  domainId, _.Library.Integer  targetType, _.Library.Integer  targetId  )

static

Utility method to retrieve the Source ID for a given match target, as specified by its target type.

(either of $$$DMTARGETENTITY, $$$DMTARGETCRC, $$$DMTARGETPATH or $$$DMTARGETSENT) and ID.

GetTopItems()

_.Library.Status GetTopItems (   result, _.Library.Integer  domainId, _.Library.Integer  page, _.Library.Integer  pageSize, _.iKnow.Filters.Filter  filter, _.Library.List  dictIds, _.Library.Integer  sortType, _.Library.Integer  vSrcId  )

static

Returns the Dictionary Items for which most matches have been found in this domain (optionally

narrowed down through a <class>iKnow.Filters.Filter</class> object passed in through filter). Result sort order is controlled by sortType:

• $$$SORTBYFREQUENCY will sort by the number of actual matches for a Dictionary Item
• $$$SORTBYSPREAD will sort by the number of distinct documents in which at least one match for the Dictionary Item occurs.
• $$$SORTBYSCORE will sort by the total match score of all matches for a Dictionary Item

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetTopMatchesByDictionaryItemId()

_.Library.Status GetTopMatchesByDictionaryItemId (   result, _.Library.Integer  domainId, _.Library.Integer  dictItemId, _.Library.Integer  page, _.Library.Integer  pageSize, _.iKnow.Filters.Filter  filter, _.Library.List  targetTypes, _.Library.Integer  sortType  )

static

This query returns the "best" matching results for the Dictionary Item

specified through dictItemId, aggregated by matched unique target (entity, CRC, path or sentence). The meaning of "best" is defined by sortType: if set to $$$SORTBYFREQUENCY or $$$SORTBYSPREAD, results are sorted by decreasing number of matched occurrences, whereas $$$SORTBYSCORE will rank them according to the highest match score. The first two options will yield the most relevant results for entities and CRCs, with the score ranking a better fit for paths and sentences, as they inherently have frequency and spread equal to 1.

Specifying a <class>iKnow.Filters.Filter</class> object as filter will restrict the search space to only those sources satisfying the filters criteria. Through targetTypes, the desired target types can be specified in a List (defaults to all types).

GetTopMatchesByDictionaryItemURI()

_.Library.Status GetTopMatchesByDictionaryItemURI (   result, _.Library.Integer  domainId, _.Library.String  dictItemURI, _.Library.Integer  page, _.Library.Integer  pageSize, _.iKnow.Filters.Filter  filter, _.Library.List  targetTypes, _.Library.Integer  sortType, _.Library.Boolean  xDomDicts  )

static

This query returns the "best" matching results for the Dictionary Item

specified through dictItemURI, aggregated by matched unique target (entity, CRC, path or sentence). The meaning of "best" is defined by sortType: if set to $$$SORTBYFREQUENCY or $$$SORTBYSPREAD, results are sorted by decreasing number of matched occurrences, whereas $$$SORTBYSCORE will rank them according to the highest match score. The first two options will yield the most relevant results for entities and CRCs, with the score ranking a better fit for paths and sentences, as they inherently have frequency and spread equal to 1.

Specifying a <class>iKnow.Filters.Filter</class> object as filter will restrict the search space to only those sources satisfying the filters criteria. Through targetTypes, the desired target types can be specified in a List (defaults to all types).

GetTopSourcesByDictionary()

_.Library.Status GetTopSourcesByDictionary (   pResult, _.Library.Integer  pDomainId, _.Library.List  pDictIds, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.iKnow.Filters.Filter  pFilter, _.Library.Integer  pSortType, _.Library.Numeric  pNormalizeLength  )

static

Returns the sources best matching a given list of dictionaries specified through

pDictIds, optionally filtered through pFilter. "Best matching" is defined as having the highest number of matches (if pSortType = $$$SORTBYFREQUENCY) or the highest total match score (if pSortType = $$$SORTBYSCORE).

If pNormalizeLength is set to a nonzero value, this number is used as the power of the sources length in entities (occurrences) to normalize the score.

GetTopTermsByItemId()

_.Library.Status GetTopTermsByItemId (   pResult, _.Library.Integer  pDomainId, _.Library.List  pDictItemIds, _.iKnow.Filters.Filter  pFilter, _.Library.Integer  pSortType, _.Library.Integer  vSrcId  )

static

For a given Dictionary Item, returns all its Dictionary Terms sorted by the number of

matches they have, optionally narrowed down through a <class>iKnow.Filters.Filter</class> object passed in through pFilter). Result sort order is controlled by pSortType:

• $$$SORTBYFREQUENCY will sort by the number of actual matches for the Dictionary Term
• $$$SORTBYSPREAD will sort by the number of distinct documents in which at least one match for the Dictionary Term occurs.
• $$$SORTBYSCORE will sort by the total match score of all matches for a Dictionary Term

GetTotalItemScoresBySource()

_.Library.Status GetTotalItemScoresBySource (   result, _.Library.Integer  domainId, _.Library.String  externalId, _.Library.List  dictIds, _.Library.Integer  sortType  )

static

Returns summary information for all matches in a given source (identified by External ID), organized per Dictionary Item.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

GetTotalItemScoresBySourceId()

_.Library.Status GetTotalItemScoresBySourceId (   result, _.Library.Integer  domainId, _.Library.Integer  srcId, _.Library.List  dictIds, _.Library.Integer  sortType  )

static

Returns summary information for all matches in a given source (identified by Source ID), organized per Dictionary Item.

Specifying "" for dictIds will return results for all Dictionaries in this domain.

InvalidateMatchingResults()

_.Library.Status InvalidateMatchingResults ( _.Library.Integer  domainId, _.Library.List  dictIds, _.Library.Integer  pMode  )

static

Deletes all current matching results for the list of Dictionary IDs passed in dictIds.

Specifying "" for dictIds will drop results for all Dictionaries in this domain.

pMode can be used to specify whether to keep intermediary (not source-related) matching results as follows:

• 0: only source-related matching results are erased (default)
• 1: the matching results for unique entities are also erased
• 2: the matching results for unique entities and indexing results for dictionary terms are all erased (only available if dictIds="")

This parameter is mostly for internal use.

Note: pMode=2 will not erase the indexing results for dictionary terms of cross-domain dictionaries.
Note: matching results for virtual sources are always completely dropped, regardless of the value of dictIds and with the same effect as pMode=1

MatchEntityUniques()

_.Library.Status MatchEntityUniques ( _.Library.Integer  domainId, _.Library.List  dictIds, _.Library.Integer  vSrcId  )

static

Match the unique entities in this domain to all Dictionary Terms and Formats in the list of

Dictionaries specified through dictIds that haven't been matched in earlier operations. This method is called automatically at the start of a call to <method>MatchSource</method> or <method>MatchSources</method>.

Specifying "" for dictIds will match against all Dictionaries in this domain.

If a Virtual Source is specified, the entities of this Virtual Source will be matched.

MatchSource()

_.Library.Status MatchSource ( _.Library.Integer  domainId, _.Library.Integer  srcId, _.Library.List  dictIds, _.iKnow.Matching.MatchingProfile  overrideProfile  )

static

Matches an individual source against the list of Dictionary IDs passed in dictIds.

Use negative numbers to identify any cross-domain dictionaries to match against. A Matching Profile to calculate match scores can be specified either by passing in an <class>iKnow.Matching.MatchingProfile</class> object, or a Matching Profile ID. When passing in the ID, a negative number is treated as a namespace-wide profile, whereas a positive ID will be looked up within the context of the domain.

Specifying "" for dictIds will match against all Dictionaries in this domain and passing $$$ALLXDOMDICTIONARIES will match against all cross-domain dictionaries.

A negative Source ID is interpreted as a Virtual Source.

MatchSources()

_.Library.Status MatchSources ( _.Library.Integer  domainId, _.iKnow.Filters.Filter  filter, _.Library.List  dictIds, _.iKnow.Matching.MatchingProfile  overrideProfile  )

static

Matches all sources in the domain, optionally restricted to those satisfying the criteria of a

<class>iKnow.Filters.Filter</class> object provided as filter, against the list of Dictionary IDs passed in dictIds. Use negative numbers to mark cross-domain dictionaries.

A Matching Profile to calculate match scores can be specified either by passing in an <class>iKnow.Matching.MatchingProfile</class> object, or a Matching Profile ID. When passing in the ID, a negative number is treated as a namespace-wide profile, whereas a positive ID will be looked up within the context of the domain.

Specifying "" for dictIds will match against all Dictionaries in this domain and passing $$$ALLXDOMDICTIONARIES will match against all cross-domain dictionaries.

Member Data Documentation

GetDictionaryMatchesByIdRT

GetDictionaryMatchesByIdRT = None

static

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

This is the main entry point for driving the iKnow Smart Matching mechanisms