%iKnow.Matching.MatchingAPI
deprecated class %iKnow.Matching.MatchingAPI extends %iKnow.Queries.AbstractAPI
The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentationOpens in a new tab for more detail.
This is the main entry point for driving the iKnow Smart Matching mechanismsMethod Inventory
- ClearLogs()
- GetDictionaryMatches()
- GetDictionaryMatchesById()
- GetErrors()
- GetMatchElements()
- GetMatchesByCrcOcc()
- GetMatchesByDictionaryItemId()
- GetMatchesByDictionaryItemURI()
- GetMatchesByDictionaryTermId()
- GetMatchesByEntOcc()
- GetMatchesByPath()
- GetMatchesBySentence()
- GetMatchesBySource()
- GetMatchesBySourceId()
- GetSentenceIdForMatchTarget()
- GetSourceIdForMatchTarget()
- GetTopItems()
- GetTopMatchesByDictionaryItemId()
- GetTopMatchesByDictionaryItemURI()
- GetTopSourcesByDictionary()
- GetTopTermsByItemId()
- GetTotalDictionaryScoresBySource()
- GetTotalDictionaryScoresBySourceId()
- GetTotalItemScoresBySource()
- GetTotalItemScoresBySourceId()
- InvalidateMatchingResults()
- MatchEntityUniques()
- MatchSource()
- MatchSources()
Parameters
Methods
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 GetMatchesBySource() 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 %iKnow.Matching.MatchingProfile 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.
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 %iKnow.Matching.MatchingProfile 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.
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 %iKnow.Matching.Formats.Format 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.
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.
This query returns all the match occurrences for the Dictionary Item specified through dictItemId.
Specifying a %iKnow.Filters.Filter 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).
This query returns all the match occurrences for the Dictionary Item specified through dictItemURI.
Specifying a %iKnow.Filters.Filter 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).
This query returns all the match occurrences for the Dictionary Term specified through pDictTermId.
Specifying a %iKnow.Filters.Filter 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).
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.
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.
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.
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.
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.
Returns the Dictionary Items for which most matches have been found in this domain (optionally narrowed down through a %iKnow.Filters.Filter 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.
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 %iKnow.Filters.Filter 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).
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 %iKnow.Filters.Filter 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).
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.
For a given Dictionary Item, returns all its Dictionary Terms sorted by the number of matches they have, optionally narrowed down through a %iKnow.Filters.Filter 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
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.
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.
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="")
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
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 MatchSource() or MatchSources().
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.
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 %iKnow.Matching.MatchingProfile 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.
Matches all sources in the domain, optionally restricted to those satisfying the criteria of a %iKnow.Filters.Filter 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 %iKnow.Matching.MatchingProfile 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.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()