Inheritance diagram for DominanceAPI:

Collaboration diagram for DominanceAPI:

Static Public Member Functions
_.Library.Status	BuildOverlap (_.Library.Integer domainid, _.iKnow.Filters.Filter filter)

_.Library.Status	FindBreakingSources (_.Library.Integer domainid)

_.Library.Status	FindMostTypicalSources (_.Library.Integer domainid)

_.Library.Status	GetAggregateOverlaps (result, _.Library.Integer domainid, _.Library.Integer type, _.iKnow.Filters.Filter set1, _.iKnow.Filters.Filter set2, _.Library.Integer page, _.Library.Integer pagesize)

_.Library.Status	GetBreakingSources (result, _.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.iKnow.Filters.Filter filter)

_.Library.Status	GetBySource (result, _.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.Library.Integer cutoff)

_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer type, _.Library.Integer cutoff, _.Library.Status sc)

_.Library.Numeric	GetDomainValue (_.Library.Integer domainid, _.Library.Integer id, _.Library.Integer type, _.Library.Status sc)

_.Library.Status	GetOverlap (result, _.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.iKnow.Filters.Filter filter)

_.Library.Status	GetOverlapDetails (result, _.Library.Integer domainid, _.Library.Integer id, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.iKnow.Filters.Filter filter)

_.Library.Status	GetProfileByDomain (result, _.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type)

_.Library.Status	GetProfileBySource (result, _.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.Library.Integer cutoff)

_.Library.Integer	GetProfileCountByDomain (_.Library.Integer domainid, _.Library.Integer type, _.Library.Status sc)

_.Library.Integer	GetProfileCountBySource (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer type, _.Library.Integer cutoff, _.Library.Status sc)

_.Library.Numeric	GetSourceValue (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer id, _.Library.Integer type, _.Library.Status sc)

_.Library.Status	GetSourcesByCorrelation (result, _.Library.Integer domainid, _.Library.List entids, _.Library.Integer page, _.Library.Integer pagesize, _.iKnow.Filters.Filter filter)

_.Library.Status	GetTop (pResult, _.Library.Integer pDomainId, _.Library.Integer pPage, _.Library.Integer pPageSize, _.iKnow.Filters.Filter pFilter, _.Library.String pAggregation, _.Library.Integer pEntRole, _.Library.List pSkipLists)

_.Library.Status	GetTypicalSources (result, _.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.iKnow.Filters.Filter filter)

Static Public Attributes
	GetAggregateOverlapsRT = None

	GetBreakingSourcesRT = None

	GetBySourceRT = None

	GetOverlapDetailsRT = None

	GetOverlapRT = None

	GetProfileByDomainRT = None

	GetProfileBySourceRT = None

	GetSourcesByCorrelationRT = None

	GetTypicalSourcesRT = None

Detailed Description

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

Main class for retrieving dominant terms from sources.

Member Function Documentation

◆ BuildOverlap()

_.Library.Status BuildOverlap	(	_.Library.Integer	domainid,
		_.iKnow.Filters.Filter	filter
	)

static

Builds overlap information of the dominant terms in all profiles of the sources in a domain. This can be restricted by using a filter.

Overlap information is needed for the following methods:

<method>GetOverlap</method>
<method>GetOverlapDetails</method>
<method>FindMostTypicalSources</method>
<method>FindBreakingSources</method>
<method>GetAggregateOverlaps</method>
<method>GetSourcesByCorrelation</method>

◆ FindBreakingSources()

_.Library.Status FindBreakingSources ( _.Library.Integer domainid )

static

Uses the overlap information generated by <method>BuildOverlap</method> to calculate breaking sources in a domain.

You can call <method>GetBreakingSources</method> to get the list of most breaking sources.

◆ FindMostTypicalSources()

_.Library.Status FindMostTypicalSources ( _.Library.Integer domainid )

static

Uses the overlap information generated by <method>BuildOverlap</method> to calculate typical sources in a domain.

You can call <method>GetTypicalSources</method> to get the list of most typical sources.

◆ GetAggregateOverlaps()

_.Library.Status GetAggregateOverlaps	(		result,
		_.Library.Integer	domainid,
		_.Library.Integer	type,
		_.iKnow.Filters.Filter	set1,
		_.iKnow.Filters.Filter	set2,
		_.Library.Integer	page,
		_.Library.Integer	pagesize
	)

static

Calculates the overlapping overlap of two sets of documents. First the overlap within set1 is calculated, then the overlap within

set2. Finally those are compared and the most overlapping elements within those 2 sets are returned.

◆ GetBreakingSources()

_.Library.Status GetBreakingSources	(		result,
		_.Library.Integer	domainid,
		_.Library.Integer	page,
		_.Library.Integer	pagesize,
		_.Library.Integer	type,
		_.iKnow.Filters.Filter	filter
	)

static

Returns the list of most breaking sources in a domain. The type parameter defines on which type of element you want the

list of breaking documents to be based. This can be:

$$$SDCONCEPT
$$$SDRELATION
$$$SDENTITY
$$$SDCRC

.

◆ GetBySource()

_.Library.Status GetBySource	(		result,
		_.Library.Integer	domainid,
		_.Library.Integer	srcid,
		_.Library.Integer	page,
		_.Library.Integer	pagesize,
		_.Library.Integer	type,
		_.Library.Integer	cutoff
	)

static

Returns all dominant elements for a specific source. The type of elements returned can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC, $$$SDPATH and $$$SDAGGREGATE.

The elements returned can be limited to those with a dominance value above average by setting the cutoff parameter to $$$SDABOVEAVERAGE.

◆ GetCountBySource()

_.Library.Integer GetCountBySource	(	_.Library.Integer	domainid,
		_.Library.Integer	srcid,
		_.Library.Integer	type,
		_.Library.Integer	cutoff,
		_.Library.Status	sc
	)

static

Returns the number of dominant terms found in a specific source. The type of elements counted can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC, $$$SDPATH and $$$SDAGGREGATE.

The number of elements counted can be limited to those with a dominance value above average by setting the cutoff parameter to $$$SDABOVEAVERAGE.

◆ GetDomainValue()

_.Library.Numeric GetDomainValue	(	_.Library.Integer	domainid,
		_.Library.Integer	id,
		_.Library.Integer	type,
		_.Library.Status	sc
	)

static

Returns the dominance value of an element within a specified domain. The id parameter takes either an entityId, crcId or pathId and the

type parameter defines of what type the id parameter is. Thus valid types are $$$SDCONCEPT, $$$SDCRC and $$$SDPATH.

◆ GetOverlap()

_.Library.Status GetOverlap	(		result,
		_.Library.Integer	domainid,
		_.Library.Integer	page,
		_.Library.Integer	pagesize,
		_.Library.Integer	type,
		_.iKnow.Filters.Filter	filter
	)

static

Returns the most overlapping elements in a domain. This can be restricted by type by setting the type parameter to any of those values:

$$$SDCONCEPT
$$$SDRELATION
$$$SDENTITY
$$$SDCRC

.

◆ GetOverlapDetails()

_.Library.Status GetOverlapDetails	(		result,
		_.Library.Integer	domainid,
		_.Library.Integer	id,
		_.Library.Integer	page,
		_.Library.Integer	pagesize,
		_.Library.Integer	type,
		_.iKnow.Filters.Filter	filter
	)

static

Returns the overlap details of an element in a domain. The type of the element must be specified through the type parameter to any of those values:

$$$SDCONCEPT
$$$SDRELATION
$$$SDENTITY
$$$SDCRC

.

◆ GetProfileByDomain()

_.Library.Status GetProfileByDomain	(		result,
		_.Library.Integer	domainid,
		_.Library.Integer	page,
		_.Library.Integer	pagesize,
		_.Library.Integer	type
	)

static

Returns the dominance profile for a complete domain. The type of elements returned can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC and $$$SDAGGREGATE.

◆ GetProfileBySource()

_.Library.Status GetProfileBySource	(		result,
		_.Library.Integer	domainid,
		_.Library.Integer	srcid,
		_.Library.Integer	page,
		_.Library.Integer	pagesize,
		_.Library.Integer	type,
		_.Library.Integer	cutoff
	)

static

Returns the dominance profile for a specific source. The type of elements returned can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC, $$$SDPATH and $$$SDAGGREGATE.

The elements returned can be limited to those with a dominance value above average by setting the cutoff parameter to $$$SDABOVEAVERAGE.

◆ GetProfileCountByDomain()

_.Library.Integer GetProfileCountByDomain	(	_.Library.Integer	domainid,
		_.Library.Integer	type,
		_.Library.Status	sc
	)

static

Returns the number of dominant terms in the profile of a complete domain. The type of elements counted can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC and $$$SDAGGREGATE.

◆ GetProfileCountBySource()

_.Library.Integer GetProfileCountBySource	(	_.Library.Integer	domainid,
		_.Library.Integer	srcid,
		_.Library.Integer	type,
		_.Library.Integer	cutoff,
		_.Library.Status	sc
	)

static

Returns the number of dominant terms in the profile of a specific source. The type of elements counted can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC, $$$SDPATH and $$$SDAGGREGATE.

The number of elements counted can be limited to those with a dominance value above average by setting the cutoff parameter to $$$SDABOVEAVERAGE.

◆ GetSourceValue()

_.Library.Numeric GetSourceValue	(	_.Library.Integer	domainid,
		_.Library.Integer	srcid,
		_.Library.Integer	id,
		_.Library.Integer	type,
		_.Library.Status	sc
	)

static

Returns the dominance value of an element within a specified source. The id parameter takes either an entityId, crcId or pathId and the

type parameter defines of what type the id parameter is. Thus valid types are $$$SDCONCEPT, $$$SDRELATIONM, $$$SDENTITY, $$$SDCRC and $$$SDPATH.

◆ GetSourcesByCorrelation()

_.Library.Status GetSourcesByCorrelation	(		result,
		_.Library.Integer	domainid,
		_.Library.List	entids,
		_.Library.Integer	page,
		_.Library.Integer	pagesize,
		_.iKnow.Filters.Filter	filter
	)

static

Returns a set of documents wich correlate closely to the input set (entids) of entities based on the dominance values of those entities

within the documents.

◆ GetTop()

_.Library.Status GetTop	(		pResult,
		_.Library.Integer	pDomainId,
		_.Library.Integer	pPage,
		_.Library.Integer	pPageSize,
		_.iKnow.Filters.Filter	pFilter,
		_.Library.String	pAggregation,
		_.Library.Integer	pEntRole,
		_.Library.List	pSkipLists
	)

static

Returns the top entities for this domain, sorted by their aggregated dominance values.

pAggregation defines how to aggregate the source-level values. Currently the only supported value is "AVG", which just calculates a regular average as a fast approximation. Future versions will offer more advanced aggregation modes (which may be slower to calculate).

◆ GetTypicalSources()

_.Library.Status GetTypicalSources	(		result,
		_.Library.Integer	domainid,
		_.Library.Integer	page,
		_.Library.Integer	pagesize,
		_.Library.Integer	type,
		_.iKnow.Filters.Filter	filter
	)

static

Returns the list of most typical sources in a domain. The type parameter defines on which type of element you want the

list of typical documents to be based. This can be:

$$$SDCONCEPT
$$$SDRELATION
$$$SDENTITY
$$$SDCRC

.

Member Data Documentation

◆ GetAggregateOverlapsRT

GetAggregateOverlapsRT = None

static

Deprecated:

Returned column summary for <method>GetAggregateOverlaps</method>.

◆ GetBreakingSourcesRT

GetBreakingSourcesRT = None

static

Deprecated:

Returned column summary for <method>GetBreakingSources</method>.

◆ GetBySourceRT

GetBySourceRT = None

static

Returned column summary for <method>GetBySource</method>.

◆ GetOverlapDetailsRT

GetOverlapDetailsRT = None

static

Deprecated:

Returned column summary for <method>GetOverlapDetails</method>.

◆ GetOverlapRT

GetOverlapRT = None

static

Deprecated:

Returned column summary for <method>GetOverlap</method>.

◆ GetProfileByDomainRT

GetProfileByDomainRT = None

static

Deprecated:

Returned column summary for <method>GetProfileByDomain</method>.

◆ GetProfileBySourceRT

GetProfileBySourceRT = None

static

Deprecated:

Returned column summary for <method>GetProfileBySource</method>.

◆ GetSourcesByCorrelationRT

GetSourcesByCorrelationRT = None

static

Deprecated:

Returned column summary for <method>GetAggregateOverlaps</method>.

◆ GetTypicalSourcesRT

GetTypicalSourcesRT = None

static

Deprecated:

Returned column summary for <method>GetTypicalSources</method>.

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ BuildOverlap()

◆ FindBreakingSources()

◆ FindMostTypicalSources()

◆ GetAggregateOverlaps()

◆ GetBreakingSources()

◆ GetBySource()

◆ GetCountBySource()

◆ GetDomainValue()

◆ GetOverlap()

◆ GetOverlapDetails()

◆ GetProfileByDomain()

◆ GetProfileBySource()

◆ GetProfileCountByDomain()

◆ GetProfileCountBySource()

◆ GetSourceValue()

◆ GetSourcesByCorrelation()

◆ GetTop()

◆ GetTypicalSources()

Member Data Documentation

◆ GetAggregateOverlapsRT

◆ GetBreakingSourcesRT

◆ GetBySourceRT

◆ GetOverlapDetailsRT

◆ GetOverlapRT

◆ GetProfileByDomainRT

◆ GetProfileBySourceRT

◆ GetSourcesByCorrelationRT

◆ GetTypicalSourcesRT