Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%iKnow.Semantics.ProximityAPI

class %iKnow.Semantics.ProximityAPI extends %Library.RegisteredObject

Main class for retrieving proximity information sources.

Method Inventory

Parameters

parameter GetProfileByIdRT = entUniId:%Integer,entity:%String,score:%Integer;
parameter GetProfileBySourceIdRT = entUniId:%Integer,entity:%String,score:%Integer;
parameter GetProfileBySourceRT = entUniId:%Integer,entity:%String,score:%Integer;
parameter GetProfileRT = entUniId:%Integer,entity:%String,score:%Integer;

Methods

classmethod GetProfile(ByRef pResult, pDomainId As %Integer, pEntity As %String, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %iKnow.Filters.Filter = "", pBlacklistIDs As %List = "") as %Status
Returns the proximity profile for the entity pEntity. This profile is calculated based on the aggregated distance to pEntity in all paths in the domain (when pFilter=""), optionally constrained to all paths in a specific set of sources (when pFilter!="")
classmethod GetProfileById(ByRef pResult, pDomainId As %Integer, pEntUniId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %iKnow.Filters.Filter = "", pBlacklistIDs As %List = "") as %Status
Returns the proximity profile for the entity represented by pEntUniId. See also GetProfile()
classmethod GetProfileBySource(ByRef pResult, pDomainId As %Integer, pEntity As %String, pExternalId As %String, pPage As %Integer = 1, pPageSize As %Integer = 10) as %Status
Returns the proximity profile for a given entity pEntity in source pExtId.
classmethod GetProfileBySourceId(ByRef pResult, pDomainId As %Integer, pEntUniId As %Integer, pSrcId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10) as %Status
Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab