Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3		22

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

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	ConvertParameter	Decrypt	Encrypt
EscapeHTML	EscapeURL	FileWSDL	GetBodyId
GetByCrcIds	GetByCrcMask	GetByCrcs	GetByEntities
GetByEntityIds	GetByPathIds	GetBySource	GetCountByCrcIds
GetCountByCrcMask	GetCountByCrcs	GetCountByDomain	GetCountByEntities
GetCountByEntityIds	GetCountByPathIds	GetCountBySource	GetLanguage
GetNewBySource	GetPartLiteral	GetParts	GetPosition
GetSourceId	GetValue	HyperEventBody	HyperEventCall
HyperEventFrame	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	SecurityOutGet	SecurityOutSet	ShowError
StartTimer	StopTimer	ThrowError	TimeoutSet
UnescapeHTML	UnescapeURL	WSAddSignatureConfirmation

• parameter NAMESPACE = "http://www.intersystems.com/iKnow/Queries/SentenceWSAPI";

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.Queries.SentenceWSAPI";

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.

• classmethod GetByCrcIds(domainid As %Integer, crcidlist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION) as %XML.DataSet [ WebMethod ]

Retrieves all sentences containing the given CRC ids.

See also GetByEntities for a description of the parameters.

• classmethod GetByCrcMask(domainid As %Integer, master As %String = $$$WILDCARD, relation As %String = $$$WILDCARD, slave As %String = $$$WILDCARD, sourceidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION) as %XML.DataSet [ WebMethod ]

Retrieves all sentences containing a CRC satisfying the given CRC Mask.

See also GetByEntities for a description of the parameters.

• classmethod GetByCrcs(domainid As %Integer, crclist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION) as %XML.DataSet [ WebMethod ]

Retrieves all sentences containing the given CRCs.

See also GetByEntities for a description of the parameters.

• classmethod GetByEntities(domainid As %Integer, entitylist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION) as %XML.DataSet [ WebMethod ]

This method will retrieve all sentences containing any (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the entities supplied through entitylist, within the list of sources supplied through sourceidlist.

• classmethod GetByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION) as %XML.DataSet [ WebMethod ]

Retrieves all sentences containing the given entity IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetByPathIds(domainid As %Integer, pathidlist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10) as %XML.DataSet [ WebMethod ]

Retrieves all sentences containing the given path IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetBySource(domainid As %Integer, sourceid As %Integer, page As %Integer = 1, pagesize As %Integer = 10) as %XML.DataSet [ WebMethod ]

Returns the sentences for the given source. A negative source ID is interpreted as a Virtual Source.

• classmethod GetCountByCrcIds(domainid As %Integer, crcidlist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Retrieves the number of sentences containing the given CRC ids.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByCrcMask(domainid As %Integer, master As %String = $$$WILDCARD, relation As %String = $$$WILDCARD, slave As %String = $$$WILDCARD, sourceidlist As %ListOfDataTypes, setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Retrieves the number of sentences containing a CRC satisfying the given CRC Mask.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByCrcs(domainid As %Integer, crclist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Retrieves the number of sentences containing the given CRCs.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByDomain(domainid As %Integer, filter As %String = "") as %Library.Integer [ WebMethod ]

Returns the total number of sentences for a given domain, optionally filtered to those sources satisfying a %iKnow.Filters.Filter object passed in through filter.

• classmethod GetCountByEntities(domainid As %Integer, entitylist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Retrieves the number of sentences containing the given entities.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes, setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Retrieves the nubmer of sentences containing the given entity ids.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByPathIds(domainid As %Integer, pathidlist As %ListOfDataTypes, sourceidlist As %ListOfDataTypes) as %Library.Integer [ WebMethod ]

Retrieves the number of sentences containing the given path IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetCountBySource(domainid As %Integer, sourceidlist As %ListOfDataTypes) as %Library.Integer [ WebMethod ]

Returns the total number of sentences for the given sources. Negative Source IDs are interpreted as referring to Virtual Sources.

• classmethod GetLanguage(domainid As %Integer, sentenceid As %Integer, vSrcId As %Integer = 0) as %Library.String [ WebMethod ]

Retrieves the language of the given sentence, as derived by the Automatic Language Identification algorithm or, if ALI was disabled, the language specified when indexing this sentence.

The confidence level is returned as well through an output parameter. If the confidence level is 0, this means ALI was not used and the language was defined by the user loading the source.

If a Virtual Source ID is specified, the sentence ID is treated as a virtual one, in the context of the supplied vSrcId.

• classmethod GetNewBySource(domainid As %Integer, sourceid As %Integer, length As %Integer = 5, filter As %String = "", algorithm As %String = $$$NEWENTSIMPLE, algorithmParams As %ListOfDataTypes = "", newEntitiesWindow As %Integer = 100, blackListIds As %ListOfDataTypes = "") as %XML.DataSet [ WebMethod ]

Retrieves the sentences with the most significant concepts compared to the rest of the domain (or optionally a subset thereof as filtered through filter). This list of sentences is based on results of the GetNewBySource query in %iKnow.Queries.EntityAPI, using the supplied algorithm and parameter values. The scores of the first [newEntitiesWindow] concepts are aggregated across sentences to produce the result of this query.

Please refer to the documentation of the GetNewBySource query in %iKnow.Queries.EntityAPI for more details on the parameters and available algorithms.

• classmethod GetPartLiteral(domainId As %Integer, sentenceId As %Integer, position As %Integer) as %Library.String [ WebMethod ]

Returns the literal of the entity or nonrelevant at the specified position.

• classmethod GetParts(domainid As %Integer, sentenceid As %Integer, includeCRCMarkers As %Boolean = 0, includePathMarkers As %Boolean = 0, vSrcId As %Integer = 0) as %XML.DataSet [ WebMethod ]

Returns the elements (concepts, relations and nonrelevants) that make up the sentence, optional including markers for the beginning and end of any CRCs or Paths in the sentence. This information can be used to display the sentence value (see also GetValue) and/or highlight specific elements of interest.

Output structure:

result(pos) = $lb(entOccId, entUniId, entity, role)

when includeCRCMarkers = 1, adds

result(pos, [CRCMASTER | CRCRELATION | CRCSLAVE]) = $lb(crcOccId, crcUniId)

when includePathMarkers = 1, adds

result(pos, [PATHBEGIN | PATHEND]) = $lb(pathId)

Note: the subscript levels for CRC and Path markers are not available in the QAPI and WSAPI versions of this query.

If a Virtual Source ID is specified, the sentence ID is treated as a virtual one, in the context of the supplied vSrcId.

• classmethod GetPosition(domainId As %Integer, sentenceId As %Integer) as %Library.Integer [ WebMethod ]

Returns the position within the source this sentence occurs at (1-based).

• classmethod GetSourceId(domainId As %Integer, sentenceId As %Integer) as %Library.Integer [ WebMethod ]

Returns the source ID in which the supplied sentence ID occurs

• classmethod GetValue(domainid As %Integer, sentenceid As %Integer, vSrcId As %Integer = 0) as %Library.String [ WebMethod ]

This method rebuilds a sentence based on the literals and entities it is composed of.

The string returned is the first part, up to the maximum string length, whereas the output parameter fullSentence is an array containing all the parts in the right order, containing a %Boolean value at the top level indicating whether the returned string is the full sentence (1) or (if 0) the user should have to look into this array to learn the full sentence.

If a Virtual Source ID is specified, the sentence ID is treated as a virtual one, in the context of the supplied vSrcId.