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

class %iKnow.Queries.SentenceQAPI extends %iKnow.Queries.AbstractQAPI

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Queries.SentenceAPI, exposed as SqlProc methods.

See the classdocs for %iKnow.Queries.SentenceAPI for more information.

This class was generated by %iKnow.Queries.SentenceAPI.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
43 10


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
GetCountByCrcIds GetCountByCrcMask GetCountByCrcs GetCountByDomain
GetCountByEntities GetCountByEntityIds GetCountByPathIds GetCountBySource
GetLanguage GetPartLiteral GetPosition GetSourceId
GetValue


Methods

• classmethod GetCountByCrcIds(domainid As %Integer, crcidlist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Retrieves the number of sentences containing the given CRC ids, optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer. In this case, crcidlist is expected to contain virtual Entity IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByCrcMask(domainid As %Integer, master As %String(MAXLEN=32767)=$$$WILDCARD, relation As %String(MAXLEN=32767)=$$$WILDCARD, slave As %String(MAXLEN=32767)=$$$WILDCARD, filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

Retrieves the number of sentences containing a CRC satisfying the given CRC Mask, optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByCrcs(domainid As %Integer, crclist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Retrieves the number of sentences containing the given CRCs, optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByDomain(domainid As %Integer, filter As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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 %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

Retrieves the number of sentences containing the given entities, optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

Retrieves the nubmer of sentences containing the given entity ids. For querying Virtual Sources, set filter to a single, negative integer. In this case, entityidlist is expected to contain virtual Entity IDs.

See also GetByEntities for a description of the parameters.

If stemming is enabled for this domain through $$$IKPSTEMMING, sources containing any actual form of the entities in entityidlist will be returned. Use pActualFormOnly=1 to retrieve only those sources containing the actual forms in entityidlist. This argument is ignored if stemming is not enabled.

• classmethod GetCountByPathIds(domainid As %Integer, pathidlist As %String(MAXLEN=32767), sourceidlist As %String(MAXLEN=32767), Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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 %String(MAXLEN=32767), Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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, Output confidence As %Numeric = "", vSrcId As %Integer = 0) as %Library.String [ SQLProc = ]

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 GetPartLiteral(domainId As %Integer, sentenceId As %Integer, position As %Integer, vSrcId As %Integer = 0) as %Library.String [ SQLProc = ]
Returns the literal of the entity or nonrelevant at the specified position.
• classmethod GetPosition(domainId As %Integer, sentenceId As %Integer, vSrcId As %Integer = 0) as %Library.Integer [ SQLProc = ]
Returns the position within the source this sentence occurs at (1-based).
• classmethod GetSourceId(domainId As %Integer, sentenceId As %Integer) as %Library.Integer [ SQLProc = ]
Returns the source ID in which the supplied sentence ID occurs
• classmethod GetValue(domainid As %Integer, sentenceid As %Integer, Output fullSentence As %Boolean = 1, vSrcId As %Integer = 0) as %Library.String [ SQLProc = ]

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.


Queries

• query GetAttributes(pDomainId As %Integer, pSentId As %Integer, vSrcId As %Integer = 0, pIncludePathAttributes As %Boolean = 0)
Selects attTypeId As %Integer, attType As %String(MAXLEN=32767), start As %Integer, span As %Integer, wordPositions As %String(MAXLEN=32767), properties As %String(MAXLEN=32767), level As %Integer

Returns all attributes for a given sentence. By default, only entity-level attributes are returned, with the wordPositions result column referring which words within the affected entities are actually attributed. Using pIncludePathAttributes, also path-level attributes (such as implied negation) can be returned, but these will have no values for the wordPositions column. Also note that the start and span columns for path-level results will refer to positions within those paths and not entity positions within the sentence. See also GetAttributes in %iKnow.Queries.PathAPI and GetOccurrenceAttributes in %iKnow.Queries.EntityAPI.

Any named attribute properties are also included through sub-nodes (not available through SQL or SOAP):

pResult(rowNumber, propertyName) = propertyValue

The returned wordPositions apply to the entities starting from start up to offset and only extend to the last attributed word position (there might be more words within the entity).

• query GetByCrcIds(domainid As %Integer, crcidlist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION)
Selects srcId As %Integer, externalId As %String(MAXLEN=32767), sentId As %Integer, sentenceValue As %String(MAXLEN=32767)

Retrieves all sentences containing the given CRC ids, optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer. In this case, crcidlist is expected to contain virtual Entity IDs.

See also GetByEntities for a description of the parameters.

• query GetByCrcMask(domainid As %Integer, master As %String(MAXLEN=32767)=$$$WILDCARD, relation As %String(MAXLEN=32767)=$$$WILDCARD, slave As %String(MAXLEN=32767)=$$$WILDCARD, filter As %String(MAXLEN=32767)="", page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION, pActualFormOnly As %Boolean = 0)
Selects srcId As %Integer, externalId As %String(MAXLEN=32767), sentId As %Integer, sentenceValue As %String(MAXLEN=32767)

Retrieves all sentences containing a CRC satisfying the given CRC Mask, optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

See also GetByEntities for a description of the parameters.

• query GetByCrcs(domainid As %Integer, crclist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION)
Selects srcId As %Integer, externalId As %String(MAXLEN=32767), sentId As %Integer, sentenceValue As %String(MAXLEN=32767)

Retrieves all sentences containing the given CRCs, optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

See also GetByEntities for a description of the parameters.

• query GetByEntities(domainid As %Integer, entitylist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION, pActualFormOnly As %Boolean = 0)
Selects srcId As %Integer, externalId As %String(MAXLEN=32767), sentId As %Integer, sentenceValue As %String(MAXLEN=32767)

This method will retrieve all sentences containing any (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the entities supplied through entitylist, optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

If stemming is enabled for this domain through $$$IKPSTEMMING, sentences containing any actual form of the entities in entityList will be returned. Use pActualFormOnly=1 to retrieve only those sentences containing the actual forms in entitylist. This argument is ignored if stemming is not enabled.

• query GetByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", page As %Integer = 1, pagesize As %Integer = 10, setop As %Integer = $$$UNION, pActualFormOnly As %Boolean = 0)
Selects srcId As %Integer, externalId As %String(MAXLEN=32767), sentId As %Integer, sentenceValue As %String(MAXLEN=32767)

Retrieves all sentences containing the given entity IDs., optionally limited to all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer. In this case, entityidlist is expected to contain virtual Entity IDs.

See also GetByEntities for a description of the parameters.

• query GetByPathIds(domainid As %Integer, pathidlist As %String(MAXLEN=32767), sourceidlist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10)
Selects srcId As %Integer, externalId As %String(MAXLEN=32767), sentId As %Integer, sentenceValue As %String(MAXLEN=32767)

Retrieves all sentences containing the given path IDs.

See also GetByEntities for a description of the parameters.

• query GetBySource(domainid As %Integer, sourceid As %Integer, page As %Integer = 1, pagesize As %Integer = 10)
Selects sentId As %Integer, sentenceValue As %String(MAXLEN=32767), sentenceIsTruncated As %Boolean
Returns the sentences for the given source. A negative source ID is interpreted as a Virtual Source.
• query GetNewBySource(domainid As %Integer, sourceid As %Integer, length As %Integer = 5, filter As %String(MAXLEN=32767)="", algorithm As %String(MAXLEN=32767)=$$$NEWENTSIMPLE, algorithmParams As %String(MAXLEN=32767)="", newEntitiesWindow As %Integer = 100, blackListIds As %String(MAXLEN=32767)="")
Selects sentId As %Integer, sentenceValue As %String(MAXLEN=32767), score As %Numeric

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

• query GetParts(domainid As %Integer, sentenceid As %Integer, includeCRCMarkers As %Boolean = 0, includePathMarkers As %Boolean = 0, vSrcId As %Integer = 0)
Selects entOccId As %Integer, entUniId As %Integer, literal As %String(MAXLEN=32767), role As %Integer, stemUniId As %Integer

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.



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