SentenceWSAPI Class Reference

Inheritance diagram for SentenceWSAPI:

Collaboration diagram for SentenceWSAPI:

Static Public Member Functions
_.XML.DataSet	GetAttributes (_.Library.Integer pDomainId, _.Library.Integer pSentId, _.Library.Integer vSrcId, _.Library.Boolean pIncludePathAttributes)
_.XML.DataSet	GetByCrcIds (_.Library.Integer domainid, _.Library.ListOfDataTypes crcidlist, _.Library.String filter, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer setop)
_.XML.DataSet	GetByCrcMask (_.Library.Integer domainid, _.Library.String head, _.Library.String relation, _.Library.String tail, _.Library.String filter, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer setop, _.Library.Boolean pActualFormOnly)
_.XML.DataSet	GetByCrcs (_.Library.Integer domainid, _.Library.ListOfDataTypes crclist, _.Library.String filter, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer setop)
_.XML.DataSet	GetByEntities (_.Library.Integer domainid, _.Library.ListOfDataTypes entitylist, _.Library.String filter, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer setop, _.Library.Boolean pActualFormOnly)
_.XML.DataSet	GetByEntityIds (_.Library.Integer domainid, _.Library.ListOfDataTypes entityidlist, _.Library.String filter, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer setop, _.Library.Boolean pActualFormOnly)
_.XML.DataSet	GetByPathIds (_.Library.Integer domainid, _.Library.ListOfDataTypes pathidlist, _.Library.ListOfDataTypes sourceidlist, _.Library.Integer page, _.Library.Integer pagesize)
_.XML.DataSet	GetBySource (_.Library.Integer domainid, _.Library.Integer sourceid, _.Library.Integer page, _.Library.Integer pagesize)
	Returns the sentences for the given source. More...
_.Library.Integer	GetCountByCrcIds (_.Library.Integer domainid, _.Library.ListOfDataTypes crcidlist, _.Library.String filter, _.Library.Integer setop)
_.Library.Integer	GetCountByCrcMask (_.Library.Integer domainid, _.Library.String head, _.Library.String relation, _.Library.String tail, _.Library.String filter, _.Library.Integer setop, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByCrcs (_.Library.Integer domainid, _.Library.ListOfDataTypes crclist, _.Library.String filter, _.Library.Integer setop)
_.Library.Integer	GetCountByDomain (_.Library.Integer domainid, _.Library.String filter)
_.Library.Integer	GetCountByEntities (_.Library.Integer domainid, _.Library.ListOfDataTypes entitylist, _.Library.String filter, _.Library.Integer setop, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByEntityIds (_.Library.Integer domainid, _.Library.ListOfDataTypes entityidlist, _.Library.String filter, _.Library.Integer setop, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByPathIds (_.Library.Integer domainid, _.Library.ListOfDataTypes pathidlist, _.Library.ListOfDataTypes sourceidlist)
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.ListOfDataTypes sourceidlist)
_.Library.String	GetLanguage (_.Library.Integer domainid, _.Library.Integer sentenceid, _.Library.Integer vSrcId)
_.XML.DataSet	GetNewBySource (_.Library.Integer domainid, _.Library.Integer sourceid, _.Library.Integer length, _.Library.String filter, _.Library.String algorithm, _.Library.ListOfDataTypes algorithmParams, _.Library.Integer newEntitiesWindow, _.Library.ListOfDataTypes skipListIds)
_.Library.String	GetPartLiteral (_.Library.Integer domainId, _.Library.Integer sentenceId, _.Library.Integer position, _.Library.Integer vSrcId)
	Returns the literal of the entity or nonrelevant at the specified position.
_.XML.DataSet	GetParts (_.Library.Integer domainid, _.Library.Integer sentenceid, _.Library.Boolean includeCRCMarkers, _.Library.Boolean includePathMarkers, _.Library.Integer vSrcId)
_.Library.Integer	GetPosition (_.Library.Integer domainId, _.Library.Integer sentenceId, _.Library.Integer vSrcId)
	Returns the position within the source this sentence occurs at (1-based).
_.Library.Integer	GetSourceId (_.Library.Integer domainId, _.Library.Integer sentenceId)
	Returns the source ID in which the supplied sentence ID occurs.
_.Library.String	GetValue (_.Library.Integer domainid, _.Library.Integer sentenceid, _.Library.Integer vSrcId)

Static Public Attributes
	NAMESPACE = None

Detailed Description

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Queries.SentenceAPI</class>, exposed as WebMethod methods.

See the classdocs for <class>iKnow.Queries.SentenceAPI</class> for more information.

Member Function Documentation

GetAttributes()

_.XML.DataSet GetAttributes ( _.Library.Integer  pDomainId, _.Library.Integer  pSentId, _.Library.Integer  vSrcId, _.Library.Boolean  pIncludePathAttributes  )

static

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 <method>GetAttributes</method> in <class>iKnow.Queries.PathAPI</class> and <method>GetOccurrenceAttributes</method> in <class>iKnow.Queries.EntityAPI</class>.

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

GetByCrcIds()

_.XML.DataSet GetByCrcIds ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  crcidlist, _.Library.String  filter, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  setop  )

static

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 <method>GetByEntities</method> for a description of the parameters.

GetByCrcMask()

_.XML.DataSet GetByCrcMask ( _.Library.Integer  domainid, _.Library.String  head, _.Library.String  relation, _.Library.String  tail, _.Library.String  filter, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  setop, _.Library.Boolean  pActualFormOnly  )

static

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 <method>GetByEntities</method> for a description of the parameters.

GetByCrcs()

_.XML.DataSet GetByCrcs ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  crclist, _.Library.String  filter, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  setop  )

static

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 <method>GetByEntities</method> for a description of the parameters.

GetByEntities()

_.XML.DataSet GetByEntities ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  entitylist, _.Library.String  filter, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  setop, _.Library.Boolean  pActualFormOnly  )

static

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.

GetByEntityIds()

_.XML.DataSet GetByEntityIds ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  entityidlist, _.Library.String  filter, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  setop, _.Library.Boolean  pActualFormOnly  )

static

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 <method>GetByEntities</method> for a description of the parameters.

GetByPathIds()

_.XML.DataSet GetByPathIds ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  pathidlist, _.Library.ListOfDataTypes  sourceidlist, _.Library.Integer  page, _.Library.Integer  pagesize  )

static

Retrieves all sentences containing the given path IDs.

See also <method>GetByEntities</method> for a description of the parameters.

GetBySource()

_.XML.DataSet GetBySource ( _.Library.Integer  domainid, _.Library.Integer  sourceid, _.Library.Integer  page, _.Library.Integer  pagesize  )

static

Returns the sentences for the given source.

A negative source ID is interpreted as a Virtual Source.

GetCountByCrcIds()

_.Library.Integer GetCountByCrcIds ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  crcidlist, _.Library.String  filter, _.Library.Integer  setop  )

static

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 <method>GetByEntities</method> for a description of the parameters.

GetCountByCrcMask()

_.Library.Integer GetCountByCrcMask ( _.Library.Integer  domainid, _.Library.String  head, _.Library.String  relation, _.Library.String  tail, _.Library.String  filter, _.Library.Integer  setop, _.Library.Boolean  pActualFormOnly  )

static

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 <method>GetByEntities</method> for a description of the parameters.

GetCountByCrcs()

_.Library.Integer GetCountByCrcs ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  crclist, _.Library.String  filter, _.Library.Integer  setop  )

static

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 <method>GetByEntities</method> for a description of the parameters.

GetCountByDomain()

_.Library.Integer GetCountByDomain ( _.Library.Integer  domainid, _.Library.String  filter  )

static

Returns the total number of sentences for a given domain, optionally filtered to those sources

satisfying a <class>iKnow.Filters.Filter</class> object passed in through filter.

GetCountByEntities()

_.Library.Integer GetCountByEntities ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  entitylist, _.Library.String  filter, _.Library.Integer  setop, _.Library.Boolean  pActualFormOnly  )

static

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 <method>GetByEntities</method> for a description of the parameters.

GetCountByEntityIds()

_.Library.Integer GetCountByEntityIds ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  entityidlist, _.Library.String  filter, _.Library.Integer  setop, _.Library.Boolean  pActualFormOnly  )

static

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 <method>GetByEntities</method> 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.

GetCountByPathIds()

_.Library.Integer GetCountByPathIds ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  pathidlist, _.Library.ListOfDataTypes  sourceidlist  )

static

Retrieves the number of sentences containing the given path IDs.

See also <method>GetByEntities</method> for a description of the parameters.

GetCountBySource()

_.Library.Integer GetCountBySource ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  sourceidlist  )

static

Returns the total number of sentences for the given sources. Negative Source IDs are

interpreted as referring to Virtual Sources.

GetLanguage()

_.Library.String GetLanguage ( _.Library.Integer  domainid, _.Library.Integer  sentenceid, _.Library.Integer  vSrcId  )

static

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.

GetNewBySource()

_.XML.DataSet GetNewBySource ( _.Library.Integer  domainid, _.Library.Integer  sourceid, _.Library.Integer  length, _.Library.String  filter, _.Library.String  algorithm, _.Library.ListOfDataTypes  algorithmParams, _.Library.Integer  newEntitiesWindow, _.Library.ListOfDataTypes  skipListIds  )

static

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 <class>iKnow.Queries.EntityAPI</class>, 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 <class>iKnow.Queries.EntityAPI</class> for more details on the parameters and available algorithms.

GetParts()

_.XML.DataSet GetParts ( _.Library.Integer  domainid, _.Library.Integer  sentenceid, _.Library.Boolean  includeCRCMarkers, _.Library.Boolean  includePathMarkers, _.Library.Integer  vSrcId  )

static

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 <method>GetValue</method>) and/or highlight specific elements of interest.

Output structure:

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

when includeCRCMarkers = 1, adds

result(pos, [CRCHEAD | CRCRELATION | CRCTAIL]) = $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.

GetValue()

_.Library.String GetValue ( _.Library.Integer  domainid, _.Library.Integer  sentenceid, _.Library.Integer  vSrcId  )

static

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.

Member Data Documentation

NAMESPACE

NAMESPACE = None

static

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Queries.SentenceAPI</class>, exposed as WebMethod methods.

See the classdocs for <class>iKnow.Queries.SentenceAPI</class> for more information.