Home > Class Reference > ENSLIB namespace > %iKnow.Semantics.ProximityQAPI
Private  Storage   

%iKnow.Semantics.ProximityQAPI


class %iKnow.Semantics.ProximityQAPI extends %iKnow.Queries.AbstractQAPI

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Semantics.ProximityAPI, exposed as SqlProc methods.

See the classdocs for %iKnow.Semantics.ProximityAPI for more information.

This class was generated by %iKnow.Semantics.ProximityAPI.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
6


Summary


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


Queries


• query GetProfile(pDomainId As %Integer, pEntity As %String(MAXLEN=32767), pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pBlacklistIDs As %String(MAXLEN=32767)="", pUseStems As %Boolean = 0)
Selects entUniId As %Integer, entity As %String(MAXLEN=32767), score As %Integer

Returns the proximity profile for the entity or list of entities supplied through pEntity. This profile is calculated based on the aggregated distance to pEntity entries in all paths in the domain (when pFilter=""), optionally constrained to all paths in a specific set of sources (when pFilter!="").

When setting pUseStems to 1, for a domain that has stemming enabled, the scope of the profile will be expanded to include all actual forms of the supplied pEntity (which has to be provided as a base form (stem)!), and their combined proximity profiles will be grouped to the stem level again.

• query GetProfileById(pDomainId As %Integer, pEntUniId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pBlacklistIDs As %String(MAXLEN=32767)="", pUseStems As %Boolean = 0)
Selects entUniId As %Integer, entity As %String(MAXLEN=32767), score As %Integer
Returns the proximity profile for the entity represented by pEntUniId. See also GetProfile When setting pUseStems to 1, the value of pEntUniId will be interpreted as a stem ID.
• query GetProfileBySource(pDomainId As %Integer, pEntity As %String(MAXLEN=32767), pExternalId As %String(MAXLEN=32767), pPage As %Integer = 1, pPageSize As %Integer = 10)
Selects entUniId As %Integer, entity As %String(MAXLEN=32767), score As %Integer
Returns the proximity profile for a given entity pEntity in source pExtId. See also GetProfile for a broader set of options.
• query GetProfileBySourceId(pDomainId As %Integer, pEntUniId As %Integer, pSrcId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10)
Selects entUniId As %Integer, entity As %String(MAXLEN=32767), score As %Integer
Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId. See also GetProfile for a broader set of options.