Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%iKnow] >  [Semantics] >  [DominanceAPI]
Private  Storage   

class %iKnow.Semantics.DominanceAPI extends %iKnow.Queries.AbstractAPI

Main class for retrieving dominant terms from sources.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
12 25


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
BuildOverlap FindBreakingSources FindMostTypicalSources GetAggregateOverlaps
GetBreakingSources GetBySource GetCountBySource GetCountBySourceInternal
GetDomainValue GetOverlap GetOverlapDetails GetProfileByDomain
GetProfileBySource GetProfileCountByDomain GetProfileCountBySource GetSourceValue
GetSourcesByCorrelation GetTop GetTypicalSources


Parameters

deprecatedparameter GetAggregateOverlapsRT = "id:%Integer,overlapSet1:%Integer,pctSet1:%Numeric,overlapSet2:%Integer,pctSet2:%Numeric,aggPct:%Numeric";

Returned column summary for GetAggregateOverlaps.

deprecatedparameter GetBreakingSourcesRT = "srcid:%Integer,extid:%String,uniqueness:%Numeric";

Returned column summary for GetBreakingSources.

• parameter GetBySourceRT = "id:%Integer,values:%List,type:%Integer,dominance:%Numeric";

Returned column summary for GetBySource.

deprecatedparameter GetOverlapDetailsRT = "srcid:%Integer,dominance:%Numeric,sentences:%List";

Returned column summary for GetOverlapDetails.

deprecatedparameter GetOverlapRT = "id:%Integer,values:%Integer,type:%Integer,overlap:%Integer";

Returned column summary for GetOverlap.

deprecatedparameter GetProfileByDomainRT = "id:%Integer,values:%List,type:%Integer,dominance:%Numeric";

Returned column summary for GetProfileByDomain.

deprecatedparameter GetProfileBySourceRT = "id:%Integer,values:%List,type:%Integer,dominance:%Numeric";

Returned column summary for GetProfileBySource.

deprecatedparameter GetSourcesByCorrelationRT = "srcid:%Integer,extid:%String,correlation:%Numeric";

Returned column summary for GetAggregateOverlaps.

• parameter GetTopRT = "entUniId:%Integer,entity:%String,score:%Numeric";
deprecatedparameter GetTypicalSourcesRT = "srcid:%Integer,extid:%String,coverage:%Numeric";

Returned column summary for GetTypicalSources.


Methods

deprecatedclassmethod BuildOverlap(domainid As %Integer, filter As %iKnow.Filters.Filter = "") as %Status

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:

deprecatedclassmethod FindBreakingSources(domainid As %Integer) as %Status

Uses the overlap information generated by BuildOverlap to calculate breaking sources in a domain.

You can call GetBreakingSources to get the list of most breaking sources.

deprecatedclassmethod FindMostTypicalSources(domainid As %Integer) as %Status

Uses the overlap information generated by BuildOverlap to calculate typical sources in a domain.

You can call GetTypicalSources to get the list of most typical sources.

deprecatedclassmethod GetAggregateOverlaps(ByRef result, domainid As %Integer, type As %Integer, set1 As %iKnow.Filters.Filter, set2 As %iKnow.Filters.Filter, page As %Integer = 1, pagesize As %Integer = 10) as %Status

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.

deprecatedclassmethod GetBreakingSources(ByRef result, domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, filter As %iKnow.Filters.Filter = "") as %Status

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
.

• classmethod GetBySource(ByRef result, domainid As %Integer, srcid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, cutoff As %Integer = $$$SDALL) as %Status

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.

• classmethod GetCountBySource(domainid As %Integer, srcid As %Integer, type As %Integer = $$$SDCONCEPT, cutoff As %Integer = $$$SDALL, ByRef sc As %Status) as %Integer

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.

• classmethod GetCountBySourceInternal(domainid As %Integer, srcid As %Integer, type As %Integer = $$$SDCONCEPT, cutoff As %Integer = $$$SDALL, pUseProfile As %Boolean = 1, ByRef sc As %Status) as %Integer
• classmethod GetDomainValue(domainid As %Integer, id As %Integer, type As %Integer = $$$SDCONCEPT, ByRef sc As %Status) as %Numeric

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.

deprecatedclassmethod GetOverlap(ByRef result, domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, filter As %iKnow.Filters.Filter = "") as %Status

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
.

deprecatedclassmethod GetOverlapDetails(ByRef result, domainid As %Integer, id As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, filter As %iKnow.Filters.Filter = "") as %Status

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
.

deprecatedclassmethod GetProfileByDomain(ByRef result, domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT) as %Status

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.

deprecatedclassmethod GetProfileBySource(ByRef result, domainid As %Integer, srcid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, cutoff As %Integer = $$$SDALL) as %Status

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.

deprecatedclassmethod GetProfileCountByDomain(domainid As %Integer, type As %Integer = $$$SDCONCEPT, ByRef sc As %Status) as %Integer

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.

deprecatedclassmethod GetProfileCountBySource(domainid As %Integer, srcid As %Integer, type As %Integer = $$$SDCONCEPT, cutoff As %Integer = $$$SDALL, ByRef sc As %Status) as %Integer

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.

• classmethod GetSourceValue(domainid As %Integer, srcid As %Integer, id As %Integer, type As %Integer = $$$SDCONCEPT, ByRef sc As %Status) as %Numeric

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.

deprecatedclassmethod GetSourcesByCorrelation(ByRef result, domainid As %Integer, entids As %List = "", page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "") as %Status

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.

• classmethod GetTop(ByRef pResult, pDomainId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %iKnow.Filters.Filter = "", pAggregation As %String = "AVG", pEntRole As %Integer = $$$SDCONCEPT, pBlacklists As %List = "") as %Status

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).

deprecatedclassmethod GetTypicalSources(ByRef result, domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, filter As %iKnow.Filters.Filter = "") as %Status

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
.



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