Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
9		27

Methods
%%OIDGet	%AddToSaveSet	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	GetByFilter	GetBySource	GetCountByDomain
GetCountBySource	GetFrequency	GetId	GetLiteral
GetNewBySource	GetOccurrenceCountBySource	GetRelated	GetRelatedById
GetRelatedCount	GetRelatedCountById	GetSimilar	GetSimilarCounts
GetSpread	GetTop	GetValue

• parameter GetByFilterRT = "entUniId:%Integer,entity:%String,frequency:%Integer,spread:%Integer";

Returned column summary for GetByFilter.

• parameter GetBySourceRT = "entUniId:%Integer,entity:%String,frequency:%Integer,spread:%Integer";

Returned column summary for GetBySource.

• parameter GetNewBySourceRT = "entUniId:%Integer,entity:%String,freqInNew:%Integer,freqInOld:%Integer,relFreqInNew:%Numeric,relFreqInOld:%Numeric";

Returned column summary for GetNewBySource.

• parameter GetRelatedByIdRT = "entUniId:%Integer,entity:%String,frequency:%Integer,spread:%Integer";

Returned column summary for GetRelatedById.

• parameter GetRelatedRT = "entUniId:%Integer,entity:%String,frequency:%Integer,spread:%Integer";

Returned column summary for GetRelated.

• parameter GetSimilarCountsRT = "distinctEntities:%Integer,totalFrequency:%Integer,totalSpread:%Integer";

Returned column summary for GetSimilarCounts.

• parameter GetSimilarRT = "entUniId:%Integer,entity:%String,frequency:%Integer,spread:%Integer";

Returned column summary for GetSimilar.

• parameter GetTopRT = "entUniId:%Integer,entity:%String,frequency:%Integer,spread:%Integer";

Returned column summary for GetTop.

• classmethod GetByFilter(ByRef result, domainid As %Integer, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY, enttype As %Integer = $$$ENTTYPECONCEPT, blackListIds As %List = "") as %Status

Returns all entities appearing in any source satisfying the supplied filter objects criteria, with their frequencies and spread recalculated to comply with the filter depending on the value of filtermode, but the result is NOT re-sorted, regardless of the value for filtermode (use GetTop if you want sorted results).

Depending on the value of enttype parameter, this method will only return concepts ($$$ENTTYPECONCEPT, default), relations ($$$ENTTYPERELATIONS) or both ($$$ENTTYPEANY).

Through the blackListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

• classmethod GetBySource(ByRef result, domainid As %Integer, sourceidlist As %List, page As %Integer = 1, pagesize As %Integer = 10, enttype As %Integer = $$$ENTTYPEANY, blackListIds As %List = "") as %Status

Returns the unique entities appearing in the sources specified.

To get the unique entities of a virtual source, only a single virtual source can be supplied using its negative ID value.

• classmethod GetCountByDomain(domainid As %Integer, filter As %iKnow.Filters.Filter = "", Output sc As %Status = $$$OK, blackListIds As %List = "", includeZeroFrequency As %Boolean = 0) as %Integer

Returns the total number of distinct entities for this domain, optionally filtered to a set of sources satisfying the %iKnow.Filters.Filter object supplied through filter. Depending on the value of includeZeroFrequency, entities not appearing in any source (but registered in the domain for other purposes) are included or excluded from the result.

Through the blackListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

• classmethod GetCountBySource(domainid As %Integer, sourceidlist As %List, setop As %Integer = $$$UNION, Output sc As %Status = $$$OK, blackListIds As %List = "", enttype As %Integer = $$$ENTTYPEANY) as %Integer

Returns the total number of distinct entities for a given list of sources. The count returned either represents the entities appearing in either (with setop $$$UNION) or all (with setop $$$INTERSECT) of the supplied sources. Using enttype, the returned count is filtered to just entities ($$$ENTTYPECONCEPT), relations ($$$ENTTYPERELATION). The default is unfiltered ($$$ENTTYPEANY).

To get the unique entities of a virtual source, only a single virtual source can be supplied using its negative ID value (otherwise, -1 is returned).

Through the blackListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

• classmethod GetFrequency(domainId As %Integer, entUniId As %Integer, enttype As %Integer = $$$ENTTYPEANY, vSrcId As %Integer = 0) as %Integer

Returns the frequency of the entity corresponding to the supplied entUniId, occurring in a concept role (if enttype = $$$ENTTYPECONCEPT), a relationship role (if enttype = $$$ENTTYPERELATION) or both (enttype = $$$ENTTYPEANY).

When specifying a Virtual Source ID, the frequency within the virtual source will be returned.

• classmethod GetId(domainid As %Integer, entityvalue As %String, vSrcId As %Integer = 0) as %Integer

Returns the entity ID corresponding to the specified entity value, if any.

When specifying a Virtual Source ID, it will treat the entity as a virtual one, in the context of that vSrcId.

• classmethod GetLiteral(domainId As %Integer, entOccId As %Integer) as %String

Returns the literal value for a particular Entity Occcurrence ID, as it occurred in the original text.

• classmethod GetNewBySource(ByRef result, domainid As %Integer, sourceidlist As %List, page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "", entType As %Integer = $$$ENTTYPECONCEPT, algorithm As %String = $$$NEWENTSIMPLE, algorithmParams As %List = "", blackListIds As %List = "") as %Status

Retrieves the list of significant entities in a list of sources supplied through sourceidlist, as compared to the other sources in the domain (optionally filtered through a %iKnow.Filters.Filter object specified through filter).

The following algorithm values are currently available:

• $$$NEWENTSIMPLE - takes no parameters

To get the significant entities of a virtual source compared to the non-virtual ones in the domain, only a single virtual source can be supplied using its negative ID value.

Through the enttype parameter, the method can be instructed to return either concepts ($$$ENTTYPECONCEPT) or relations ($$$ENTTYPERELATIONS).

Through the blackListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

• classmethod GetOccurrenceCountBySource(domainid As %Integer, sourceidlist As %List, Output sc As %Status = $$$OK) as %Integer

Returns the total number of entity occurrences for the given list of sources. Use negative source IDs to refer to virtual sources.

• classmethod GetRelated(ByRef result, domainid As %Integer, entitylist As %List, page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, aggregationtype As %Integer = $$$AGGSUM, setop As %Integer = $$$UNION, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, blackListIds As %List = "") as %Status

This method will return all entities occurring in a direct relationship with at least on (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the entities in the supplied entitylist, anywhere within the supplied domain.

The scope of this query can be limited through supplying a %iKnow.Filters.Filter object for the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

Through the positionstomatch parameter, the user can specify whether the entities returned should be occuring on the Master side ($$$USEPOSM), the Slave side ($$$USEPOSS) or either ($$$USEPOSMS, default) side of the relationship.

The aggregationtype parameter lets you choose how to aggregate the frequency and spread of results related to multiple entries in the input entitylist.

Through the blackListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

• classmethod GetRelatedById(ByRef result, domainid As %Integer, entityidlist As %List, page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, aggregationtype As %Integer = $$$AGGSUM, setop As %Integer = $$$UNION, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, blackListIds As %List = "") as %Status

Returns the entities related to a supllied list of entity IDs.

See GetRelated for a description of the parameters.

• classmethod GetRelatedCount(domainid As %Integer, entitylist As %List, filter As %iKnow.Filters.Filter = "", positionstomatch As %Integer = $$$USEPOSMS, setop As %Integer = $$$UNION, Output sc As %Status = $$$OK) as %Integer

Returns the number of related entities for a given list of entities.

See GetRelated for a description of the parameters.

• classmethod GetRelatedCountById(domainid As %Integer, entityidlist As %List, filter As %iKnow.Filters.Filter = "", positionstomatch As %Integer = $$$USEPOSMS, setop As %Integer = $$$UNION, Output sc As %Status = $$$OK) as %Integer

Returns the number of related entities for a given list of entity ids.

See GetRelated for a description of the parameters.

• classmethod GetSimilar(ByRef result, domainid As %Integer, part As %String, page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY, mode As %Integer = $$$USEPARTS, blackListIds As %List = "") as %Status

This method will return all entities in the specified domain that are "similar" to the supplied part string. Similarity is defined using the mode parameter. The default setting ($$$USEPARTS), will retrieve all clusters containing at least one word starting with the supplied string, whereas $$$USENGRAMS will search for any character sequence within the whole entity.

The scope of this query can be limited through supplying a %iKnow.Filters.Filter object for the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

Through the blackListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

• classmethod GetSimilarCounts(domainid As %Integer, part As %String, filter As %iKnow.Filters.Filter = "", mode As %Integer = $$$USEPARTS, blackListIds As %List = "", Output sc As %Status = $$$OK) as %List

This method returns aggregated details on the entities similar to a supplied text fragment part. The returned list contains the total number of distinct entities similar to part appearing in sources satisfying the supplied filter (if defined), their total aggregated frequency (with respect to filter, if defined) and the total number of sources containing at least one of these "similar" entities (again, respecting filter, if defined).

See also GetSimilar for a description of the other parameters.

• classmethod GetSpread(domainId As %Integer, entUniId As %Integer, enttype As %Integer = $$$ENTTYPEANY) as %Integer

Returns the spread of the entity corresponding to the supplied entUniId, occurring in a concept role (if enttype = $$$ENTTYPECONCEPT), a relationship role (if enttype = $$$ENTTYPERELATION) or both (enttype = $$$ENTTYPEANY).

• classmethod GetTop(ByRef result, domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, enttype As %Integer = $$$ENTTYPECONCEPT, vSrcId As %Integer = 0, blackListIds As %List = "") as %Status

This method returns a list of the most frequently occurring entities in the specified domain.

The scope of this query can be limited through supplying a %iKnow.Filters.Filter object for the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

Through the enttype parameter, the method can be instructed to return either concepts ($$$ENTTYPECONCEPT) or relations ($$$ENTTYPERELATIONS). When looking for top concepts, those shorter than 3 characters are skipped.

Returned values are either sorted by descending frequency (with sorttype $$$SORTBYFREQUENCY), spread (with sorttype $$$SORTBYSPREAD) or the domain default (with sorttype $$$SORTBYDOMAINDEFAULT).

If a Virtual Source ID is provided, only the entities in that virtual source will be considered, filters are ignored and the sort type will always be $$$SORTBYFREQUENCY.

Through the blackListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

• classmethod GetValue(domainid As %Integer, entityid As %Integer, vSrcId As %Integer = 0) as %String

Returns the entity string value corresponding to the specified entity ID, if any.