|
Class Reference
%iKnow.Matching.MatchingQAPI
|
|
![]() |
|||
Private Storage |
This is an automatically generated class, offering a functionally equivalent set of methods and queries as
See the classdocs for
|
|
|
Clears any matching-related logfiles for the specified 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.
Optionally, the matching results at the unique entity level (calculated by
MatchEntityUniques ) can be retained by setting keepEntUniMatches to 1.
Matches an individual source against the list of Dictionary IDs passed in dictIds. 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.
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.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.
|
Selects dictId As%Integer , dictItemId As%Integer , dictItemURI As%String (MAXLEN=32767), dictTermId As%String (MAXLEN=32767), dictTerm As%String (MAXLEN=32767), dictElementId As%String (MAXLEN=32767), type As%String (MAXLEN=32767), matchScore As%Numeric , matchedWordBits As%String (MAXLEN=32767), isScattered As%Boolean , formatOutput As%String (MAXLEN=32767)
Returns all potential matches for a given string.
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.
Selects dictId As%Integer , dictItemId As%Integer , dictItemURI As%String (MAXLEN=32767), dictTermId As%String (MAXLEN=32767), dictTerm As%String (MAXLEN=32767), dictElementId As%String (MAXLEN=32767), type As%String (MAXLEN=32767), matchScore As%Numeric , matchedWordBits As%String (MAXLEN=32767), isScattered As%Boolean , formatOutput As%String (MAXLEN=32767)
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.
Selects sourceId As%Integer , externalId As%String (MAXLEN=32767), errorMessage As%String (MAXLEN=32767), date As%Date
Returns any errors registered during the Matching process
Selects position As%Integer , entOccId As%Integer , entUniId As%Integer , literal As%String (MAXLEN=32767), role As%Integer , matchScore As%Numeric , dictElementId As%Integer , dictElement As%String (MAXLEN=32767), matchedWordBits As%String (MAXLEN=32767), isScattered As%Boolean , formatOutput As%String (MAXLEN=32767)
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.
Selects matchId As%Integer , dictId As%Integer , dictItemId As%Integer , dictItemURI As%String (MAXLEN=32767), dictTermId As%Integer , targetType As%String (MAXLEN=32767), targetId As%Integer , matchScore As%Numeric , matchingConceptCount As%Integer , matchingRelationCount As%Integer , partialMatchCount As%Integer , firstMatchedPosInPath As%Integer , lastMatchedPosInPath As%Integer , isOrdered As%Boolean
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.
Selects matchId As%Integer , dictTermId As%Integer , sourceId As%Integer , externalId As%String (MAXLEN=32767), targetType As%String (MAXLEN=32767), targetId As%Integer , targetUniId As%Integer , targetValue As%String (MAXLEN=32767), matchScore As%Numeric , matchingConceptCount As%Integer , matchingRelationCount As%Integer , partialMatchCount As%Integer , firstMatchedPosInPath As%Integer , lastMatchedPosInPath As%Integer , isOrdered As%Boolean
This query returns a list of 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).
Selects matchId As%Integer , dictTermId As%Integer , sourceId As%Integer , externalId As%String (MAXLEN=32767), targetType As%String (MAXLEN=32767), targetId As%Integer , targetUniId As%Integer , targetValue As%String (MAXLEN=32767), matchScore As%Numeric , matchingConceptCount As%Integer , matchingRelationCount As%Integer , partialMatchCount As%Integer , firstMatchedPosInPath As%Integer , lastMatchedPosInPath As%Integer , isOrdered As%Boolean
This query returns a list of 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).
Selects matchId As%Integer , dictId As%Integer , dictItemId As%Integer , dictItemURI As%String (MAXLEN=32767), dictTermId As%Integer , targetType As%String (MAXLEN=32767), targetId As%Integer , matchScore As%Numeric , matchingConceptCount As%Integer , matchingRelationCount As%Integer , partialMatchCount As%Integer , firstMatchedPosInPath As%Integer , lastMatchedPosInPath As%Integer , isOrdered As%Boolean
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.
Selects matchId As%Integer , dictId As%Integer , dictItemId As%Integer , dictItemURI As%String (MAXLEN=32767), dictTermId As%Integer , targetType As%String (MAXLEN=32767), targetId As%Integer , matchScore As%Numeric , matchingConceptCount As%Integer , matchingRelationCount As%Integer , partialMatchCount As%Integer , firstMatchedPosInPath As%Integer , lastMatchedPosInPath As%Integer , isOrdered As%Boolean
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.
Selects matchId As%Integer , dictId As%Integer , dictItemId As%Integer , dictItemURI As%String (MAXLEN=32767), dictTermId As%Integer , targetType As%String (MAXLEN=32767), targetId As%Integer , matchScore As%Numeric , matchingConceptCount As%Integer , matchingRelationCount As%Integer , partialMatchCount As%Integer , firstMatchedPosInPath As%Integer , lastMatchedPosInPath As%Integer , isOrdered As%Boolean
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.
Selects matchId As%Integer , dictId As%Integer , dictItemId As%Integer , dictItemURI As%String (MAXLEN=32767), dictTermId As%Integer , targetType As%String (MAXLEN=32767), targetId As%Integer , matchScore As%Numeric , matchingConceptCount As%Integer , matchingRelationCount As%Integer , partialMatchCount As%Integer , firstMatchedPosInPath As%Integer , lastMatchedPosInPath As%Integer , isOrdered As%Boolean
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.
Selects matchId As%Integer , dictId As%Integer , dictItemId As%Integer , dictItemURI As%String (MAXLEN=32767), dictTermId As%Integer , targetType As%String (MAXLEN=32767), targetId As%Integer , matchScore As%Numeric , matchingConceptCount As%Integer , matchingRelationCount As%Integer , partialMatchCount As%Integer , firstMatchedPosInPath As%Integer , lastMatchedPosInPath As%Integer , isOrdered As%Boolean
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.
Selects dictId As%Integer , dictItemId As%Integer , name As%String (MAXLEN=32767), URI As%String (MAXLEN=32767), frequency As%Integer , spread As%Integer , score As%Numeric
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.
Selects targetType As%Integer , targetUniId As%Integer , targetValue As%String (MAXLEN=32767), frequency As%Integer , spread As%Integer , bestScore As%Numeric
This query returns a list of 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).
Selects targetType As%Integer , targetUniId As%Integer , targetValue As%String (MAXLEN=32767), frequency As%Integer , spread As%Integer , bestScore As%Numeric
This query returns a list of 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).
Selects dictId As%Integer , dictionary As%String (MAXLEN=32767), matchCount As%Integer , totalScore As%Numeric
Returns summary information for all matches in a given source (identified by External ID), organized per Dictionary.
Selects dictId As%Integer , dictionary As%String (MAXLEN=32767), matchCount As%Integer , totalScore As%Numeric
Returns summary information for all matches in a given source (identified by Source ID), organized per Dictionary.
Selects dictId As%Integer , dictionary As%String (MAXLEN=32767), dictItemId As%Integer , item As%String (MAXLEN=32767), URI As%String (MAXLEN=32767), matchCount As%Integer , totalScore As%Numeric
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.
Selects dictId As%Integer , dictionary As%String (MAXLEN=32767), dictItemId As%Integer , item As%String (MAXLEN=32767), URI As%String (MAXLEN=32767), matchCount As%Integer , totalScore As%Numeric
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.