Home > Class Reference > ENSLIB namespace > %iKnow.Matching.MatchingWSAPI

%iKnow.Matching.MatchingWSAPI

class %iKnow.Matching.MatchingWSAPI extends %iKnow.Queries.AbstractWSAPI

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Matching.MatchingAPI, exposed as WebMethod methods.

See the classdocs for %iKnow.Matching.MatchingAPI for more information.

This class was generated by : %iKnow.Matching.MatchingAPI.cls

Method Inventory (Including Private)

Parameters

parameter NAMESPACE = http://www.intersystems.com/iKnow/Matching/MatchingWSAPI;
Inherited description: NAMESPACE - Should be an unique URI Override this parameter in the subclass with the unique namespace URI of your organization. Override this parameter in the subclass.
parameter SERVICENAME = iKnow.Matching.MatchingWSAPI;
Inherited description: SERVICENAME - Should be the name of the service for which this is a proxy. Override this parameter in the subclass.
parameter USECLASSNAMESPACES = 1;
Inherited description: When USECLASSNAMESPACES = 1, then the WSDL of the Web service reflects the namespaces defined for the referenced classes by the NAMESPACE parameters of those classes. The default, for compatibility with previous versions, is that the NAMESPACE parameters of the referenced classes are ignored when creating the WSDL. If USECLASSNAMESPACES has no value, then the default value from ^ISCSOAP("USECLASSNAMESPACES") is used.

Methods (Including Private)

classmethod ClearLogs(domainId As %Integer) as %Boolean [ WebMethod ]
Clears any matching-related logfiles for the specified domain.
classmethod GetDictionaryMatches(domainId As %Integer, string As %String, dictIds As %ListOfDataTypes = "", page As %Integer = 1, pageSize As %Integer = 10, fullMatchOnly As %Integer = -1, profile As %iKnow.Matching.MatchingProfile = "", language As %String = "", nGramMatches As %Integer = -1) as %XML.DataSet [ WebMethod ]

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.

classmethod GetDictionaryMatchesById(domainId As %Integer, entUniId As %Integer, dictIds As %ListOfDataTypes = "", page As %Integer = 1, pageSize As %Integer = 10, fullMatchOnly As %Integer = -1, profile As %iKnow.Matching.MatchingProfile = "", language As %String = "") as %XML.DataSet [ WebMethod ]

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.

classmethod GetErrors(domainId As %Integer, since As %Date = 0) as %XML.DataSet [ WebMethod ]
Returns any errors registered during the Matching process
classmethod GetMatchElements(domainId As %Integer, matchId As %Integer, vSrcId As %Integer = 0) as %XML.DataSet [ WebMethod ]

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.

classmethod GetMatchesByCrcOcc(domainId As %Integer, crcOccId As %Integer, dictIds As %ListOfDataTypes = "", page As %Integer = 1, pageSize As %Integer = 10, includeEntityMatches As %Boolean = 1, includePathMatches As %Boolean = 1, includeSentenceMatches As %Boolean = 1) as %XML.DataSet [ WebMethod ]

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.

classmethod GetMatchesByDictionaryItemId(domainId As %Integer, dictItemId As %Integer, page As %Integer = 1, pageSize As %Integer = 10, filter As %String(MAXLEN=32767)="", targetTypes As %ListOfDataTypes = "", ensureMatched As %Boolean = 1) as %XML.DataSet [ WebMethod ]

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).

classmethod GetMatchesByDictionaryItemURI(domainId As %Integer, dictItemURI As %String, page As %Integer = 1, pageSize As %Integer = 10, filter As %String(MAXLEN=32767)="", targetTypes As %ListOfDataTypes = "", xDomDicts As %Boolean = 0) as %XML.DataSet [ WebMethod ]

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).

classmethod GetMatchesByDictionaryTermId(pDomainId As %Integer, pDictTermId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pTargetTypes As %ListOfDataTypes = "", pEnsureMatched As %Boolean = 1) as