ProximityAPI Class Reference

Inheritance diagram for ProximityAPI:

Collaboration diagram for ProximityAPI:

Static Public Member Functions
_.Library.Status	GetProfile (pResult, _.Library.Integer pDomainId, _.Library.String pEntity, _.Library.Integer pPage, _.Library.Integer pPageSize, _.iKnow.Filters.Filter pFilter, _.Library.List pSkipListIDs, _.Library.Boolean pUseStems)
_.Library.Status	GetProfileById (pResult, _.Library.Integer pDomainId, _.Library.Integer pEntUniId, _.Library.Integer pPage, _.Library.Integer pPageSize, _.iKnow.Filters.Filter pFilter, _.Library.List pSkipListIDs, _.Library.Boolean pUseStems)
	Returns the proximity profile for the entity represented by pEntUniId. More...
_.Library.Status	GetProfileBySource (pResult, _.Library.Integer pDomainId, _.Library.String pEntity, _.Library.String pExternalId, _.Library.Integer pPage, _.Library.Integer pPageSize)
	Returns the proximity profile for a given entity pEntity in source pExtId. More...
_.Library.Status	GetProfileBySourceId (pResult, _.Library.Integer pDomainId, _.Library.Integer pEntUniId, _.Library.Integer pSrcId, _.Library.Integer pPage, _.Library.Integer pPageSize)
	Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId. More...

Static Public Attributes
	GetProfileByIdRT = None

Detailed Description

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

Main class for retrieving proximity information sources.

Member Function Documentation

GetProfile()

_.Library.Status GetProfile (   pResult, _.Library.Integer  pDomainId, _.Library.String  pEntity, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.iKnow.Filters.Filter  pFilter, _.Library.List  pSkipListIDs, _.Library.Boolean  pUseStems  )

static

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.

GetProfileById()

_.Library.Status GetProfileById (   pResult, _.Library.Integer  pDomainId, _.Library.Integer  pEntUniId, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.iKnow.Filters.Filter  pFilter, _.Library.List  pSkipListIDs, _.Library.Boolean  pUseStems  )

static

Returns the proximity profile for the entity represented by pEntUniId.

See also <method>GetProfile</method>

When setting pUseStems to 1, the value of pEntUniId will be interpreted as a stem ID.

GetProfileBySource()

_.Library.Status GetProfileBySource (   pResult, _.Library.Integer  pDomainId, _.Library.String  pEntity, _.Library.String  pExternalId, _.Library.Integer  pPage, _.Library.Integer  pPageSize  )

static

Returns the proximity profile for a given entity pEntity in source pExtId.

See also <method>GetProfile</method> for a broader set of options.

GetProfileBySourceId()

_.Library.Status GetProfileBySourceId (   pResult, _.Library.Integer  pDomainId, _.Library.Integer  pEntUniId, _.Library.Integer  pSrcId, _.Library.Integer  pPage, _.Library.Integer  pPageSize  )

static

Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId.

See also <method>GetProfile</method> for a broader set of options.

Member Data Documentation

GetProfileByIdRT

GetProfileByIdRT = None

static

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

Main class for retrieving proximity information sources.