PathAPI Class Reference

Inheritance diagram for PathAPI:

Collaboration diagram for PathAPI:

Static Public Member Functions
_.Library.Status	GetAttributes (pResult, _.Library.Integer pDomainId, _.Library.Integer pPathId, _.Library.Integer vSrcId)
_.Library.Status	GetByEntities (result, _.Library.Integer domainid, _.Library.List entitylist, _.Library.Integer page, _.Library.Integer pagesize, _.iKnow.Filters.Filter filter, _.Library.Integer setop, _.Library.Boolean pActualFormOnly)
_.Library.Status	GetByEntityIds (result, _.Library.Integer domainid, _.Library.List entityidlist, _.Library.Integer page, _.Library.Integer pagesize, _.iKnow.Filters.Filter filter, _.Library.Integer setop, _.Library.Boolean pActualFormOnly)
_.Library.Status	GetBySource (result, _.Library.Integer domainid, _.Library.List sourceidlist, _.Library.Integer page, _.Library.Integer pagesize)
_.Library.Integer	GetCountByDomain (_.Library.Integer domainid, _.iKnow.Filters.Filter filter, _.Library.Status sc)
_.Library.Integer	GetCountByEntities (_.Library.Integer domainid, _.Library.List entitylist, _.iKnow.Filters.Filter filter, _.Library.Integer setop, _.Library.Status sc, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByEntityIds (_.Library.Integer domainid, _.Library.List entityidlist, _.iKnow.Filters.Filter filter, _.Library.Integer setop, _.Library.Status sc, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.List sourceidlist, _.Library.Status sc)
_.Library.Status	GetEntities (result, _.Library.Integer domainId, _.Library.Integer pathId, _.Library.Integer vSrcId)
_.Library.Integer	GetId (_.Library.Integer domainid, _.Library.List entityList, _.Library.Integer vSrcId, _.Library.Status sc)
_.Library.Integer	GetSentenceId (_.Library.Integer domainId, _.Library.Integer pathId, _.Library.Status sc, _.Library.Integer vSrcId)
	Returns the sentence ID in which the supplied path ID occurs.
_.Library.Integer	GetSourceId (_.Library.Integer domainId, _.Library.Integer pathId, _.Library.Status sc)
	Returns the source ID in which the supplied path ID occurs.
_.Library.List	GetValue (_.Library.Integer domainid, _.Library.Integer pathid, _.Library.Integer vSrcId, _.Library.Status pSC, _.Library.Boolean pUseStems)

Static Public Attributes
	GetAttributesRT = None

Detailed Description

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

This is the main Query class to retrieve Paths as identified by the engine. Paths are sequences of concepts and relations that form a meaningful sub-section of a sentence.

Member Function Documentation

GetAttributes()

_.Library.Status GetAttributes (   pResult, _.Library.Integer  pDomainId, _.Library.Integer  pPathId, _.Library.Integer  vSrcId  )

static

Returns all attributes for a given path. Any named attribute properties are also

included through sub-nodes (not available through SQL or SOAP):

pResult(rowNumber, propertyName) = propertyValue

Please note this query only returns path-level attributes and not those attributes applying to individual entities or words within entities. To retrieve these, use <method>GetOccurrenceAttributes</method> in <class>iKnow.Queries.EntityAPI</class>.

GetByEntities()

_.Library.Status GetByEntities (   result, _.Library.Integer  domainid, _.Library.List  entitylist, _.Library.Integer  page, _.Library.Integer  pagesize, _.iKnow.Filters.Filter  filter, _.Library.Integer  setop, _.Library.Boolean  pActualFormOnly  )

static

This method will return all Paths containing any (if setop = $$$UNION) or all

(if setop = $$$INTERSECT) of the entities in the supplied entitylist.

The scope of this query can be limited through supplying a <class>iKnow.Filters.Filter</class> object for the filter parameter to restrict the result to those Paths occurring in any source satisfying the filter criteria.

Results are sorted by decreasing path ID.

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

GetByEntityIds()

_.Library.Status GetByEntityIds (   result, _.Library.Integer  domainid, _.Library.List  entityidlist, _.Library.Integer  page, _.Library.Integer  pagesize, _.iKnow.Filters.Filter  filter, _.Library.Integer  setop, _.Library.Boolean  pActualFormOnly  )

static

Retrieves paths based on entity IDs.

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

GetBySource()

_.Library.Status GetBySource (   result, _.Library.Integer  domainid, _.Library.List  sourceidlist, _.Library.Integer  page, _.Library.Integer  pagesize  )

static

Retrieves the paths appearing in any of the sources supplied through sourceidlist.

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

GetCountByDomain()

_.Library.Integer GetCountByDomain ( _.Library.Integer  domainid, _.iKnow.Filters.Filter  filter, _.Library.Status  sc  )

static

Returns the number of paths in a domain, optionally restricted to those appearing in a source

satisfying the <class>iKnow.Filters.Filter</class> object supplied through filter.

GetCountByEntities()

_.Library.Integer GetCountByEntities ( _.Library.Integer  domainid, _.Library.List  entitylist, _.iKnow.Filters.Filter  filter, _.Library.Integer  setop, _.Library.Status  sc, _.Library.Boolean  pActualFormOnly  )

static

Retrieves the number of paths containing the specified entities.

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

GetCountByEntityIds()

_.Library.Integer GetCountByEntityIds ( _.Library.Integer  domainid, _.Library.List  entityidlist, _.iKnow.Filters.Filter  filter, _.Library.Integer  setop, _.Library.Status  sc, _.Library.Boolean  pActualFormOnly  )

static

Retrieves the number of paths containing the specified entity IDs.

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

GetCountBySource()

_.Library.Integer GetCountBySource ( _.Library.Integer  domainid, _.Library.List  sourceidlist, _.Library.Status  sc  )

static

Returns the total number of paths in the sources specified through sourceidlist.

Use negative source IDs to refer to virtual sources.

GetEntities()

_.Library.Status GetEntities (   result, _.Library.Integer  domainId, _.Library.Integer  pathId, _.Library.Integer  vSrcId  )

static

Returns a detailed overview of the entities pathId consists of, including their

unique and occurrence IDs, positions, roles and literal value.

The last two columns will only contain data if stemming is enabled for this domain through the $$$IKPSTEMMING domain parameter.

GetId()

_.Library.Integer GetId ( _.Library.Integer  domainid, _.Library.List  entityList, _.Library.Integer  vSrcId, _.Library.Status  sc  )

static

This method will try to find a path corresponding to the supplied list of entities in the

specified order. If no path is found, "" is returned.

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

GetValue()

_.Library.List GetValue ( _.Library.Integer  domainid, _.Library.Integer  pathid, _.Library.Integer  vSrcId, _.Library.Status  pSC, _.Library.Boolean  pUseStems  )

static

Returns the sequence of entity values corresponding to the specified path as a

<class>List</class>.

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

If stemming is enabled for this domain through the $$$IKPSTEMMING domain parameter, you can use pUseStems=1 to get the stems rather than the entities for this path.

Member Data Documentation

GetAttributesRT

GetAttributesRT = None

static

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

This is the main Query class to retrieve Paths as identified by the engine. Paths are sequences of concepts and relations that form a meaningful sub-section of a sentence.