Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %iKnow.Semantics.DominanceWSAPI
Private  Storage   

%iKnow.Semantics.DominanceWSAPI


class %iKnow.Semantics.DominanceWSAPI extends
%iKnow.Queries.AbstractWSAPI

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Semantics.DominanceAPI, exposed as WebMethod methods.

See the classdocs for %iKnow.Semantics.DominanceAPI for more information.

This class was generated by %iKnow.Semantics.DominanceAPI.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 16


Summary


Properties
AddressingIn AddressingOut Attachments Base64LineBreaks
BodyId BodyXmlId ContentId ContentLocation
FaultAddressing FaultHeaders HeadersIn HeadersOut
ImportHandler IsMTOM Location MTOMRequired
MsgClass OutputTypeAttribute Password RMSession
ReferencesInline RequestMessageStart ResponseAttachments ResponseContentId
ResponseContentLocation SAXFlags SecurityContextToken SecurityIn
SecurityNamespace SecurityOut SessionCookie SoapFault
SoapVersion Timeout Transport Username
WriteSOAPBodyMethod

Methods
%AddEnvelopeNamespace %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OnCreateRMSession
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject ConvertParameter Decrypt
Encrypt EscapeHTML EscapeURL FileWSDL
GetAggregateOverlaps GetBodyId GetBreakingSources GetBySource
GetCountBySource GetCountBySourceInternal GetDomainValue GetOverlap
GetOverlapDetails GetProfileByDomain GetProfileBySource GetProfileCountByDomain
GetProfileCountBySource GetSourceValue GetSourcesByCorrelation GetTop
GetTypicalSources HyperEventCall HyperEventHead Include
Initialize InsertHiddenField InsertHiddenFields IsPrivate
Link MakeFault MakeFault12 MakeSecurityFault
MakeStatusFault NormalizeName OnCancelSecureConversation OnPageError
OnPostHTTP OnPostHyperEvent OnPostWebMethod OnPreHyperEvent
OnPreWebMethod OnRequestMessage OnSOAPRequest OnStartSecureConversation
Page Process ProcessBinary ProcessBody
ProcessBodyNode QuoteJS Reset ReturnFault
ReturnOneWay RewriteURL ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
WSAddSignatureConfirmation


Parameters


• parameter NAMESPACE = "http://www.intersystems.com/iKnow/Semantics/DominanceWSAPI";
NAMESPACE - Should be an unique URI Override this parameter in the subclass with the unique namespace URI of your organization. Override this parameter in the subclass.
• parameter SERVICENAME = "iKnow.Semantics.DominanceWSAPI";
SERVICENAME - Should be the name of the service for which this is a proxy. Override this parameter in the subclass.
• parameter USECLASSNAMESPACES = 1;
When USECLASSNAMESPACES = 1, then the WSDL of the Web service reflects the namespaces defined for the referenced classes by the NAMESPACE parameters of those classes. The default, for compatibility with previous versions, is that the NAMESPACE parameters of the referenced classes are ignored when creating the WSDL. If USECLASSNAMESPACES has no value, then the default value from ^ISCSOAP("USECLASSNAMESPACES") is used.

Methods


• classmethod GetAggregateOverlaps(domainid As %Integer, type As %Integer, set1 As %String(MAXLEN=32767)="", set2 As %String(MAXLEN=32767)="", page As %Integer = 1, pagesize As %Integer = 10) as %XML.DataSet [ WebMethod ]

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.

• classmethod GetBreakingSources(domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, filter As %String(MAXLEN=32767)="") as %XML.DataSet [ WebMethod ]

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(domainid As %Integer, srcid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, cutoff As %Integer = $$$SDALL) as %XML.DataSet [ WebMethod ]

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) as %Library.Integer [ WebMethod ]

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) as %Library.Integer [ WebMethod ]
• classmethod GetDomainValue(domainid As %Integer, id As %Integer, type As %Integer = $$$SDCONCEPT) as %Library.Numeric [ WebMethod ]

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.

• classmethod GetOverlap(domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, filter As %String(MAXLEN=32767)="") as %XML.DataSet [ WebMethod ]

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
.

• classmethod GetOverlapDetails(domainid As %Integer, id As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, filter As %String(MAXLEN=32767)="") as %XML.DataSet [ WebMethod ]

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
.

• classmethod GetProfileByDomain(domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT) as %XML.DataSet [ WebMethod ]

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.

• classmethod GetProfileBySource(domainid As %Integer, srcid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, cutoff As %Integer = $$$SDALL) as %XML.DataSet [ WebMethod ]

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.

• classmethod GetProfileCountByDomain(domainid As %Integer, type As %Integer = $$$SDCONCEPT) as %Library.Integer [ WebMethod ]

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.

• classmethod GetProfileCountBySource(domainid As %Integer, srcid As %Integer, type As %Integer = $$$SDCONCEPT, cutoff As %Integer = $$$SDALL) as %Library.Integer [ WebMethod ]

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) as %Library.Numeric [ WebMethod ]

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.

• classmethod GetSourcesByCorrelation(domainid As %Integer, entids As %ListOfDataTypes = "", page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="") as %XML.DataSet [ WebMethod ]

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(pDomainId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pAggregation As %String = "AVG", pEntRole As %Integer = $$$SDCONCEPT, pBlacklists As %ListOfDataTypes = "") as %XML.DataSet [ WebMethod ]

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

• classmethod GetTypicalSources(domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, type As %Integer = $$$SDCONCEPT, filter As %String(MAXLEN=32767)="") as %XML.DataSet [ WebMethod ]

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
.