Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%iKnow] >  [Semantics] >  [ProximityAPI]
Private  Storage   

deprecatedclass %iKnow.Semantics.ProximityAPI extends %iKnow.Queries.AbstractAPI

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

Main class for retrieving proximity information sources.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 8


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
GetProfile GetProfileById GetProfileBySource GetProfileBySourceId


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 = "", pSkipListIDs As %List = "", pUseStems As %Boolean = 0) as %Status

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.

• classmethod GetProfileById(ByRef pResult, pDomainId As %Integer, pEntUniId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %iKnow.Filters.Filter = "", pSkipListIDs As %List = "", pUseStems As %Boolean = 0) as %Status
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.
• 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. See also GetProfile for a broader set of options.
• 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. See also GetProfile for a broader set of options.

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.