|
IRISLIB database
|
|
|
IRISLIB database
|
|
Static Public Attributes | |
| NAMESPACE = None | |
This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Matching.MatchingAPI</class>, exposed as WebMethod methods.
See the classdocs for <class>iKnow.Matching.MatchingAPI</class> for more information.
|
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.
|
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.
|
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.
|
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.
|
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).
|
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).
|
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).
|
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.
|
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.
|
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.
|
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.
|
static |
|
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.
|
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.
|
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:
Specifying "" for dictIds will return results for all Dictionaries in this domain.
|
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).
|
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).
|
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.
|
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:
|
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.
|
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.
|
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:
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
|
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.
|
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.
|
static |
This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Matching.MatchingAPI</class>, exposed as WebMethod methods.
See the classdocs for <class>iKnow.Matching.MatchingAPI</class> for more information.
1.9.1